Opteryx Core

Opteryx Core is the SQL execution engine behind opteryx.app. It is a fork of Opteryx with a smaller, more opinionated API and configuration surface, shaped around the workloads used by the hosted service.

This library is designed for fast, read-heavy analytical queries over Parquet-backed data. It handles SQL parsing, planning, predicate pushdown, projection pruning, and execution so you can query datasets from Python without standing up a separate warehouse.

This project is opinionated toward the needs of opteryx.app. It is still useful as a standalone library if you want to query local Parquet, NDJSON, and CSV datasets, embed SQL into a Python service or notebook, or experiment with engine internals directly.

Requirements

  • Python 3.11 or later
  • A C/C++ toolchain for local source builds
  • Rust/Cargo for the Rust extension in src/

Install

pip install opteryx-core

Import it as:

import opteryx

Quick Start: Query Local Files

If your current working directory contains local Parquet data, the simplest way to use Opteryx Core is to register a local workspace and query it with dot-separated names.

import opteryx
from opteryx.connectors import DiskConnector

opteryx.register_workspace("data", DiskConnector)

session = opteryx.session()
result = session.execute_to_arrow(
    "SELECT id, name FROM data.planets WHERE id < 5"
)

print(result)

In this model, dataset names are resolved relative to the current working directory. For example, data.planets resolves to ./data/planets, and Opteryx Core reads the Parquet files it finds there.

What It Is For

  • Powering the execution layer used by opteryx.app
  • Running analytical SQL against local Parquet-backed datasets
  • Embedding a query engine inside Python applications, scripts, notebooks, and services
  • Working on engine internals such as planning, execution, and Parquet performance

Local Development

The supported local build path is the repository Makefile:

make dev-install
make compile
make q

Useful targets:

Target Purpose
make compile Clean in-place build of Cython, C++, and Rust extensions
make c Incremental extension build
make q Fast SQL shape smoke test
make test Full pytest suite after compiling
make dt Draken native unit tests
make check Ruff and import-order checks without modifying files

Do not use pip install . as the primary development build path; make compile matches the layout expected by this repository.

Repository Layout

Path Purpose
opteryx/ Python package, planner, operators, connectors, expression evaluation, and Cython modules
draken/ Native columnar vector substrate used by the execution engine
rugo/ Internal Parquet and JSONL reader used by scans and metadata paths
src/ Rust extension code, currently including the SQL dialect integration
tests/ Unit, integration, fuzzing, sqllogictest, and benchmark harnesses
testdata/ Local datasets and benchmark fixtures
dev/ Development, release, vendoring, and analysis scripts
scratch/ Experimental prototypes and one-off investigations
third_party/ Vendored native dependencies

Best With Opteryx Catalog

Opteryx Core works best when paired with the opteryx_catalog library. That is the intended model for named datasets, catalog-backed tables, and the general experience used in opteryx.app.

Typical setup:

import os

import opteryx

from opteryx import set_default_connector
from opteryx.connectors import OpteryxConnector
from opteryx_catalog import OpteryxCatalog

set_default_connector(
    OpteryxConnector,
    catalog=OpteryxCatalog,
    firestore_project=os.environ["GCP_PROJECT_ID"],
    firestore_database=os.environ["FIRESTORE_DATABASE"],
    gcs_bucket=os.environ["GCS_BUCKET"],
)

Once configured, you can query catalog-backed datasets using dot-separated names such as public.space.planets or opteryx.ops.billing.

For local data, Opteryx Core is typically used through registered workspaces such as testdata, scratch, or data. Queries refer to datasets by dot-separated names relative to the workspace root, for example testdata.planets, testdata.satellites, or scratch.signals.

Where It Fits

Opteryx Core is best thought of as an embedded analytical engine rather than a full end-user platform. If you want a hosted experience, multi-tenant service features, and the broader product workflow, use opteryx.app. If you want the core engine in your own environment, this package gives you that engine directly. If you want the intended table-resolution model, pair it with opteryx_catalog.

Contributing

If you use Opteryx-Core yourself, we want to hear from you.

  • Use it on your own datasets
  • Raise bugs when queries, schemas, or performance do not behave as expected
  • Open pull requests for fixes, tests, docs, or performance improvements
  • Share repro cases, failing queries, and edge-case Parquet files

This project is being actively built, and outside usage helps make it better.

Docs: https://docs.opteryx.app/ Source: https://github.com/mabel-dev/opteryx-core License: Apache-2.0

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.9.87)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for joocer from gravatar.com joocer

Credits

Author/Maintainer: Justin Joyce

Requires

Python >=3.11

Provides Extra

testing performance embeddings

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opteryx_core-0.9.55.tar.gz (12.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

opteryx_core-0.9.55-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (42.4 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.17+ x86-64

opteryx_core-0.9.55-cp314-cp314-macosx_11_0_arm64.whl (24.6 MB view details)

Uploaded CPython 3.14macOS 11.0+ ARM64

opteryx_core-0.9.55-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (42.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

opteryx_core-0.9.55-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (42.4 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

opteryx_core-0.9.55-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (42.5 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

File details

Details for the file opteryx_core-0.9.55.tar.gz.

File metadata

  • Download URL: opteryx_core-0.9.55.tar.gz
  • Upload date:
  • Size: 12.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for opteryx_core-0.9.55.tar.gz
Algorithm Hash digest
SHA256 1e37f53c9d4fdc6fea7d39131a20a2a5a45643db568793eb8338b483e9a4eb41
MD5 12df1f50ef8068a1463174f06f1338ab
BLAKE2b-256 fdcf18f3550485ec0c7ea510be719b8e8d5875710bd078f3efd95acd13d1ead8

See more details on using hashes here.

File details

Details for the file opteryx_core-0.9.55-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for opteryx_core-0.9.55-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 6709bb450165c736d443378c70a735feeca6616bfadcf09d55a3b96e8ac13e28
MD5 a09cf4a761c1f8e5d6a94d70e16f11ef
BLAKE2b-256 16bb94ce51dcd49eb08cbe4749148a62992b4ae4580dafac592dd41db48be7d8

See more details on using hashes here.

File details

Details for the file opteryx_core-0.9.55-cp314-cp314-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for opteryx_core-0.9.55-cp314-cp314-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c1906d61f134934271f13e45bad774bce148856a0ae69966eced20088d6cb014
MD5 8c7f163b5154f8cf0cf6f8ca847f1085
BLAKE2b-256 55ddcbd82c9e338796c68ccf0e679eee875aea31ed5392ddf5f64de1cd7db682

See more details on using hashes here.

File details

Details for the file opteryx_core-0.9.55-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for opteryx_core-0.9.55-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 27627b6e08337faa69470426ad80e984d9589cf2cc5d771491ea031b691e8efc
MD5 e7fea7f95944954445b1cfe2d6b05565
BLAKE2b-256 34bf3a6277e376f80c7029c1f58d7817149b4af558957794121f29d4a16c79a5

See more details on using hashes here.

File details

Details for the file opteryx_core-0.9.55-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for opteryx_core-0.9.55-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 1b7cb9c0a49f1bba4c527300d4064b3f35581ff3c23b5d54016b9cbbff62f629
MD5 ba20cbbf896df8e8e7b640763808bdd1
BLAKE2b-256 bdf00222b594c286862e15871c46530166c80ffe46b9c8408d7f8945e227d2a9

See more details on using hashes here.

File details

Details for the file opteryx_core-0.9.55-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for opteryx_core-0.9.55-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 85c3501ab55a48612aff8ebe2811016c31f3a7f2a916749ddd74562bc6512c3e
MD5 6440011b9813ee02b9186e20b2d05c6f
BLAKE2b-256 8f2b8866a8019001747c23d51448ae5bd0db78aba6bcbe07edb5aab73bd43a02

See more details on using hashes here.

Release history Release notifications | RSS feed

0.9.87

7 files

0.9.86

7 files

0.9.85

7 files

0.9.84

7 files

0.9.83

7 files

0.9.82

7 files

0.9.81

7 files

0.9.80

7 files

0.9.79

7 files

0.9.78

7 files

0.9.77

7 files

0.9.76

7 files

0.9.75

7 files

0.9.74

7 files

0.9.73

7 files

0.9.71

10 files

0.9.70

10 files

0.9.69

10 files

0.9.68

6 files

0.9.67

6 files

0.9.66

6 files

0.9.65

6 files

0.9.64

6 files

0.9.63

6 files

0.9.62

6 files

0.9.60

6 files

0.9.58

6 files

0.9.56

6 files

This release

0.9.55 This release

6 files

0.9.54

6 files

0.9.53

6 files

0.9.52

6 files

0.9.50

5 files

0.9.49

5 files

0.9.48

5 files

0.9.47

5 files

0.9.46

5 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page