Logo Deedle

Frame Module

Parquet-specific functions on Deedle Frame values. Open Deedle.Parquet and then call these as Frame.readParquet, Frame.writeParquet, etc.

Functions and values

Function or value Description

readParquet path

Full Usage: readParquet path

Parameters:
    path : string

Returns: Frame<int, string>

Read a Parquet file into a Deedle Frame<int,string>. Row keys are 0-based integers. Parquet null values become Deedle missing values. Files with multiple row groups are concatenated into a single frame.

path : string
Returns: Frame<int, string>

readParquetStream stream

Full Usage: readParquetStream stream

Parameters:
Returns: Frame<int, string>

Read a Parquet stream into a Deedle Frame<int,string>. The stream must be seekable. All row groups are concatenated into a single frame.

stream : Stream
Returns: Frame<int, string>

readParquetWithIndex path

Full Usage: readParquetWithIndex path

Parameters:
    path : string

Returns: Frame<string, string>

Read a Parquet file that was written with Frame.writeParquetWithIndex, restoring the original string row keys. If no __index__ column is present, returns a frame with 0-based integer row keys converted to strings.

path : string
Returns: Frame<string, string>

writeParquet path frame

Full Usage: writeParquet path frame

Parameters:
    path : string
    frame : Frame<'R, string>

Type parameters: 'R (requires equality)

Write a Deedle Frame to a Parquet file.

path : string
frame : Frame<'R, string>

writeParquetStream stream frame

Full Usage: writeParquetStream stream frame

Parameters:
Type parameters: 'R (requires equality)

Write a Deedle Frame to a Parquet stream. The stream must be seekable. The stream is left open after writing.

stream : Stream
frame : Frame<'R, string>

writeParquetWithIndex path frame

Full Usage: writeParquetWithIndex path frame

Parameters:
    path : string
    frame : Frame<'R, string>

Type parameters: 'R (requires equality)

Write a Deedle Frame to a Parquet file, storing row keys in a special __index__ column so they can be restored on read. Row keys are serialised via ToString().

path : string
frame : Frame<'R, string>

Type something to start searching.