Get started
How-to
Tutorials
Concepts
Reference
Python API
Core operations
connect
Python API
Backends
Overview
Profiles
Environment variables
Supported backends
Serialization format
Expression Format
CLI commands
init
completion
install-completion
build
uv build
run
uv run
run-cached
uv run-cached
run-unbound
uv run-unbound
serve-flight-udxf
serve-unbound
catalog
catalog init
catalog clone
catalog info
catalog default
catalog tui
catalog add
catalog remove
catalog list
catalog show
catalog schema
catalog get
catalog add-alias
catalog remove-alias
catalog list-aliases
catalog compose
catalog run
catalog run-cached
catalog serve-unbound
catalog push
catalog pull
catalog sync
catalog set-remote
catalog embed-readonly
catalog check
catalog gc
catalog log
catalog replay
Python API
Core operations
connect
execute
memtable
deferred_read_csv
deferred_read_parquet
to_csv
to_json
to_parquet
to_pyarrow
to_pyarrow_batches
to_sql
register
get_plans
Types and schemas
Data types
Schemas
Data operations
Column
DateValue
DayOfWeek
FloatingColumn
GroupedTable
IntegerColumn
IntervalValue
NumericColumn
Scalar
StringValue
Table
TimeValue
TimestampValue
Value
window
selectors
UDF system
agg.pandas_df
agg.pyarrow
flight_udxf
make_pandas_expr_udf
make_pandas_udf
pyarrow_udwf
User-Defined Exchange Functions
ML operations
train_test_splits
Step
Pipeline
FittedPipeline
deferred_fit_predict
deferred_fit_transform
calc_split_column
Caching
Cache API overview
ParquetCache
ParquetSnapshotCache
SourceCache
SourceSnapshotCache
Lineage
build_column_trees
build_tree
reference/print_tree.qmd
Flight operations
FlightServer
FlightUrl
make_udxf
Catalog operations
Catalog
reference/Build.qmd
reference/Alias.qmd
reference/CatalogMetadata.qmd
On this page
connect
Python API
Core operations
connect
connect
xorq.api.
connect
(session_config
=
None
)
Create a xorq backend.
catalog replay
execute