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>,
  ): DataFrame<S>

  Type Parameters

  • S extends Row = Row

  Parameters

  • bytes: ArrayBuffer | Uint8Array<ArrayBufferLike>

  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[]): DataFrame<T>

  Type Parameters

  • T extends Row

  Parameters

  • rows: readonly T[]

  Returns DataFrame<T>

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?: IoLoadOptions,
  ): Promise<DataFrame<S>>

  Type Parameters

  • S extends Row = Row

  Parameters

  • source: IoSource
  • Optionaloptions: IoLoadOptions

  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>>