Overview

Python API reference for functions, classes, and types

The Xorq Python API lets you build expressions, connect to backends, run and cache queries, and serve results over Arrow Flight. Use import xorq.api as xo for core operations; connect with xo.connect() for the default backend or load a specific backend (e.g. xo.duckdb, xo.postgres).

API documentation

Use the sections below to navigate to different areas of the Python API.

Core operations

Connect, execute, read/write data, register, and get plans

Types and schemas

Data types and table schemas

Data operations

Table, Column, Value, window, and selectors

UDF system

Create pandas, PyArrow, and Flight UDFs

ML operations

Pipeline, Step, FittedPipeline, FittedStep, and fit/predict helpers

Caching

Parquet and source caches for expression results

Lineage

Build and print column lineage trees

Flight operations

FlightServer, FlightUrl, connect, and make_udxf

Catalog operations

XorqCatalog, Build, Alias, and CatalogMetadata