Config
Namespace: Polars.FSharp
Config for Polars.FSharp
Module Functions
Config.asciiTables
Use ASCII characters to display table outlines. Set False to revert to the standard UTF8_FULL_CONDENSED formatting style.
Config.asciiTables : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.clientEvaluationPolicy
Sets the client-side evaluation policy for operations or expressions that cannot be pushed down to the native Polars engine.
Config.clientEvaluationPolicy : policy: ClientEvaluationPolicy -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
policy | ClientEvaluationPolicy | - |
unitVar0 | unit | - |
Config.decimalSeparator
Set the decimal separator character.
Config.decimalSeparator : separator: CharSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
separator | CharSet | - |
unitVar0 | unit | - |
Config.deltaMaxRetries
Set the maximum Retires for Delta Table operations.
Config.deltaMaxRetries : retries: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
retries | NumSet | - |
unitVar0 | unit | - |
Config.engineAffinity
Set which engine to use by default.
Config.engineAffinity : engine: Engine -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
engine | Engine | - |
unitVar0 | unit | - |
Config.floatPrecision
Control the number of decimal places displayed for floating point values.
Config.floatPrecision : precision: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
precision | NumSet | - |
unitVar0 | unit | - |
Config.formatFloat
Control how floating point values are displayed.
Config.formatFloat : format: FloatFormat -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
format | FloatFormat | - |
unitVar0 | unit | - |
Config.formatStringLength
Set the number of characters used to display string values.
Config.formatStringLength : n: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
n | NumSet | - |
unitVar0 | unit | - |
Config.formatTableCellListLength
Set the number of elements to display for List values.
Config.formatTableCellListLength : n: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
n | NumSet | - |
unitVar0 | unit | - |
Config.getOr
Retrieves the current configuration value for the specified key, or returns a default value if the key is not found.
Config.getOr : defaultValue: string -> key: string -> stringParameters
| Name | Type | Description |
|---|---|---|
defaultValue | string | - |
key | string | - |
Config.load
Load (and set) previously saved Config options from a JSON string.Only already set parameter will be recorded.
Config.load : cfgJson: string -> unitParameters
| Name | Type | Description |
|---|---|---|
cfgJson | string | - |
Config.loadFromFile
Load (and set) previously saved Config options from file.
Config.loadFromFile : path: string -> unitParameters
| Name | Type | Description |
|---|---|---|
path | string | - |
Config.queryCacheCapacity
Set the maximum capacity for the LINQ Query Plan Cache.
Config.queryCacheCapacity : capacity: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
capacity | NumSet | - |
unitVar0 | unit | - |
Config.queryCacheEnabled
Enable or disable the LINQ Query Plan Cache globally.
Config.queryCacheEnabled : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.restoreDefaults
Reset all polars Config settings to their default state.
Config.restoreDefaults : unit -> unitConfig.save
Save the current set of Config options as a JSON string.
Config.save : scope: ConfigScope -> stringParameters
| Name | Type | Description |
|---|---|---|
scope | ConfigScope | - |
Config.saveToFile
Save the current set of Config options as a JSON file.
Config.saveToFile : path: string -> unitParameters
| Name | Type | Description |
|---|---|---|
path | string | - |
Config.set
Inject Environment var to Rust
Config.set : key: string -> value: string -> unitParameters
| Name | Type | Description |
|---|---|---|
key | string | - |
value | string | - |
Config.setMany
Inject Environment vars to Rust from a sequence of tuples
Config.setMany : variables: seq<(string * string)> -> unitParameters
| Name | Type | Description |
|---|---|---|
variables | seq<(string * string)> | - |
Config.setMap
Inject Environment vars to Rust from KeyValuePair sequence
Config.setMap : variables: Map<string, string> -> unitParameters
| Name | Type | Description |
|---|---|---|
variables | Map<string, string> | - |
Config.status
Show the current state of all Config variables in the environment as a dict.
Config.status : scope: ConfigScope -> Dictionary<string, string>Parameters
| Name | Type | Description |
|---|---|---|
scope | ConfigScope | - |
Config.streamingChunkSize
Overwrite chunk size used in streaming engine.
Config.streamingChunkSize : size: ChunkSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
size | ChunkSet | - |
unitVar0 | unit | - |
Config.tableCellAlignment
Set table cell alignment.
Config.tableCellAlignment : format: Alignment -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
format | Alignment | - |
unitVar0 | unit | - |
Config.tableCellNumericAlignment
Set table cell alignment for numeric columns.
Config.tableCellNumericAlignment : format: Alignment -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
format | Alignment | - |
unitVar0 | unit | - |
Config.tableCols
Set the number of columns that are visible when displaying tables.
Config.tableCols : n: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
n | NumSet | - |
unitVar0 | unit | - |
Config.tableColumnDataTypeInline
Display the data type next to the column name (to the right, in parentheses).
Config.tableColumnDataTypeInline : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tableDataFrameShapeBelow
Print the DataFrame shape information below the data when displaying tables.
Config.tableDataFrameShapeBelow : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tableFormatting
Sets the text/ASCII formatting style for outputting DataFrames.
Config.tableFormatting : format: TableFormatting -> roundedCorners: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
format | TableFormatting | - |
roundedCorners | Active | - |
unitVar0 | unit | - |
Config.tableHideColumnDataTypes
Hide table column data types (i64, f64, str etc.).
Config.tableHideColumnDataTypes : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tableHideColumnNames
Hide table column names.
Config.tableHideColumnNames : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tableHideDataFrameShape
Hide the DataFrame shape information when displaying tables.
Config.tableHideDataFrameShape : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tableHideDataTypeSeparator
Hide the ‘—’ separator displayed between the column names and column types.
Config.tableHideDataTypeSeparator : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tableRows
Set the max number of rows used to draw the table (both Dataframe and Series).
Config.tableRows : n: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
n | NumSet | - |
unitVar0 | unit | - |
Config.tableWidthChars
Set the maximum width of a table in characters.
Config.tableWidthChars : width: NumSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
width | NumSet | - |
unitVar0 | unit | - |
Config.thousandsSeparator
Configures the thousands separator with a specific single character.
Config.thousandsSeparator : separator: CharSet -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
separator | CharSet | - |
unitVar0 | unit | - |
Config.trimDecimalZeros
Strip trailing zeros from Decimal data type values.
Config.trimDecimalZeros : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.tryGet
Safely retrieves the current configuration value for the specified key. Matches keys in a case-insensitive manner.
Config.tryGet : key: string -> string optionParameters
| Name | Type | Description |
|---|---|---|
key | string | - |
Config.verbose
Configures whether Polars should run in verbose mode, printing query profiles and optimization decisions.
Config.verbose : active: Active -> unitVar0: unit -> unitParameters
| Name | Type | Description |
|---|---|---|
active | Active | - |
unitVar0 | unit | - |
Config.withConfig
Executes a function within a temporary configuration scope. Captures the current configuration snapshot, applies the provided configuration adjustments, runs the operation, and guarantees restoration of the previous state when finished.
Config.withConfig : actions: (unit -> unit) list -> f: (unit -> 'T) -> 'TParameters
| Name | Type | Description |
|---|---|---|
actions | (unit -> unit) list | A sequence of configuration modification actions (unit -> unit). |
f | (unit -> 'T) | The operation to execute within this configuration scope. |