Lib.rs

Cargo Features

[dependencies]
polars-core = { version = "0.53.0", default-features = false, features = ["simd", "nightly", "avx512", "temporal", "random", "algorithm_group_by", "lazy", "proptest", "docs", "performant", "strings", "object", "fmt", "fmt_no_tty", "rows", "approx_unique", "bitwise", "zip_with", "round_series", "checked_arithmetic", "is_first_distinct", "is_last_distinct", "row_hash", "reinterpret", "take_opt_iter", "group_by_list", "rolling_window", "rolling_window_by", "diagonal_concat", "product", "unique_counts", "partition_by", "describe", "timezones", "dynamic_group_by", "list_arithmetic", "array_arithmetic", "dtype-date", "dtype-datetime", "dtype-duration", "dtype-time", "dtype-array", "dtype-i16", "dtype-i128", "dtype-decimal", "dtype-extension", "dtype-u16", "dtype-u128", "dtype-f16", "dtype-categorical", "dtype-struct", "bigidx", "python", "serde", "serde-lazy", "dsl-schema", "allow_unused", "docs-selection", "half"] }

default = algorithm_group_by

The algorithm_group_by feature is set by default whenever polars-core is added without default-features = false somewhere in the dependency tree.

simd nightly?

Enables simd of polars-arrow and polars-compute

nightly = simd

Enables nightly of polars-arrow, hashbrown ^0.16.0, and polars-utils

hashbrown:

Enables use of nightly features. This is only guaranteed to work on the latest version of nightly Rust.

avx512

temporal docs-selection? dtype-date? dtype-datetime? dtype-duration? dtype-time? timezones? = chrono, regex

Enables regex of polars-error

Affects chunked_array::temporal…

random docs-selection? = rand, rand_distr

Affects polars-core::random…

algorithm_group_by default bitwise? docs-selection? object? partition_by?

Affects frame::group_by…

lazy docs-selection?

proptest = dtype-i128, dtype-i16, dtype-i8, dtype-u128, dtype-u16, dtype-u8

Enables proptest

Affects datatypes::proptest, frame::proptest, series::proptest…

docs docs-selection?

performant = reinterpret

~40% faster collect, needed until trustedlength iter stabilizes
more fast paths, slower compilation

Enables performant of polars-arrow

Affects owned::coerce_lhs_rhs_owned…

strings docs-selection? = regex

extra utilities for StringChunked

Enables strings of polars-arrow, regex of polars-error

object docs-selection? = algorithm_group_by, serde_json

support for ObjectChunked<T> (downcastable Series of any type)

Affects chunked_array::object, any_value::OwnedObject, datatypes::ObjectType, datatypes::ObjectChunked, series_trait::SeriesTrait.get_object, series_trait::SeriesTrait.get_object_chunked_unchecked, frame::row, time_unit::convert_time_units…

fmt

Enables tty of comfy-table

fmt_no_tty = comfy-table

rows docs-selection?

opt-in features
create from row values
and include pivot operation

Affects frame::row, time_unit::convert_time_units…

approx_unique

operations

Enables approx_unique of polars-compute

Affects ops::ChunkApproxNUnique, series_trait::SeriesTrait.approx_n_unique…

bitwise = algorithm_group_by

Affects ops::ChunkBitwiseReduce…

zip_with docs-selection?

Affects ops::zip…

round_series

checked_arithmetic docs-selection?

Affects borrowed::checked, series_trait::SeriesTrait.checked_div…

is_first_distinct docs-selection?

Affects ops::IsFirstDistinct…

is_last_distinct docs-selection?

Affects ops::IsLastDistinct…

dot_product row_hash docs-selection?

reinterpret performant?

take_opt_iter

group_by_list

allow group_by operation on list type

rolling_window docs-selection?

rolling window functions

Affects ops::ChunkRollApply, series_trait::SeriesTrait.rolling_map…

rolling_window_by docs-selection?

diagonal_concat docs-selection?

Affects functions::concat_df_diagonal…

dataframe_arithmetic product docs-selection?

unique_counts

partition_by docs-selection? = algorithm_group_by

describe docs-selection?

timezones = chrono, chrono-tz, temporal

Enables chrono-tz and timezones of polars-arrow

Affects time_zone::parse_time_zone, time_zone::parse_fixed_offset…

dynamic_group_by = dtype-date, dtype-datetime

list_arithmetic docs-selection?

array_arithmetic docs-selection? = dtype-array

dtype-date dynamic_group_by? = temporal

opt-in datatypes for Series

Affects chunked_array::temporal…

dtype-datetime dynamic_group_by? = temporal

Affects fmt::PlTzAware, chunked_array::temporal, time_unit::convert_time_units…

dtype-duration = temporal

Affects fmt::fmt_duration_string, fmt::iso_duration_string, time_unit::convert_time_units…

dtype-time = temporal

dtype-array array_arithmetic?

Enables dtype-array of polars-arrow and polars-compute

Affects builder::fixed_size_list, iterator::FixedSizeListIterNoNull, datatypes::FixedSizeListType, datatypes::ArrayChunked…

dtype-i8 dtype-i16 proptest?

dtype-i128 dtype-decimal? proptest?

Enables dtype-i128 of polars-compute

Affects datatypes::Int128Chunked…

dtype-decimal docs-selection? = dtype-i128

Enables dtype-decimal of polars-arrow, cast and dtype-decimal of polars-compute

Affects fmt::get_trim_decimal_zeros, fmt::set_trim_decimal_zeros…

dtype-extension

Enables dtype-extension of polars-dtype

Affects datatypes::extension…

dtype-u8 dtype-u16 proptest?

dtype-u128 proptest?

Enables dtype-u128 of polars-compute

Affects datatypes::UInt128Chunked…

dtype-f16

Enables dtype-f16 of polars-compute

Affects datatypes::Float16Chunked…

dtype-categorical docs-selection?

Enables dtype-categorical of polars-dtype

Affects arg_min_max::arg_min_cat, arg_min_max::arg_max_cat, builder::categorical, logical::categorical, datatypes::PolarsCategoricalType, into::ToArrowConverter.categorical_converter, series::categorical_to_arrow…

dtype-struct

Affects row_encode::row_encoding_decode, datatypes::StructType…

bigidx

scale to terabytes?

Enables bigidx of polars-arrow and polars-utils

Affects aliases::IdxCa, aliases::IdxType…

python

Enables python of polars-error

serde docs-selection? dsl-schema? serde-lazy? = serde_json

Enables io_ipc and io_ipc_compression of polars-arrow, serde of bitflags, polars-buffer, polars-compute, polars-dtype, polars-schema, and polars-utils and serde

activate if you want serde support for Series and DataFrames

Affects polars-core::serde…

serde-lazy = serde

Enables indexmap, serde of polars-arrow and chrono <=0.4.41

dsl-schema = serde

Enables schemars ^0.9.0, dsl-schema of polars-compute, polars-dtype, polars-schema, and polars-utils

allow_unused

docs-selection = algorithm_group_by, array_arithmetic, checked_arithmetic, dataframe_arithmetic, describe, diagonal_concat, docs, dot_product, dtype-categorical, dtype-decimal, is_first_distinct, is_last_distinct, lazy, list_arithmetic, ndarray, object, partition_by, product, random, rolling_window, rolling_window_by, row_hash, rows, serde, strings, temporal, zip_with

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

chrono serde-lazy? temporal? timezones?

Enables chrono <=0.4.41

chrono-tz timezones?

comfy-table fmt? fmt_no_tty?

half implicit feature

ndarray docs-selection?

rand random?

Enables rand ^0.9

rand_distr random?

Enables rand_distr ^0.5

regex strings? temporal?

serde_json object? serde?