Polars.NET

Appearance

Enums & Discriminated Unions ​

Namespace: Polars.FSharp

Active ​

fsharp
type Active =
    | Set of bool
    | ResetToDefault

AdbcIngestMode ​

Specifies the behavior when bulk ingesting a DataFrame into an ADBC database table.

fsharp
type AdbcIngestMode =
    | Create
    | Append
    | Replace

Alignment ​

fsharp
type Alignment =
    | Left
    | Center
    | Right
    | ResetToDefault

AsofStrategy ​

fsharp
type AsofStrategy =
    | Backward
    | Forward
    | Nearest

AvroCompression ​

fsharp
type AvroCompression =
    | Uncompressed
    | Deflate
    | Snappy

CatalogTableType ​

fsharp
type CatalogTableType =
    | Managed
    | External

CategoricalPhysical ​

fsharp
type CategoricalPhysical =
    | U32
    | U16
    | U8

CharSet ​

fsharp
type CharSet =
    | Set of char
    | ResetToDefault

ChunkSet ​

fsharp
type ChunkSet =
    | Set of uint64
    | ResetToDefault

ClosedInterval ​

fsharp
type ClosedInterval =
    | Left
    | Right
    | Both
    | NoWindow

CloudProvider ​

fsharp
type CloudProvider =
    | NotCloud
    | Aws
    | Azure
    | Gcp
    | Http
    | HuggingFace

ConcatType ​

Specifies the type of concat operations.

fsharp
type ConcatType =
    | Vertical
    | Horizontal
    | Diagonal

ConfigScope ​

fsharp
type ConfigScope =
    | SetOnly
    | All

CsvEncoding ​

fsharp
type CsvEncoding =
    | UTF8
    | LossyUTF8

DataTypeKind ​

fsharp
type DataTypeKind =
    | SameAsInput
    | Null
    | Boolean
    | Int8
    | Int16
    | Int32
    | Int64
    | UInt8
    | UInt16
    | UInt32
    | UInt64
    | Float32
    | Float64
    | String
    | Binary
    | Date
    | Time
    | Int128
    | UInt128
    | Float16
    | Datetime of TimeUnit * string option
    | Duration of TimeUnit
    | Categorical of Categories option
    | Decimal of int * int
    | List of DataType
    | Struct of seq<Field>
    | Array of DataType * uint32[]
    | Enum of FrozenCategories
    | Extension of <>f__AnonymousType2529729763<string option, string, DataType>
    | Unknown

DeltaSaveMode ​

mode for saving delta lake table

fsharp
type DeltaSaveMode =
    | Append
    | Overwrite
    | ErrorIfExists
    | Ignore

Dtype ​

fsharp
type Dtype =
    | DataTypeExpr of DataTypeExpr
    | PlDataType of DataType
    | NetType of Type

Dur ​

fsharp
type Dur =
    | String of string
    | TimeSpan of TimeSpan
    | Index of int

Endianness ​

fsharp
type Endianness =
    | Little
    | Big

Engine ​

fsharp
type Engine =
    | Auto
    | InMemory
    | Gpu
    | Streaming

EpochTimeUnit ​

fsharp
type EpochTimeUnit =
    | Nanoseconds
    | Microseconds
    | Milliseconds
    | Second
    | Day

ExtensionRegistration ​

fsharp
type ExtensionRegistration =
    | AsStorage
    | AsType of ((DataType * string option) -> DataType)

ExternalCompression ​

fsharp
type ExternalCompression =
    | Uncompressed
    | Gzip
    | ZSTD

ExtraColumnsPolicy ​

fsharp
type ExtraColumnsPolicy =
    | Raise
    | Ignore

FillNullStrategy ​

fsharp
type FillNullStrategy =
    | Forward
    | Backward
    | Max
    | Min
    | Mean
    | Zero
    | One

FloatFormat ​

fsharp
type FloatFormat =
    | Mixed
    | Full
    | ResetToDefault

GroupByType ​

Defines the type of GroupBy operation and stores specific parameters for each strategy.

fsharp
type GroupByType =
    | Standard of maintainOrder: bool
    | Dynamic of indexColumn: string * every: string * period: string * offset: string * label: Label * includeBoundaries: bool * closedInterval: ClosedInterval * startBy: StartBy
    | Rolling of indexColumn: string * period: string * offset: string * closedInterval: ClosedInterval

InterpolationMethod ​

fsharp
type InterpolationMethod =
    | Nearest
    | Linear

IpcCompression ​

fsharp
type IpcCompression =
    | NoCompression
    | LZ4
    | ZSTD

JoinCoalesce ​

fsharp
type JoinCoalesce =
    | JoinSpecific
    | CoalesceColumns
    | KeepColumns

JoinMaintainOrder ​

fsharp
type JoinMaintainOrder =
    | NotMaintainOrder
    | Left
    | Right
    | LeftRight
    | RightLeft

JoinSide ​

fsharp
type JoinSide =
    | LetPolarsDecide
    | PreferLeft
    | ForceLeft
    | PreferRight
    | ForceRight

JoinType ​

Represents the type of join operation to perform.

fsharp
type JoinType =
    | Inner
    | Left
    | Outer
    | Cross
    | Semi
    | Anti

JoinValidation ​

fsharp
type JoinValidation =
    | ManyToMany
    | ManyToOne
    | OneToMany
    | OneToOne

JsonFormat ​

fsharp
type JsonFormat =
    | Json
    | JsonLines

Label ​

fsharp
type Label =
    | Left
    | Right
    | DataPoint

MergeAction ​

fsharp
type MergeAction =
    | MatchedUpdate of condition: (MergeContext -> Expr) * setters: SetterSpec option
    | MatchedDelete of condition: (MergeContext -> Expr)
    | NotMatchedInsert of condition: (MergeContext -> Expr) * setters: SetterSpec option
    | NotMatchedBySourceDelete of condition: (MergeContext -> Expr)

MergeActionType ​

Defines the type of action to perform during a Delta Merge operation.

fsharp
type MergeActionType =
    | MatchedUpdate
    | MatchedDelete
    | NotMatchedInsert
    | NotMatchedBySourceDelete

MissingColumnsPolicy ​

fsharp
type MissingColumnsPolicy =
    | Raise
    | Insert

NonExistent ​

fsharp
type NonExistent =
    | Raise
    | SetNull

NullBehavior ​

fsharp
type NullBehavior =
    | Ignore
    | Drop

NumSet ​

fsharp
type NumSet =
    | Set of int
    | ResetToDefault

ParallelStrategy ​

fsharp
type ParallelStrategy =
    | Auto
    | Columns
    | RowGroups
    | NoParallel

ParquetCompression ​

fsharp
type ParquetCompression =
    | Uncompressed
    | Snappy
    | Gzip
    | Brotli
    | Zstd
    | Lz4Raw

PartitionKey ​

Represents a composite partition key consisting of multiple boxed column values. Defined as a single-case discriminated union to support natural constructor syntax and satisfy F# Map comparison constraints with zero compiler conflicts.

fsharp
type PartitionKey =
    | PartitionKey of obj[]

PivotAgg ​

Specifies the aggregation function for pivot operations.

fsharp
type PivotAgg =
    | First
    | Sum
    | Min
    | Max
    | Mean
    | Median
    | Count
    | Last

PivotColumnNaming ​

fsharp
type PivotColumnNaming =
    | Auto
    | Combine

QuantileMethod ​

fsharp
type QuantileMethod =
    | Nearest
    | Higher
    | Lower
    | Midpoint
    | Linear

QuoteStyle ​

fsharp
type QuoteStyle =
    | Always
    | Necessary
    | Never
    | NonNumeric

RankMethod ​

fsharp
type RankMethod =
    | Average
    | Min
    | Max
    | Dense
    | Ordinal
    | Random

Roll ​

fsharp
type Roll =
    | Raise
    | Forward
    | Backward

RollingRankMethod ​

fsharp
type RollingRankMethod =
    | Average
    | Min
    | Max
    | Dense
    | Random

RoundMode ​

fsharp
type RoundMode =
    | HalfAwayFromZero
    | HalfToEven
    | ToZero

SearchSortedSide ​

fsharp
type SearchSortedSide =
    | Any
    | Left
    | Right

SetterSpec ​

fsharp
type SetterSpec =
    | Explicit of Map<string, Expr>
    | Dynamic of (MergeContext -> Map<string, Expr>)

SizeUnit ​

fsharp
type SizeUnit =
    | Bytes
    | Kilobytes
    | Megabytes
    | Gigabytes
    | Terabytes

SortStateFlags ​

Bitwise flags representing the sorting state of a Series or Column.

fsharp
type SortStateFlags =
    | NotSorted
    | IsSorted
    | Descending
    | NullsLast

StartBy ​

fsharp
type StartBy =
    | WindowBound
    | DataPoint
    | Monday
    | Tuesday
    | Wednesday
    | Thursday
    | Friday
    | Saturday
    | Sunday

SyncOnClose ​

fsharp
type SyncOnClose =
    | NoSync
    | Data
    | All

TableFormatting ​

fsharp
type TableFormatting =
    | AsciiFull
    | AsciiFullCondensed
    | AsciiNoBorders
    | AsciiBordersOnly
    | AsciiBordersOnlyCondensed
    | AsciiHorizontalOnly
    | AsciiMarkdown
    | Markdown
    | Utf8Full
    | Utf8FullCondensed
    | Utf8NoBorders
    | Utf8BordersOnly
    | Utf8HorizontalOnly
    | Nothing
    | ResetToDefault

TimeUnit ​

fsharp
type TimeUnit =
    | Nanoseconds
    | Microseconds
    | Milliseconds

Tolerance ​

fsharp
type Tolerance =
    | String of string
    | TimeSpan of TimeSpan
    | Integer of int64
    | Float of float

TransferEncoding ​

fsharp
type TransferEncoding =
    | Base64
    | Hex

UniqueKeepStrategy ​

fsharp
type UniqueKeepStrategy =
    | First
    | Last
    | Any
    | NoKeep

UnstackDirection ​

fsharp
type UnstackDirection =
    | Vertical
    | Horizontal

UpcastOrForbid ​

fsharp
type UpcastOrForbid =
    | Forbid
    | Upcast

WindowMappingStrategy ​

fsharp
type WindowMappingStrategy =
    | GroupsToRows
    | Explode
    | Join

Released under the MIT License. Powered by the Polars Rust core & Apache Arrow.

Copyright © 2026-present Qinglei Zhang