Skip to main content
Back to top
Ctrl
+
K
Python API reference
User guide
Search
Ctrl
+
K
Choose version
GitHub
Discord
Twitter
Search
Ctrl
+
K
Python API reference
User guide
Choose version
GitHub
Discord
Twitter
Section Navigation
DataFrame
Aggregation
polars.DataFrame.count
polars.DataFrame.max
polars.DataFrame.max_horizontal
polars.DataFrame.mean
polars.DataFrame.mean_horizontal
polars.DataFrame.median
polars.DataFrame.min
polars.DataFrame.min_horizontal
polars.DataFrame.product
polars.DataFrame.quantile
polars.DataFrame.std
polars.DataFrame.sum
polars.DataFrame.sum_horizontal
polars.DataFrame.var
Attributes
polars.DataFrame.columns
polars.DataFrame.dtypes
polars.DataFrame.flags
polars.DataFrame.height
polars.DataFrame.schema
polars.DataFrame.shape
polars.DataFrame.width
Computation
polars.DataFrame.fold
polars.DataFrame.hash_rows
Descriptive
polars.DataFrame.approx_n_unique
polars.DataFrame.describe
polars.DataFrame.estimated_size
polars.DataFrame.glimpse
polars.DataFrame.is_duplicated
polars.DataFrame.is_empty
polars.DataFrame.is_unique
polars.DataFrame.n_chunks
polars.DataFrame.n_unique
polars.DataFrame.null_count
Export
polars.DataFrame.__array__
polars.DataFrame.__arrow_c_stream__
polars.DataFrame.__dataframe__
polars.DataFrame.to_arrow
polars.DataFrame.to_dict
polars.DataFrame.to_dicts
polars.DataFrame.to_init_repr
polars.DataFrame.to_jax
polars.DataFrame.to_numpy
polars.DataFrame.to_pandas
polars.DataFrame.to_struct
polars.DataFrame.to_torch
GroupBy
polars.dataframe.group_by.GroupBy.__iter__
polars.dataframe.group_by.GroupBy.agg
polars.dataframe.group_by.GroupBy.all
polars.dataframe.group_by.GroupBy.count
polars.dataframe.group_by.GroupBy.first
polars.dataframe.group_by.GroupBy.head
polars.dataframe.group_by.GroupBy.last
polars.dataframe.group_by.GroupBy.len
polars.dataframe.group_by.GroupBy.map_groups
polars.dataframe.group_by.GroupBy.max
polars.dataframe.group_by.GroupBy.mean
polars.dataframe.group_by.GroupBy.median
polars.dataframe.group_by.GroupBy.min
polars.dataframe.group_by.GroupBy.n_unique
polars.dataframe.group_by.GroupBy.quantile
polars.dataframe.group_by.GroupBy.sum
polars.dataframe.group_by.GroupBy.tail
Manipulation/selection
polars.DataFrame.__getitem__
polars.DataFrame.bottom_k
polars.DataFrame.cast
polars.DataFrame.clear
polars.DataFrame.clone
polars.DataFrame.drop
polars.DataFrame.drop_in_place
polars.DataFrame.drop_nans
polars.DataFrame.drop_nulls
polars.DataFrame.explode
polars.DataFrame.extend
polars.DataFrame.fill_nan
polars.DataFrame.fill_null
polars.DataFrame.filter
polars.DataFrame.gather_every
polars.DataFrame.get_column
polars.DataFrame.get_column_index
polars.DataFrame.get_columns
polars.DataFrame.group_by
polars.DataFrame.group_by_dynamic
polars.DataFrame.head
polars.DataFrame.hstack
polars.DataFrame.insert_column
polars.DataFrame.interpolate
polars.DataFrame.item
polars.DataFrame.iter_columns
polars.DataFrame.iter_rows
polars.DataFrame.iter_slices
polars.DataFrame.join
polars.DataFrame.join_asof
polars.DataFrame.join_where
polars.DataFrame.limit
polars.DataFrame.melt
polars.DataFrame.merge_sorted
polars.DataFrame.partition_by
polars.DataFrame.pipe
polars.DataFrame.pivot
polars.DataFrame.rechunk
polars.DataFrame.rename
polars.DataFrame.replace_column
polars.DataFrame.reverse
polars.DataFrame.rolling
polars.DataFrame.row
polars.DataFrame.rows
polars.DataFrame.rows_by_key
polars.DataFrame.sample
polars.DataFrame.select
polars.DataFrame.select_seq
polars.DataFrame.set_sorted
polars.DataFrame.shift
polars.DataFrame.shrink_to_fit
polars.DataFrame.slice
polars.DataFrame.sort
polars.DataFrame.sql
polars.DataFrame.tail
polars.DataFrame.to_dummies
polars.DataFrame.to_series
polars.DataFrame.top_k
polars.DataFrame.transpose
polars.DataFrame.unique
polars.DataFrame.unnest
polars.DataFrame.unpivot
polars.DataFrame.unstack
polars.DataFrame.update
polars.DataFrame.upsample
polars.DataFrame.vstack
polars.DataFrame.with_columns
polars.DataFrame.with_columns_seq
polars.DataFrame.with_row_count
polars.DataFrame.with_row_index
Miscellaneous
polars.DataFrame.collect_schema
polars.DataFrame.corr
polars.DataFrame.equals
polars.DataFrame.lazy
polars.DataFrame.map_rows
polars.DataFrame.deserialize
polars.DataFrame.serialize
Plot
Style
LazyFrame
Aggregation
polars.LazyFrame.count
polars.LazyFrame.max
polars.LazyFrame.mean
polars.LazyFrame.median
polars.LazyFrame.min
polars.LazyFrame.null_count
polars.LazyFrame.quantile
polars.LazyFrame.std
polars.LazyFrame.sum
polars.LazyFrame.var
Attributes
polars.LazyFrame.columns
polars.LazyFrame.dtypes
polars.LazyFrame.schema
polars.LazyFrame.width
Descriptive
polars.LazyFrame.describe
polars.LazyFrame.explain
polars.LazyFrame.show_graph
GroupBy
polars.lazyframe.group_by.LazyGroupBy.agg
polars.lazyframe.group_by.LazyGroupBy.all
polars.lazyframe.group_by.LazyGroupBy.count
polars.lazyframe.group_by.LazyGroupBy.first
polars.lazyframe.group_by.LazyGroupBy.head
polars.lazyframe.group_by.LazyGroupBy.last
polars.lazyframe.group_by.LazyGroupBy.len
polars.lazyframe.group_by.LazyGroupBy.map_groups
polars.lazyframe.group_by.LazyGroupBy.max
polars.lazyframe.group_by.LazyGroupBy.mean
polars.lazyframe.group_by.LazyGroupBy.median
polars.lazyframe.group_by.LazyGroupBy.min
polars.lazyframe.group_by.LazyGroupBy.n_unique
polars.lazyframe.group_by.LazyGroupBy.quantile
polars.lazyframe.group_by.LazyGroupBy.sum
polars.lazyframe.group_by.LazyGroupBy.tail
Manipulation/selection
polars.LazyFrame.approx_n_unique
polars.LazyFrame.bottom_k
polars.LazyFrame.cast
polars.LazyFrame.clear
polars.LazyFrame.clone
polars.LazyFrame.drop
polars.LazyFrame.drop_nans
polars.LazyFrame.drop_nulls
polars.LazyFrame.explode
polars.LazyFrame.fill_nan
polars.LazyFrame.fill_null
polars.LazyFrame.filter
polars.LazyFrame.first
polars.LazyFrame.gather_every
polars.LazyFrame.group_by
polars.LazyFrame.group_by_dynamic
polars.LazyFrame.head
polars.LazyFrame.inspect
polars.LazyFrame.interpolate
polars.LazyFrame.join
polars.LazyFrame.join_asof
polars.LazyFrame.join_where
polars.LazyFrame.last
polars.LazyFrame.limit
polars.LazyFrame.melt
polars.LazyFrame.merge_sorted
polars.LazyFrame.rename
polars.LazyFrame.reverse
polars.LazyFrame.rolling
polars.LazyFrame.select
polars.LazyFrame.select_seq
polars.LazyFrame.set_sorted
polars.LazyFrame.shift
polars.LazyFrame.slice
polars.LazyFrame.sort
polars.LazyFrame.sql
polars.LazyFrame.tail
polars.LazyFrame.top_k
polars.LazyFrame.unique
polars.LazyFrame.unnest
polars.LazyFrame.unpivot
polars.LazyFrame.update
polars.LazyFrame.with_columns
polars.LazyFrame.with_columns_seq
polars.LazyFrame.with_context
polars.LazyFrame.with_row_count
polars.LazyFrame.with_row_index
Miscellaneous
polars.LazyFrame.cache
polars.LazyFrame.collect
polars.LazyFrame.collect_async
polars.LazyFrame.collect_schema
polars.LazyFrame.lazy
polars.LazyFrame.map_batches
polars.LazyFrame.pipe
polars.LazyFrame.profile
polars.LazyFrame.deserialize
polars.LazyFrame.serialize
InProcessQuery
polars.lazyframe.in_process.InProcessQuery.cancel
polars.lazyframe.in_process.InProcessQuery.fetch
polars.lazyframe.in_process.InProcessQuery.fetch_blocking
GPUEngine
polars.lazyframe.engine_config.GPUEngine
Series
Aggregation
polars.Series.arg_max
polars.Series.arg_min
polars.Series.count
polars.Series.implode
polars.Series.max
polars.Series.mean
polars.Series.median
polars.Series.min
polars.Series.mode
polars.Series.nan_max
polars.Series.nan_min
polars.Series.product
polars.Series.quantile
polars.Series.std
polars.Series.sum
polars.Series.var
Array
polars.Series.arr.all
polars.Series.arr.any
polars.Series.arr.arg_max
polars.Series.arr.arg_min
polars.Series.arr.contains
polars.Series.arr.count_matches
polars.Series.arr.explode
polars.Series.arr.first
polars.Series.arr.get
polars.Series.arr.join
polars.Series.arr.last
polars.Series.arr.max
polars.Series.arr.median
polars.Series.arr.min
polars.Series.arr.n_unique
polars.Series.arr.reverse
polars.Series.arr.shift
polars.Series.arr.sort
polars.Series.arr.std
polars.Series.arr.sum
polars.Series.arr.to_list
polars.Series.arr.to_struct
polars.Series.arr.unique
polars.Series.arr.var
Attributes
polars.Series.dtype
polars.Series.flags
polars.Series.name
polars.Series.shape
Binary
polars.Series.bin.contains
polars.Series.bin.decode
polars.Series.bin.encode
polars.Series.bin.ends_with
polars.Series.bin.size
polars.Series.bin.starts_with
Boolean
polars.Series.all
polars.Series.any
polars.Series.not_
Categories
polars.Series.cat.get_categories
polars.Series.cat.is_local
polars.Series.cat.len_bytes
polars.Series.cat.len_chars
polars.Series.cat.to_local
polars.Series.cat.uses_lexical_ordering
Computation
polars.Series.abs
polars.Series.arccos
polars.Series.arccosh
polars.Series.arcsin
polars.Series.arcsinh
polars.Series.arctan
polars.Series.arctanh
polars.Series.arg_true
polars.Series.arg_unique
polars.Series.approx_n_unique
polars.Series.bitwise_count_ones
polars.Series.bitwise_count_zeros
polars.Series.bitwise_leading_ones
polars.Series.bitwise_leading_zeros
polars.Series.bitwise_trailing_ones
polars.Series.bitwise_trailing_zeros
polars.Series.bitwise_and
polars.Series.bitwise_or
polars.Series.bitwise_xor
polars.Series.cbrt
polars.Series.cos
polars.Series.cosh
polars.Series.cot
polars.Series.cum_count
polars.Series.cum_max
polars.Series.cum_min
polars.Series.cum_prod
polars.Series.cum_sum
polars.Series.cumulative_eval
polars.Series.diff
polars.Series.dot
polars.Series.entropy
polars.Series.ewm_mean
polars.Series.ewm_mean_by
polars.Series.ewm_std
polars.Series.ewm_var
polars.Series.exp
polars.Series.first
polars.Series.hash
polars.Series.hist
polars.Series.is_between
polars.Series.kurtosis
polars.Series.last
polars.Series.log
polars.Series.log10
polars.Series.log1p
polars.Series.pct_change
polars.Series.peak_max
polars.Series.peak_min
polars.Series.rank
polars.Series.replace
polars.Series.replace_strict
polars.Series.rolling_map
polars.Series.rolling_max
polars.Series.rolling_mean
polars.Series.rolling_median
polars.Series.rolling_min
polars.Series.rolling_quantile
polars.Series.rolling_skew
polars.Series.rolling_std
polars.Series.rolling_sum
polars.Series.rolling_var
polars.Series.search_sorted
polars.Series.sign
polars.Series.sin
polars.Series.sinh
polars.Series.skew
polars.Series.sqrt
polars.Series.tan
polars.Series.tanh
Descriptive
polars.Series.chunk_lengths
polars.Series.describe
polars.Series.estimated_size
polars.Series.has_nulls
polars.Series.has_validity
polars.Series.is_duplicated
polars.Series.is_empty
polars.Series.is_finite
polars.Series.is_first_distinct
polars.Series.is_in
polars.Series.is_infinite
polars.Series.is_last_distinct
polars.Series.is_nan
polars.Series.is_not_nan
polars.Series.is_not_null
polars.Series.is_null
polars.Series.is_sorted
polars.Series.is_unique
polars.Series.len
polars.Series.lower_bound
polars.Series.n_chunks
polars.Series.n_unique
polars.Series.null_count
polars.Series.unique_counts
polars.Series.upper_bound
polars.Series.value_counts
Export
polars.Series.__array__
polars.Series.__arrow_c_stream__
polars.Series.to_arrow
polars.Series.to_frame
polars.Series.to_init_repr
polars.Series.to_jax
polars.Series.to_list
polars.Series.to_numpy
polars.Series.to_pandas
polars.Series.to_torch
List
polars.Series.list.all
polars.Series.list.any
polars.Series.list.arg_max
polars.Series.list.arg_min
polars.Series.list.concat
polars.Series.list.contains
polars.Series.list.count_matches
polars.Series.list.diff
polars.Series.list.drop_nulls
polars.Series.list.eval
polars.Series.list.explode
polars.Series.list.first
polars.Series.list.gather
polars.Series.list.gather_every
polars.Series.list.get
polars.Series.list.head
polars.Series.list.join
polars.Series.list.last
polars.Series.list.len
polars.Series.list.max
polars.Series.list.mean
polars.Series.list.median
polars.Series.list.min
polars.Series.list.n_unique
polars.Series.list.reverse
polars.Series.list.sample
polars.Series.list.set_difference
polars.Series.list.set_intersection
polars.Series.list.set_symmetric_difference
polars.Series.list.set_union
polars.Series.list.shift
polars.Series.list.slice
polars.Series.list.sort
polars.Series.list.std
polars.Series.list.sum
polars.Series.list.tail
polars.Series.list.to_array
polars.Series.list.to_struct
polars.Series.list.unique
polars.Series.list.var
Manipulation/selection
polars.Series.__getitem__
polars.Series.alias
polars.Series.append
polars.Series.arg_sort
polars.Series.bottom_k
polars.Series.cast
polars.Series.ceil
polars.Series.clear
polars.Series.clip
polars.Series.clone
polars.Series.cut
polars.Series.drop_nans
polars.Series.drop_nulls
polars.Series.explode
polars.Series.extend
polars.Series.extend_constant
polars.Series.fill_nan
polars.Series.fill_null
polars.Series.filter
polars.Series.floor
polars.Series.gather
polars.Series.gather_every
polars.Series.head
polars.Series.interpolate
polars.Series.interpolate_by
polars.Series.item
polars.Series.limit
polars.Series.new_from_index
polars.Series.qcut
polars.Series.rechunk
polars.Series.rename
polars.Series.reshape
polars.Series.reverse
polars.Series.rle
polars.Series.rle_id
polars.Series.round
polars.Series.round_sig_figs
polars.Series.sample
polars.Series.scatter
polars.Series.set
polars.Series.shift
polars.Series.shrink_dtype
polars.Series.shrink_to_fit
polars.Series.shuffle
polars.Series.slice
polars.Series.sort
polars.Series.tail
polars.Series.to_dummies
polars.Series.top_k
polars.Series.unique
polars.Series.zip_with
Miscellaneous
polars.Series.equals
polars.Series.get_chunks
polars.Series.map_elements
polars.Series.reinterpret
polars.Series.set_sorted
polars.Series.to_physical
Operators
polars.Series.eq
polars.Series.eq_missing
polars.Series.ge
polars.Series.gt
polars.Series.le
polars.Series.lt
polars.Series.ne
polars.Series.ne_missing
polars.Series.pow
Plot
String
polars.Series.str.concat
polars.Series.str.contains
polars.Series.str.contains_any
polars.Series.str.count_matches
polars.Series.str.decode
polars.Series.str.encode
polars.Series.str.ends_with
polars.Series.str.escape_regex
polars.Series.str.explode
polars.Series.str.extract
polars.Series.str.extract_all
polars.Series.str.extract_groups
polars.Series.str.extract_many
polars.Series.str.find
polars.Series.str.find_many
polars.Series.str.head
polars.Series.str.join
polars.Series.str.json_decode
polars.Series.str.json_path_match
polars.Series.str.len_bytes
polars.Series.str.len_chars
polars.Series.str.pad_end
polars.Series.str.pad_start
polars.Series.str.replace
polars.Series.str.replace_all
polars.Series.str.replace_many
polars.Series.str.reverse
polars.Series.str.slice
polars.Series.str.split
polars.Series.str.split_exact
polars.Series.str.splitn
polars.Series.str.starts_with
polars.Series.str.strip_chars
polars.Series.str.strip_chars_start
polars.Series.str.strip_chars_end
polars.Series.str.strip_prefix
polars.Series.str.strip_suffix
polars.Series.str.strptime
polars.Series.str.tail
polars.Series.str.to_date
polars.Series.str.to_datetime
polars.Series.str.to_decimal
polars.Series.str.to_integer
polars.Series.str.to_lowercase
polars.Series.str.to_time
polars.Series.str.to_titlecase
polars.Series.str.to_uppercase
polars.Series.str.zfill
Struct
polars.Series.struct.field
polars.Series.struct.json_encode
polars.Series.struct.rename_fields
polars.Series.struct.unnest
polars.Series.struct.fields
polars.Series.struct.schema
Temporal
polars.Series.dt.add_business_days
polars.Series.dt.base_utc_offset
polars.Series.dt.cast_time_unit
polars.Series.dt.century
polars.Series.dt.combine
polars.Series.dt.convert_time_zone
polars.Series.dt.date
polars.Series.dt.datetime
polars.Series.dt.day
polars.Series.dt.dst_offset
polars.Series.dt.epoch
polars.Series.dt.hour
polars.Series.dt.is_leap_year
polars.Series.dt.iso_year
polars.Series.dt.max
polars.Series.dt.mean
polars.Series.dt.median
polars.Series.dt.microsecond
polars.Series.dt.millennium
polars.Series.dt.millisecond
polars.Series.dt.min
polars.Series.dt.minute
polars.Series.dt.month
polars.Series.dt.month_end
polars.Series.dt.month_start
polars.Series.dt.nanosecond
polars.Series.dt.offset_by
polars.Series.dt.ordinal_day
polars.Series.dt.quarter
polars.Series.dt.replace_time_zone
polars.Series.dt.round
polars.Series.dt.second
polars.Series.dt.strftime
polars.Series.dt.time
polars.Series.dt.timestamp
polars.Series.dt.to_string
polars.Series.dt.total_days
polars.Series.dt.total_hours
polars.Series.dt.total_microseconds
polars.Series.dt.total_milliseconds
polars.Series.dt.total_minutes
polars.Series.dt.total_nanoseconds
polars.Series.dt.total_seconds
polars.Series.dt.truncate
polars.Series.dt.week
polars.Series.dt.weekday
polars.Series.dt.with_time_unit
polars.Series.dt.year
Expressions
Aggregation
polars.Expr.agg_groups
polars.Expr.all
polars.Expr.any
polars.Expr.approx_n_unique
polars.Expr.arg_max
polars.Expr.arg_min
polars.Expr.bitwise_and
polars.Expr.bitwise_or
polars.Expr.bitwise_xor
polars.Expr.count
polars.Expr.first
polars.Expr.implode
polars.Expr.last
polars.Expr.len
polars.Expr.max
polars.Expr.mean
polars.Expr.median
polars.Expr.min
polars.Expr.n_unique
polars.Expr.nan_max
polars.Expr.nan_min
polars.Expr.null_count
polars.Expr.product
polars.Expr.quantile
polars.Expr.std
polars.Expr.sum
polars.Expr.var
Array
polars.Expr.arr.all
polars.Expr.arr.any
polars.Expr.arr.arg_max
polars.Expr.arr.arg_min
polars.Expr.arr.contains
polars.Expr.arr.count_matches
polars.Expr.arr.explode
polars.Expr.arr.first
polars.Expr.arr.get
polars.Expr.arr.join
polars.Expr.arr.last
polars.Expr.arr.max
polars.Expr.arr.median
polars.Expr.arr.min
polars.Expr.arr.n_unique
polars.Expr.arr.reverse
polars.Expr.arr.shift
polars.Expr.arr.sort
polars.Expr.arr.std
polars.Expr.arr.sum
polars.Expr.arr.to_list
polars.Expr.arr.to_struct
polars.Expr.arr.unique
polars.Expr.arr.var
Binary
polars.Expr.bin.contains
polars.Expr.bin.decode
polars.Expr.bin.encode
polars.Expr.bin.ends_with
polars.Expr.bin.size
polars.Expr.bin.starts_with
Boolean
polars.Expr.all
polars.Expr.any
polars.Expr.has_nulls
polars.Expr.is_between
polars.Expr.is_duplicated
polars.Expr.is_finite
polars.Expr.is_first_distinct
polars.Expr.is_in
polars.Expr.is_infinite
polars.Expr.is_last_distinct
polars.Expr.is_nan
polars.Expr.is_not_nan
polars.Expr.is_not_null
polars.Expr.is_null
polars.Expr.is_unique
polars.Expr.not_
Categories
polars.Expr.cat.get_categories
polars.Expr.cat.len_bytes
polars.Expr.cat.len_chars
Columns / names
polars.Expr.alias
polars.Expr.exclude
polars.col
Computation
polars.Expr.abs
polars.Expr.approx_n_unique
polars.Expr.arccos
polars.Expr.arccosh
polars.Expr.arcsin
polars.Expr.arcsinh
polars.Expr.arctan
polars.Expr.arctanh
polars.Expr.arg_unique
polars.Expr.bitwise_count_ones
polars.Expr.bitwise_count_zeros
polars.Expr.bitwise_leading_ones
polars.Expr.bitwise_leading_zeros
polars.Expr.bitwise_trailing_ones
polars.Expr.bitwise_trailing_zeros
polars.Expr.cbrt
polars.Expr.cos
polars.Expr.cosh
polars.Expr.cot
polars.Expr.cum_count
polars.Expr.cum_max
polars.Expr.cum_min
polars.Expr.cum_prod
polars.Expr.cum_sum
polars.Expr.cumulative_eval
polars.Expr.degrees
polars.Expr.diff
polars.Expr.dot
polars.Expr.entropy
polars.Expr.ewm_mean
polars.Expr.ewm_mean_by
polars.Expr.ewm_std
polars.Expr.ewm_var
polars.Expr.exp
polars.Expr.hash
polars.Expr.hist
polars.Expr.kurtosis
polars.Expr.log
polars.Expr.log10
polars.Expr.log1p
polars.Expr.mode
polars.Expr.n_unique
polars.Expr.pct_change
polars.Expr.peak_max
polars.Expr.peak_min
polars.Expr.radians
polars.Expr.rank
polars.Expr.rolling_map
polars.Expr.rolling_max
polars.Expr.rolling_max_by
polars.Expr.rolling_mean
polars.Expr.rolling_mean_by
polars.Expr.rolling_median
polars.Expr.rolling_median_by
polars.Expr.rolling_min
polars.Expr.rolling_min_by
polars.Expr.rolling_quantile
polars.Expr.rolling_quantile_by
polars.Expr.rolling_skew
polars.Expr.rolling_std
polars.Expr.rolling_std_by
polars.Expr.rolling_sum
polars.Expr.rolling_sum_by
polars.Expr.rolling_var
polars.Expr.rolling_var_by
polars.Expr.search_sorted
polars.Expr.sign
polars.Expr.sin
polars.Expr.sinh
polars.Expr.skew
polars.Expr.sqrt
polars.Expr.tan
polars.Expr.tanh
polars.Expr.unique
polars.Expr.unique_counts
polars.Expr.value_counts
Functions
polars.all
polars.all_horizontal
polars.any
polars.any_horizontal
polars.approx_n_unique
polars.arange
polars.arctan2
polars.arctan2d
polars.arg_sort_by
polars.arg_where
polars.business_day_count
polars.coalesce
polars.concat_arr
polars.concat_list
polars.concat_str
polars.corr
polars.count
polars.cov
polars.cum_count
polars.cum_fold
polars.cum_reduce
polars.cum_sum
polars.cum_sum_horizontal
polars.date
polars.date_range
polars.date_ranges
polars.datetime
polars.datetime_range
polars.datetime_ranges
polars.duration
polars.element
polars.exclude
polars.first
polars.fold
polars.format
polars.from_epoch
polars.groups
polars.head
polars.implode
polars.int_range
polars.int_ranges
polars.last
polars.len
polars.lit
polars.map_batches
polars.map_groups
polars.max
polars.max_horizontal
polars.mean
polars.mean_horizontal
polars.median
polars.min
polars.min_horizontal
polars.n_unique
polars.nth
polars.ones
polars.quantile
polars.reduce
polars.repeat
polars.rolling_corr
polars.rolling_cov
polars.select
polars.sql
polars.sql_expr
polars.std
polars.struct
polars.sum
polars.sum_horizontal
polars.tail
polars.time
polars.time_range
polars.time_ranges
polars.var
polars.when
polars.zeros
polars.Expr.all
polars.Expr.any
polars.Expr.approx_n_unique
polars.Expr.count
polars.Expr.first
polars.Expr.head
polars.Expr.implode
polars.Expr.map_batches
polars.Expr.map_elements
polars.Expr.max
polars.Expr.mean
polars.Expr.median
polars.Expr.min
polars.Expr.n_unique
polars.Expr.quantile
polars.Expr.std
polars.Expr.sum
polars.Expr.tail
polars.Expr.var
List
polars.Expr.list.all
polars.Expr.list.any
polars.Expr.list.arg_max
polars.Expr.list.arg_min
polars.Expr.list.concat
polars.Expr.list.contains
polars.Expr.list.count_matches
polars.Expr.list.diff
polars.Expr.list.drop_nulls
polars.Expr.list.eval
polars.Expr.list.explode
polars.Expr.list.first
polars.Expr.list.gather
polars.Expr.list.gather_every
polars.Expr.list.get
polars.Expr.list.head
polars.Expr.list.join
polars.Expr.list.last
polars.Expr.list.len
polars.Expr.list.max
polars.Expr.list.mean
polars.Expr.list.median
polars.Expr.list.min
polars.Expr.list.n_unique
polars.Expr.list.reverse
polars.Expr.list.sample
polars.Expr.list.set_difference
polars.Expr.list.set_intersection
polars.Expr.list.set_symmetric_difference
polars.Expr.list.set_union
polars.Expr.list.shift
polars.Expr.list.slice
polars.Expr.list.sort
polars.Expr.list.std
polars.Expr.list.sum
polars.Expr.list.tail
polars.Expr.list.to_array
polars.Expr.list.to_struct
polars.Expr.list.unique
polars.Expr.list.var
Manipulation/selection
polars.Expr.append
polars.Expr.arg_sort
polars.Expr.arg_true
polars.Expr.backward_fill
polars.Expr.bottom_k
polars.Expr.bottom_k_by
polars.Expr.cast
polars.Expr.ceil
polars.Expr.clip
polars.Expr.cut
polars.Expr.drop_nans
polars.Expr.drop_nulls
polars.Expr.explode
polars.Expr.extend_constant
polars.Expr.fill_nan
polars.Expr.fill_null
polars.Expr.filter
polars.Expr.flatten
polars.Expr.floor
polars.Expr.forward_fill
polars.Expr.gather
polars.Expr.gather_every
polars.Expr.get
polars.Expr.head
polars.Expr.inspect
polars.Expr.interpolate
polars.Expr.interpolate_by
polars.Expr.limit
polars.Expr.lower_bound
polars.Expr.pipe
polars.Expr.qcut
polars.Expr.rechunk
polars.Expr.reinterpret
polars.Expr.repeat_by
polars.Expr.replace
polars.Expr.replace_strict
polars.Expr.reshape
polars.Expr.reverse
polars.Expr.rle
polars.Expr.rle_id
polars.Expr.round
polars.Expr.round_sig_figs
polars.Expr.sample
polars.Expr.shift
polars.Expr.shrink_dtype
polars.Expr.shuffle
polars.Expr.slice
polars.Expr.sort
polars.Expr.sort_by
polars.Expr.tail
polars.Expr.to_physical
polars.Expr.top_k
polars.Expr.top_k_by
polars.Expr.upper_bound
polars.Expr.where
Meta
polars.Expr.meta.eq
polars.Expr.meta.has_multiple_outputs
polars.Expr.meta.is_column
polars.Expr.meta.is_column_selection
polars.Expr.meta.is_literal
polars.Expr.meta.is_regex_projection
polars.Expr.meta.ne
polars.Expr.meta.output_name
polars.Expr.meta.pop
polars.Expr.meta.root_names
polars.Expr.meta.serialize
polars.Expr.meta.show_graph
polars.Expr.meta.tree_format
polars.Expr.meta.undo_aliases
polars.Expr.meta.write_json
Miscellaneous
polars.Expr.deserialize
polars.Expr.from_json
polars.Expr.set_sorted
Name
polars.Expr.name.keep
polars.Expr.name.map
polars.Expr.name.map_fields
polars.Expr.name.prefix
polars.Expr.name.prefix_fields
polars.Expr.name.suffix
polars.Expr.name.suffix_fields
polars.Expr.name.to_lowercase
polars.Expr.name.to_uppercase
Operators
polars.Expr.and_
polars.Expr.or_
polars.Expr.eq
polars.Expr.eq_missing
polars.Expr.ge
polars.Expr.gt
polars.Expr.le
polars.Expr.lt
polars.Expr.ne
polars.Expr.ne_missing
polars.Expr.add
polars.Expr.floordiv
polars.Expr.mod
polars.Expr.mul
polars.Expr.neg
polars.Expr.pow
polars.Expr.sub
polars.Expr.truediv
polars.Expr.xor
String
polars.Expr.str.concat
polars.Expr.str.contains
polars.Expr.str.contains_any
polars.Expr.str.count_matches
polars.Expr.str.decode
polars.Expr.str.encode
polars.Expr.str.ends_with
polars.Expr.str.escape_regex
polars.Expr.str.explode
polars.Expr.str.extract
polars.Expr.str.extract_all
polars.Expr.str.extract_groups
polars.Expr.str.extract_many
polars.Expr.str.find
polars.Expr.str.find_many
polars.Expr.str.head
polars.Expr.str.join
polars.Expr.str.json_decode
polars.Expr.str.json_path_match
polars.Expr.str.len_bytes
polars.Expr.str.len_chars
polars.Expr.str.pad_end
polars.Expr.str.pad_start
polars.Expr.str.replace
polars.Expr.str.replace_all
polars.Expr.str.replace_many
polars.Expr.str.reverse
polars.Expr.str.slice
polars.Expr.str.split
polars.Expr.str.split_exact
polars.Expr.str.splitn
polars.Expr.str.starts_with
polars.Expr.str.strip_chars
polars.Expr.str.strip_chars_start
polars.Expr.str.strip_chars_end
polars.Expr.str.strip_prefix
polars.Expr.str.strip_suffix
polars.Expr.str.strptime
polars.Expr.str.tail
polars.Expr.str.to_date
polars.Expr.str.to_datetime
polars.Expr.str.to_decimal
polars.Expr.str.to_integer
polars.Expr.str.to_lowercase
polars.Expr.str.to_time
polars.Expr.str.to_titlecase
polars.Expr.str.to_uppercase
polars.Expr.str.zfill
Struct
polars.Expr.struct.field
polars.Expr.struct.unnest
polars.Expr.struct.json_encode
polars.Expr.struct.rename_fields
polars.Expr.struct.with_fields
Temporal
polars.Expr.dt.add_business_days
polars.Expr.dt.base_utc_offset
polars.Expr.dt.cast_time_unit
polars.Expr.dt.century
polars.Expr.dt.combine
polars.Expr.dt.convert_time_zone
polars.Expr.dt.date
polars.Expr.dt.datetime
polars.Expr.dt.day
polars.Expr.dt.dst_offset
polars.Expr.dt.epoch
polars.Expr.dt.hour
polars.Expr.dt.is_leap_year
polars.Expr.dt.iso_year
polars.Expr.dt.microsecond
polars.Expr.dt.millennium
polars.Expr.dt.millisecond
polars.Expr.dt.minute
polars.Expr.dt.month
polars.Expr.dt.month_end
polars.Expr.dt.month_start
polars.Expr.dt.nanosecond
polars.Expr.dt.offset_by
polars.Expr.dt.ordinal_day
polars.Expr.dt.quarter
polars.Expr.dt.replace_time_zone
polars.Expr.dt.round
polars.Expr.dt.second
polars.Expr.dt.strftime
polars.Expr.dt.time
polars.Expr.dt.timestamp
polars.Expr.dt.to_string
polars.Expr.dt.total_days
polars.Expr.dt.total_hours
polars.Expr.dt.total_microseconds
polars.Expr.dt.total_milliseconds
polars.Expr.dt.total_minutes
polars.Expr.dt.total_nanoseconds
polars.Expr.dt.total_seconds
polars.Expr.dt.truncate
polars.Expr.dt.week
polars.Expr.dt.weekday
polars.Expr.dt.with_time_unit
polars.Expr.dt.year
Window
polars.Expr.over
polars.Expr.rolling
Selectors
Functions
polars.from_arrow
polars.from_dataframe
polars.from_dict
polars.from_dicts
polars.from_numpy
polars.from_pandas
polars.from_records
polars.from_repr
polars.json_normalize
polars.align_frames
polars.concat
polars.escape_regex
polars.collect_all
polars.collect_all_async
polars.set_random_seed
polars.StringCache
polars.enable_string_cache
polars.disable_string_cache
polars.using_string_cache
Data types
polars.datatypes.DataType
polars.datatypes.Decimal
polars.datatypes.Float32
polars.datatypes.Float64
polars.datatypes.Int8
polars.datatypes.Int16
polars.datatypes.Int32
polars.datatypes.Int64
polars.datatypes.Int128
polars.datatypes.UInt8
polars.datatypes.UInt16
polars.datatypes.UInt32
polars.datatypes.UInt64
polars.datatypes.Date
polars.datatypes.Datetime
polars.datatypes.Duration
polars.datatypes.Time
polars.datatypes.Array
polars.datatypes.List
polars.datatypes.Struct
polars.datatypes.String
polars.datatypes.Categorical
polars.datatypes.Enum
polars.datatypes.Utf8
polars.datatypes.Binary
polars.datatypes.Boolean
polars.datatypes.Null
polars.datatypes.Object
polars.datatypes.Unknown
Schema
Input/output
polars.read_avro
polars.DataFrame.write_avro
polars.read_clipboard
polars.DataFrame.write_clipboard
polars.read_csv
polars.read_csv_batched
polars.scan_csv
polars.DataFrame.write_csv
polars.LazyFrame.sink_csv
polars.io.csv.batched_reader.BatchedCsvReader.next_batches
polars.read_database
polars.read_database_uri
polars.DataFrame.write_database
polars.read_delta
polars.scan_delta
polars.DataFrame.write_delta
polars.read_excel
polars.read_ods
polars.DataFrame.write_excel
polars.read_ipc
polars.read_ipc_schema
polars.read_ipc_stream
polars.scan_ipc
polars.DataFrame.write_ipc
polars.DataFrame.write_ipc_stream
polars.LazyFrame.sink_ipc
polars.scan_iceberg
polars.read_json
polars.read_ndjson
polars.scan_ndjson
polars.DataFrame.write_json
polars.DataFrame.write_ndjson
polars.LazyFrame.sink_ndjson
polars.read_parquet
polars.read_parquet_schema
polars.scan_parquet
polars.DataFrame.write_parquet
polars.LazyFrame.sink_parquet
polars.scan_pyarrow_dataset
polars.CredentialProvider
polars.CredentialProviderAWS
polars.CredentialProviderGCP
Config
polars.Config.set_ascii_tables
polars.Config.set_auto_structify
polars.Config.set_decimal_separator
polars.Config.set_float_precision
polars.Config.set_fmt_float
polars.Config.set_fmt_str_lengths
polars.Config.set_fmt_table_cell_list_len
polars.Config.set_streaming_chunk_size
polars.Config.set_tbl_cell_alignment
polars.Config.set_tbl_cell_numeric_alignment
polars.Config.set_tbl_cols
polars.Config.set_tbl_column_data_type_inline
polars.Config.set_tbl_dataframe_shape_below
polars.Config.set_tbl_formatting
polars.Config.set_tbl_hide_column_data_types
polars.Config.set_tbl_hide_column_names
polars.Config.set_tbl_hide_dataframe_shape
polars.Config.set_tbl_hide_dtype_separator
polars.Config.set_tbl_rows
polars.Config.set_tbl_width_chars
polars.Config.set_thousands_separator
polars.Config.set_trim_decimal_zeros
polars.Config.set_verbose
polars.Config.load
polars.Config.load_from_file
polars.Config.save
polars.Config.save_to_file
polars.Config.state
polars.Config.restore_defaults
Extending the API
polars.api.register_expr_namespace
polars.api.register_dataframe_namespace
polars.api.register_lazyframe_namespace
polars.api.register_series_namespace
Plugins
SQL Interface
Python API
polars.SQLContext.execute
polars.SQLContext.execute_global
polars.SQLContext.register
polars.SQLContext.register_globals
polars.SQLContext.register_many
polars.SQLContext.tables
polars.SQLContext.unregister
SQL Clauses
SQL Functions
Aggregate
Array
Temporal
Conditional
Math
String
Temporal
Trigonometry
Types
Set Operations
Table Operations
Exceptions
polars.exceptions.PolarsError
polars.exceptions.ColumnNotFoundError
polars.exceptions.ComputeError
polars.exceptions.DuplicateError
polars.exceptions.InvalidOperationError
polars.exceptions.ModuleUpgradeRequiredError
polars.exceptions.NoDataError
polars.exceptions.NoRowsReturnedError
polars.exceptions.OutOfBoundsError
polars.exceptions.ParameterCollisionError
polars.exceptions.RowsError
polars.exceptions.SQLInterfaceError
polars.exceptions.SQLSyntaxError
polars.exceptions.SchemaError
polars.exceptions.SchemaFieldNotFoundError
polars.exceptions.ShapeError
polars.exceptions.StringCacheMismatchError
polars.exceptions.StructFieldNotFoundError
polars.exceptions.TooManyRowsReturnedError
polars.exceptions.UnsuitableSQLError
polars.exceptions.PolarsWarning
polars.exceptions.CategoricalRemappingWarning
polars.exceptions.ChronoFormatWarning
polars.exceptions.CustomUFuncWarning
polars.exceptions.DataOrientationWarning
polars.exceptions.MapWithoutReturnDtypeWarning
polars.exceptions.PerformanceWarning
polars.exceptions.PolarsInefficientMapWarning
polars.exceptions.UnstableWarning
polars.exceptions.PanicException
Testing
polars.testing.assert_frame_equal
polars.testing.assert_frame_not_equal
polars.testing.assert_series_equal
polars.testing.assert_series_not_equal
polars.testing.parametric.dataframes
polars.testing.parametric.dtypes
polars.testing.parametric.lists
polars.testing.parametric.series
polars.testing.parametric.column
polars.testing.parametric.columns
polars.testing.parametric.create_list_strategy
polars.testing.parametric.load_profile
polars.testing.parametric.set_profile
Metadata
polars.build_info
polars.get_index_type
polars.show_versions
polars.thread_pool_size
polars.threadpool_size
Python API reference
Data types
polars.datatypes.Utf8
polars.datatypes.Utf8
#
polars.datatypes.
Utf8
[source]
#
alias of
String
On this page
Utf8