API reference

This page gives an overview of all public polars objects, functions and methods. All classes and functions exposed in polars.* namespace are public.

• Input/output
  • CSV
  • Feather/ IPC
  • Parquet
  • Database
  • JSON
  • AVRO
  • Spreadsheet
  • Apache Iceberg
  • Delta Lake
  • Datasets
  • BatchedCsvReader
• Series
• DataFrame
• LazyFrame
• Expressions
• Selectors
  • Importing
  • Set operations
  • Functions
• Extending the API
  • Providing new functionality
  • Available registrations
  • Examples
• Functions
  • Conversion
  • Miscellaneous
  • Parallelization
  • Random
  • StringCache
• Data types
  • polars.DataType
  • Numeric
  • Temporal
  • Nested
  • Other
• Config
  • Config options
  • Config load, save, and current state
  • Use as a context manager
  • Use as a function decorator
• Exceptions
  • polars.exceptions.ArrowError
  • polars.exceptions.ColumnNotFoundError
  • polars.exceptions.ComputeError
  • polars.exceptions.DuplicateError
  • polars.exceptions.InvalidOperationError
  • polars.exceptions.NoDataError
  • polars.exceptions.NoRowsReturnedError
  • polars.exceptions.PolarsPanicError
  • polars.exceptions.RowsError
  • polars.exceptions.SchemaError
  • polars.exceptions.SchemaFieldNotFoundError
  • polars.exceptions.ShapeError
  • polars.exceptions.StructFieldNotFoundError
  • polars.exceptions.TooManyRowsReturnedError
• Testing
  • Asserts
  • Parametric testing
• Utils
  • polars.build_info
  • polars.get_index_type
  • polars.show_versions
  • polars.threadpool_size
• SQL
  • SQLContext
  • Methods