Frame (Deedle) | Deedle

Frame Module

Namespace: Deedle.Arrow
Assembly: Deedle.Arrow.dll

Arrow-specific functions on Deedle Frame values. Open Deedle.Arrow and then call these as Frame.readArrow, Frame.writeArrow, Frame.toRecordBatch, etc.

Functions and values

Function or value	Description
`ofRecordBatch batch` Full Usage: `ofRecordBatch batch` Parameters: batch : `RecordBatch` Returns: `Frame<int, string>`	Convert an Apache Arrow `RecordBatch` to a Deedle `Frame<int,string>`. Row keys are 0-based integers. Arrow null values become Deedle missing values. batch : `RecordBatch` Returns: `Frame<int, string>`
`readArrow path` Full Usage: `readArrow path` Parameters: path : `string` Returns: `Frame<int, string>`	Read an Arrow IPC file (`.arrow` or Feather v2 `.feather`) into a Deedle `Frame<int,string>`. Files with multiple record batches are concatenated into a single frame. path : `string` Returns: `Frame<int, string>`
`readArrowStream stream` Full Usage: `readArrowStream stream` Parameters: stream : `Stream` Returns: `Frame<int, string>`	Read an Arrow IPC stream into a Deedle `Frame<int,string>`. All record batches in the stream are concatenated into a single frame. stream : `Stream` Returns: `Frame<int, string>`
`readArrowWithIndex path` Full Usage: `readArrowWithIndex path` Parameters: path : `string` Returns: `Frame<string, string>`	Read an Arrow IPC file that was written with `Frame.writeArrowWithIndex`, 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>`
`readFeather path` Full Usage: `readFeather path` Parameters: path : `string` Returns: `Frame<int, string>`	Read a Feather v2 file (`.feather`) into a Deedle `Frame<int,string>`. Feather v2 is the Arrow IPC file format — this is an alias for `Frame.readArrow`. path : `string` Returns: `Frame<int, string>`
`readFeatherWithIndex path` Full Usage: `readFeatherWithIndex path` Parameters: path : `string` Returns: `Frame<string, string>`	Read a Feather v2 file that was written with `Frame.writeFeatherWithIndex`, restoring the original string row keys. path : `string` Returns: `Frame<string, string>`
`toRecordBatch frame` Full Usage: `toRecordBatch frame` Parameters: frame : `Frame<'R, 'C>` Returns: `RecordBatch` Type parameters: 'R, 'C (requires equality and equality)	Convert a Deedle `Frame` to an Apache Arrow `RecordBatch`. Column keys are converted to strings via `ToString()`. Row keys are not included; use `Frame.writeArrow` / `Frame.readArrow` for full round-trip serialisation. frame : `Frame<'R, 'C>` Returns: `RecordBatch`
`writeArrow path frame` Full Usage: `writeArrow path frame` Parameters: path : `string` frame : `Frame<'R, string>` Type parameters: 'R (requires equality)	Write a Deedle `Frame` to an Arrow IPC file (the standard `.arrow` format, also compatible with Feather v2 `.feather` files). path : `string` frame : `Frame<'R, string>`
`writeArrowStream stream frame` Full Usage: `writeArrowStream stream frame` Parameters: stream : `Stream` frame : `Frame<'R, string>` Type parameters: 'R (requires equality)	Write a Deedle `Frame` to an Arrow IPC stream (suitable for network transport or streaming pipelines). The stream is left open after writing. stream : `Stream` frame : `Frame<'R, string>`
`writeArrowWithIndex path frame` Full Usage: `writeArrowWithIndex path frame` Parameters: path : `string` frame : `Frame<'R, string>` Type parameters: 'R (requires equality)	Write a Deedle `Frame` to an Arrow IPC 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>`
`writeFeather path frame` Full Usage: `writeFeather path frame` Parameters: path : `string` frame : `Frame<'R, string>` Type parameters: 'R (requires equality)	Write a Deedle `Frame` to a Feather v2 file (`.feather`). Feather v2 is the Arrow IPC file format — this is an alias for `Frame.writeArrow`. path : `string` frame : `Frame<'R, string>`
`writeFeatherWithIndex path frame` Full Usage: `writeFeatherWithIndex path frame` Parameters: path : `string` frame : `Frame<'R, string>` Type parameters: 'R (requires equality)	Write a Deedle `Frame` to a Feather v2 file, storing row keys in a special `__index__` column so they can be restored on read. path : `string` frame : `Frame<'R, string>`