Class Session

constructor

• new Session(options?: SessionOptions): Session

  Parameters

  • Optionaloptions: SessionOptions

  Returns Session

Readonlyio

ReadonlypersistCache

Readonlyruntime

isClosed

• get isClosed(): boolean

  Returns boolean

bind

• bind<S extends Row>(frame: DataFrame<S>): DataFrame<S>

  Bind a frame or plan to this session's runtime (its engine, memory policy and cache).

  Type Parameters

  • S extends Row

  Parameters

  • frame: DataFrame<S>

  Returns DataFrame<S>

• bind<S extends Row>(frame: LazyFrame<S>): LazyFrame<S>

  Bind a frame or plan to this session's runtime (its engine, memory policy and cache).

  Type Parameters

  • S extends Row

  Parameters

  • frame: LazyFrame<S>

  Returns LazyFrame<S>

close

• close(): void

  Drop everything this session cached. Frames already materialized stay usable.

  Returns void

fromArrowIpc

• fromArrowIpc<S extends Row = Row>(
      bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>,
      options?: ArrowIpcReadOptions,
  ): DataFrame<S>

  Type Parameters

  • S extends Row = Row

  Parameters

  • bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>
  • Optionaloptions: ArrowIpcReadOptions

  Returns DataFrame<S>

fromArrowLike

• fromArrowLike<S extends Row = Row>(arrow: ArrowLike): DataFrame<S>

  Type Parameters

  • S extends Row = Row

  Parameters

  • arrow: ArrowLike

  Returns DataFrame<S>

fromColumns

• fromColumns<
      C extends
          Record<
              string,
              | readonly (string | number | boolean | Date | null)[]
              | Float64Array<ArrayBufferLike>
              | Float32Array<ArrayBufferLike>
              | Int32Array<ArrayBufferLike>
              | Uint32Array<ArrayBufferLike>
              | Uint8Array<ArrayBufferLike>
              | { codes: Uint32Array; dictionary: string[] },
          >,
  >(
      cols: C,
      options?: { copy?: boolean },
  ): DataFrame<
      {
          [K in string
          | number
          | symbol]: { [K in string | number | symbol]: ColumnValue<C[K]> }[K]
      },
  >

  Type Parameters

  • C extends Record<
        string,
        | readonly (string | number | boolean | Date | null)[]
        | Float64Array<ArrayBufferLike>
        | Float32Array<ArrayBufferLike>
        | Int32Array<ArrayBufferLike>
        | Uint32Array<ArrayBufferLike>
        | Uint8Array<ArrayBufferLike>
        | { codes: Uint32Array; dictionary: string[] },
    >

  Parameters

  • cols: C
  • Optionaloptions: { copy?: boolean }

  Returns DataFrame<
      {
          [K in string
          | number
          | symbol]: { [K in string | number | symbol]: ColumnValue<C[K]> }[K]
      },
  >

fromCSV

• fromCSV<S extends Row = Row>(
      csv: string,
      options?: ReadCsvOptions,
  ): DataFrame<S>

  Type Parameters

  • S extends Row = Row

  Parameters

  • csv: string
  • Optionaloptions: ReadCsvOptions

  Returns DataFrame<S>

fromJSON

• fromJSON<S extends Row = Row>(
      data: string | Record<string, unknown>[],
      options?: ReadJsonOptions,
  ): DataFrame<S>

  Type Parameters

  • S extends Row = Row

  Parameters

  • data: string | Record<string, unknown>[]
  • Optionaloptions: ReadJsonOptions

  Returns DataFrame<S>

fromRows

• fromRows<T extends Row>(
      rows: readonly T[],
      options: FromRowsOptions<"string"> & { int64: "string" },
  ): DataFrame<InferRows<T, "string">>

  Type Parameters

  • T extends Row

  Parameters

  • rows: readonly T[]
  • options: FromRowsOptions<"string"> & { int64: "string" }

  Returns DataFrame<InferRows<T, "string">>

• fromRows<T extends Row>(
      rows: readonly T[],
      options?: FromRowsOptions<"number" | "error">,
  ): DataFrame<InferRows<T, "error">>

  Type Parameters

  • T extends Row

  Parameters

  • rows: readonly T[]
  • Optionaloptions: FromRowsOptions<"number" | "error">

  Returns DataFrame<InferRows<T, "error">>

• fromRows<T extends Row>(
      rows: readonly T[],
      options: FromRowsOptions,
  ): DataFrame<InferRows<T, Int64Policy>>

  Type Parameters

  • T extends Row

  Parameters

  • rows: readonly T[]
  • options: FromRowsOptions

  Returns DataFrame<InferRows<T, Int64Policy>>

ioOptions

• ioOptions<O extends IoLoadOptions>(options?: O): O

  Per-call IO options with this session's policy added as a floor.

  Type Parameters

  • O extends IoLoadOptions

  Parameters

  • Optionaloptions: O

  Returns O

readArrowIpc

• readArrowIpc<S extends Row = Row>(
      source: IoSource,
      options?: IoPolicy & {
          content?: boolean;
          encoding?: string;
          floors?: IoPolicy[];
          mode?: IoSourceMode;
      } & ArrowIpcReadOptions,
  ): Promise<DataFrame<S>>

  Type Parameters

  • S extends Row = Row

  Parameters

  • source: IoSource
  • Optionaloptions: IoPolicy & {
        content?: boolean;
        encoding?: string;
        floors?: IoPolicy[];
        mode?: IoSourceMode;
    } & ArrowIpcReadOptions

    • Optionalcontent?: boolean

      Treat a string source as raw content, never as a path (alias of mode: 'text').

    • Optionalencoding?: string

      Text encoding when reading bytes/files (default utf-8).

    • Optionalfloors?: IoPolicy[]

      Additional policy floors — a Session's policy, for instance. Every floor is enforced like the process-wide one (each must pass; byte caps and timeouts take the minimum), and per-call fields cannot widen any of them.

    • Optionalmode?: IoSourceMode

      Interpret a bare string as content / path / URL instead of guessing (default 'auto').

  Returns Promise<DataFrame<S>>

readCsv

• readCsv<S extends Row = Row>(
      source: IoSource,
      options?: ReadCsvOptions,
  ): Promise<DataFrame<S>>

  Type Parameters

  • S extends Row = Row

  Parameters

  • source: IoSource
  • Optionaloptions: ReadCsvOptions

  Returns Promise<DataFrame<S>>

readExcel

• readExcel<S extends Row = Row>(
      source: IoSource,
      options?: ReadExcelOptions,
  ): Promise<DataFrame<S>>

  Type Parameters

  • S extends Row = Row

  Parameters

  • source: IoSource
  • Optionaloptions: ReadExcelOptions

  Returns Promise<DataFrame<S>>

readJson

• readJson<S extends Row = Row>(
      source: IoSource,
      options?: ReadJsonOptions,
  ): Promise<DataFrame<S>>

  Type Parameters

  • S extends Row = Row

  Parameters

  • source: IoSource
  • Optionaloptions: ReadJsonOptions

  Returns Promise<DataFrame<S>>

readParquet

• readParquet<S extends Row = Row>(
      source: IoSource,
      options?: ReadParquetOptions,
  ): Promise<DataFrame<S>>

  Type Parameters

  • S extends Row = Row

  Parameters

  • source: IoSource
  • Optionaloptions: ReadParquetOptions

  Returns Promise<DataFrame<S>>