Enums

Namespace: Polars.CSharp

AdbcIngestMode

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

public enum AdbcIngestMode
{
    Create,
    Append,
    Replace
}

---

Alignment

public enum Alignment
{
    Left,
    Center,
    Right
}

---

AmbiguousStrategy

public enum AmbiguousStrategy
{
    Raise,
    Earliest,
    Latest,
    Null
}

---

AsofStrategy

public enum AsofStrategy
{
    Backward,
    Forward,
    Nearest
}

---

AvroCompression

public enum AvroCompression
{
    Uncompressed,
    Deflate,
    Snappy
}

---

CatalogTableType

public enum CatalogTableType
{
    Managed,
    External
}

---

CategoricalPhysical

public enum CategoricalPhysical
{
    U32,
    U16,
    U8
}

---

ClosedInterval

public enum ClosedInterval
{
    Left,
    Right,
    Both,
    None
}

---

CloudProvider

Supported cloud providers for IO operations.

public enum CloudProvider
{
    None,
    Aws,
    Azure,
    Gcp,
    Http,
    HuggingFace
}

---

ConcatType

Concat Type Enum

public enum ConcatType
{
    Vertical,
    Horizontal,
    Diagonal
}

---

CorrelationMethod

public enum CorrelationMethod
{
    Pearson,
    Spearman
}

---

CsvEncoding

public enum CsvEncoding
{
    UTF8,
    LossyUTF8
}

---

DataTypeKind

Enum of DataTypeKind

public enum DataTypeKind
{
    SameAsInput,
    Unknown,
    Boolean,
    Int8,
    Int16,
    Int32,
    Int64,
    UInt8,
    UInt16,
    UInt32,
    UInt64,
    Float32,
    Float64,
    String,
    Date,
    Datetime,
    Time,
    Duration,
    Binary,
    Null,
    Struct,
    List,
    Categorical,
    Decimal,
    Array,
    Int128,
    UInt128,
    Float16,
    Enum,
    Extension
}

---

DeltaSaveMode

mode for saving delta lake table

public enum DeltaSaveMode
{
    Append,
    Overwrite,
    ErrorIfExists,
    Ignore
}

---

Endianness

public enum Endianness
{
    Little,
    Big
}

---

Engine

Execution engine for LazyFrame.Collect()

public enum Engine
{
    Auto,
    InMemory,
    Streaming,
    Gpu
}

---

EpochTimeUnit

public enum EpochTimeUnit
{
    Nanoseconds,
    Microseconds,
    Milliseconds,
    Second,
    Day
}

---

ExternalCompression

public enum ExternalCompression
{
    Uncompressed,
    Gzip,
    ZSTD
}

---

ExtraColumnsPolicy

public enum ExtraColumnsPolicy
{
    Raise,
    Ignore
}

---

FillNullStrategy

public enum FillNullStrategy
{
    Forward,
    Backward,
    Max,
    Min,
    Mean,
    Zero,
    One
}

---

FloatFormat

public enum FloatFormat
{
    Mixed,
    Full
}

---

InterpolationMethod

public enum InterpolationMethod
{
    Linear,
    Nearest
}

---

IpcCompression

public enum IpcCompression
{
    None,
    LZ4,
    ZSTD
}

---

JoinCoalesce

public enum JoinCoalesce
{
    JoinSpecific,
    CoalesceColumns,
    KeepColumns
}

---

JoinMaintainOrder

public enum JoinMaintainOrder
{
    None,
    Left,
    Right,
    LeftRight,
    RightLeft
}

---

JoinSide

Specifies the strategy for the hash join build side.

In a hash join, one dataframe is loaded into memory (the "build side") to construct a hash table, while the other is streamed (the "probe side") to find matches.

Generally, the smaller dataframe should be the build side for optimal performance and memory usage.

public enum JoinSide
{
    LetPolarsDecide,
    PreferLeft,
    ForceLeft,
    PreferRight,
    ForceRight
}

---

JoinType

Enums of RightTypes

public enum JoinType
{
    Inner,
    Left,
    Outer,
    Cross,
    Semi,
    Anti,
    IEJoin
}

---

JoinValidation

public enum JoinValidation
{
    ManyToMany,
    ManyToOne,
    OneToMany,
    OneToOne
}

---

JsonFormat

public enum JsonFormat
{
    Json,
    JsonLines
}

---

Label

Defines which boundary of the window to use for the label.

public enum Label
{
    Left,
    Right,
    DataPoint
}

---

MergeActionType

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

public enum MergeActionType
{
    MatchedUpdate,
    MatchedDelete,
    NotMatchedInsert,
    NotMatchedBySourceDelete
}

---

MissingColumnsPolicy

public enum MissingColumnsPolicy
{
    Raise,
    Insert
}

---

NonExistent

public enum NonExistent
{
    Raise,
    Null
}

---

NullBehavior

public enum NullBehavior
{
    Ignore,
    Drop
}

---

ParallelStrategy

public enum ParallelStrategy
{
    Auto,
    Columns,
    RowGroups,
    None
}

---

ParquetCompression

public enum ParquetCompression
{
    None,
    Snappy,
    Gzip,
    Brotli,
    ZSTD,
    Lz4Raw
}

---

PivotAgg

Specifies the aggregation function for pivot operations.

public enum PivotAgg
{
    First,
    Sum,
    Min,
    Max,
    Mean,
    Median,
    Count,
    Len,
    Last
}

---

PivotColumnNaming

public enum PivotColumnNaming
{
    Auto,
    Combine
}

---

QuantileMethod

public enum QuantileMethod
{
    Nearest,
    Higher,
    Lower,
    Midpoint,
    Linear,
    Equiprobable
}

---

QuoteStyle

public enum QuoteStyle
{
    Necessary,
    Always,
    NonNumeric,
    Never
}

---

RankMethod

public enum RankMethod
{
    Average,
    Min,
    Max,
    Dense,
    Ordinal,
    Random
}

---

Roll

Strategy to handle dates that land on non-business days (weekends or holidays).

public enum Roll
{
    Raise,
    Forward,
    Backward
}

---

RollingRankMethod

public enum RollingRankMethod
{
    Average,
    Min,
    Max,
    Dense,
    Random
}

---

RoundMode

public enum RoundMode
{
    HalfAwayFromZero,
    HalfToEven,
    ToZero
}

---

SearchSortedSide

public enum SearchSortedSide
{
    Any,
    Left,
    Right
}

---

SizeUnit

public enum SizeUnit
{
    Bytes,
    Kilobytes,
    Megabytes,
    Gigabytes,
    Terabytes
}

---

SortStateFlags

public enum SortStateFlags
{
    NotSorted,
    IsSorted,
    Descending,
    NullsLast
}

---

StartBy

Defines the strategy for determining the start of the window.

public enum StartBy
{
    WindowBound,
    DataPoint,
    Monday,
    Tuesday,
    Wednesday,
    Thursday,
    Friday,
    Saturday,
    Sunday
}

---

SyncOnClose

Controls the file synchronization behavior when closing the file.

public enum SyncOnClose
{
    None,
    Data,
    All
}

---

TableFormatting

public enum TableFormatting
{
    AsciiFull,
    AsciiFullCondensed,
    AsciiNoBorders,
    AsciiBordersOnly,
    AsciiBordersOnlyCondensed,
    AsciiHorizontalOnly,
    AsciiMarkdown,
    Markdown,
    Utf8Full,
    Utf8FullCondensed,
    Utf8NoBorders,
    Utf8BordersOnly,
    Utf8HorizontalOnly,
    Nothing
}

---

TimeUnit

TimeUnit Enums

public enum TimeUnit
{
    Nanoseconds,
    Microseconds,
    Milliseconds
}

---

TransferEncoding

public enum TransferEncoding
{
    Hex,
    Base64
}

---

UniqueKeepStrategy

public enum UniqueKeepStrategy
{
    First,
    Last,
    Any,
    None
}

---

UnstackDirection

public enum UnstackDirection
{
    Vertical,
    Horizontal
}

---

UpcastOrForbid

public enum UpcastOrForbid
{
    Forbid,
    Upcast
}

---

WindowMappingStrategy

public enum WindowMappingStrategy
{
    GroupsToRows,
    Explode,
    Join
}

---