Logo Deedle

VirtualCsvExtensions Module

Type extensions

Type extension Description

Virtual.ReadCsv(path, ?searchColumns, ?columnKeys, ?byteOffsetIndex, ?hasHeaders)

Full Usage: Virtual.ReadCsv(path, ?searchColumns, ?columnKeys, ?byteOffsetIndex, ?hasHeaders)

Parameters:
    path : string
    ?searchColumns : VirtualSearchColumn list
    ?columnKeys : string list
    ?byteOffsetIndex : bool
    ?hasHeaders : bool

Returns: Frame<int64, string>

Load a CSV file as a virtual frame with ordinal row index `0 .. N-1`.

Extended Type: Virtual

path : string
?searchColumns : VirtualSearchColumn list
?columnKeys : string list
?byteOffsetIndex : bool
?hasHeaders : bool
Returns: Frame<int64, string>

Virtual.ReadCsv(path, indexColumn, ?searchColumns, ?columnKeys, ?byteOffsetIndex, ?hasHeaders)

Full Usage: Virtual.ReadCsv(path, indexColumn, ?searchColumns, ?columnKeys, ?byteOffsetIndex, ?hasHeaders)

Parameters:
    path : string
    indexColumn : string
    ?searchColumns : VirtualSearchColumn list
    ?columnKeys : string list
    ?byteOffsetIndex : bool
    ?hasHeaders : bool

Returns: Frame<'R, string>
Type parameters: 'R (requires equality)

Load a CSV file as a virtual frame. When `indexColumn` is set, that column becomes the row index only if it is strictly increasing and unique in file order; otherwise an ordinal index is used (trace warning). Specify the row key type explicitly (for example `DateTimeOffset` for a timestamp column).

Extended Type: Virtual

path : string
indexColumn : string
?searchColumns : VirtualSearchColumn list
?columnKeys : string list
?byteOffsetIndex : bool
?hasHeaders : bool
Returns: Frame<'R, string>

Virtual.ReadCsvDirectory(directory, ?searchPattern, ?searchColumns, ?columnKeys, ?byteOffsetIndex, ?hasHeaders)

Full Usage: Virtual.ReadCsvDirectory(directory, ?searchPattern, ?searchColumns, ?columnKeys, ?byteOffsetIndex, ?hasHeaders)

Parameters:
    directory : string
    ?searchPattern : string
    ?searchColumns : VirtualSearchColumn list
    ?columnKeys : string list
    ?byteOffsetIndex : bool
    ?hasHeaders : bool

Returns: Frame<int64, string>

Load matching CSV files in a directory as one ordinal virtual frame (files sorted by name). Rows are addressed 0 .. N-1 across files; all files must share the first file's header.

Extended Type: Virtual

directory : string
?searchPattern : string
?searchColumns : VirtualSearchColumn list
?columnKeys : string list
?byteOffsetIndex : bool
?hasHeaders : bool
Returns: Frame<int64, string>

Type something to start searching.