Skip to main content

sigilyx

YXDB reader and writer for Python.

PyPI Python License: Apache-2.0

YXDB is the native binary format used by Alteryx Designer. sigilyx reads and writes .yxdb files using Polars DataFrames, PyArrow Tables, or Pandas DataFrames.

The core is written in Rust. No native Alteryx Designer installation is required.

Format scope: sigilyx has full read/write support for the E1 (original engine) YXDB layout. Experimental read support for E2 (AMP engine) is included - 13 field types have been verified against real E2 files; 4 rare types (Blob, SpatialObj, Time, WString) have speculative decoders behind an opt-in flag. E2 writing is not yet supported. See SPECIFICATION-E2.md for details.

Installation

pip install sigilyx                     # Polars only (default)
pip install "sigilyx[arrow]"            # + PyArrow
pip install "sigilyx[pandas]"           # + Pandas + PyArrow
pip install "sigilyx[all]"              # all extras

Requires Python 3.9+. Pre-built wheels for Windows, macOS, and Linux (x64 and ARM).

Quick Start

import polars as pl
import sigilyx  # importing registers pl.read_yxdb(), df.yxdb, etc.

# Read
df = pl.read_yxdb("data.yxdb")

# Write
df.yxdb.write("output.yxdb")

API

Polars Integration

Importing sigilyx registers official Polars namespace plugins and top-level IO aliases. No extra calls needed - just import sigilyx.

import polars as pl
import sigilyx

# Top-level IO (mirrors pl.read_parquet / pl.scan_parquet style)
df = pl.read_yxdb("data.yxdb")           # returns pl.DataFrame
lf = pl.scan_yxdb("data.yxdb")           # returns pl.LazyFrame (IO plugin)

# Namespace API on DataFrame / LazyFrame
df.yxdb.write("output.yxdb")             # pl.DataFrame → .yxdb file
lf.yxdb.sink("output.yxdb")              # pl.LazyFrame → .yxdb file (streaming)

Reading

import sigilyx as yx

# Polars DataFrame - fastest, zero-copy via Arrow C Data Interface
df = yx.read_yxdb("data.yxdb")

# PyArrow Table
table = yx.read_yxdb_arrow("data.yxdb")

# Pandas DataFrame (via PyArrow)
pdf = yx.read_yxdb_pandas("data.yxdb")

Writing

import sigilyx as yx

# Polars DataFrame
yx.write_yxdb("output.yxdb", df)

# PyArrow Table
yx.write_yxdb_arrow("output.yxdb", table)

# Pandas DataFrame
yx.write_yxdb_pandas("output.yxdb", pdf)

Streaming / Batched Read

Iterate over large files with constant memory usage:

import sigilyx as yx

# Basic iteration - each batch is a Polars DataFrame
for batch in yx.read_yxdb_batches("data.yxdb", batch_size=100_000):
    process(batch)

# Column projection - only materialise the columns you need
for batch in yx.read_yxdb_batches("data.yxdb", columns=["Id", "Name", "Amount"]):
    process(batch)

# Row limit - stop after N total rows
for batch in yx.read_yxdb_batches("data.yxdb", n_rows=5_000):
    process(batch)

Lazy Scan

import polars as pl
import sigilyx as yx

# Returns a Polars LazyFrame backed by a native Rust streaming reader.
# Only the YXDB header is read on construction; data streams on .collect().
lf = yx.scan("data.yxdb")

result = lf.filter(pl.col("amount") > 100).collect()

# Projection pushdown - only selected columns are materialised in Rust
top10 = lf.select("id", "name").head(10).collect()

Pushdown support: projection (select / with_columns) and row-limit (n_rows / .head()) are pushed down to the Rust reader. Predicate pushdown is not possible - YXDB rows are LZF-compressed with no block-level statistics, so .filter() is applied after the scan.

Metadata

import sigilyx as yx

# Inspect schema without reading any row data
fields = yx.read_yxdb_fields("data.yxdb")
for f in fields:
    print(f.name, f.field_type, f.size)

# Record count from the file header - no data read
n = yx.record_count("data.yxdb")

Field Types

YXDB Type Polars / Arrow Type Notes
Bool Boolean
Byte Int16 Unsigned byte stored as Int16
Int16 Int16
Int32 Int32
Int64 Int64
Float Float32
Double Float64
FixedDecimal Decimal Precision and scale preserved
String String / Utf8 Fixed-width, ASCII/Latin-1
WString String / Utf8 Fixed-width, UTF-16 decoded
V_String String / LargeUtf8 Variable-length, ASCII/Latin-1
V_WString String / LargeUtf8 Variable-length, UTF-16 decoded
Date Date Days since Unix epoch
DateTime Datetime(us) Microsecond precision
Time Time Nanosecond precision
Blob Binary / LargeBinary Variable-length binary
SpatialObj Binary / LargeBinary Geometry as ISO WKB or raw SHP bytes

Links

License

Apache License 2.0.

Download files

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

Source Distribution

sigilyx-0.4.0.tar.gz (155.1 kB view details)

Uploaded Source

Built Distributions

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

sigilyx-0.4.0-cp39-abi3-win_amd64.whl (6.9 MB view details)

Uploaded CPython 3.9+Windows x86-64

sigilyx-0.4.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (6.4 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

sigilyx-0.4.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (5.8 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

sigilyx-0.4.0-cp39-abi3-macosx_11_0_arm64.whl (5.6 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

File details

Details for the file sigilyx-0.4.0.tar.gz.

File metadata

  • Download URL: sigilyx-0.4.0.tar.gz
  • Upload date:
  • Size: 155.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sigilyx-0.4.0.tar.gz
Algorithm Hash digest
SHA256 5f69f25781df394a6d9b66f30d8a5ba53b36d8296ec42c6e7ae739f913978c7e
MD5 5c89c5177aa11a9e14a2d6e230a48935
BLAKE2b-256 33ecdab290f73d14f7e5d62aa001dcd202919ee5c8311947175811428c88cad7

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigilyx-0.4.0.tar.gz:

Publisher: publish-pypi.yml on Sigilweaver/SigilYX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigilyx-0.4.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: sigilyx-0.4.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 6.9 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sigilyx-0.4.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 271974b4ede6d0203eae501f7e5b245d110fd0ddb8eb0723da3652354aaca747
MD5 632eb2c9d751b27857036980edb85c98
BLAKE2b-256 831de32ffffd78c79524eb9bcd90187e60c0788aef321367f9e7e311ba1bc28b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigilyx-0.4.0-cp39-abi3-win_amd64.whl:

Publisher: publish-pypi.yml on Sigilweaver/SigilYX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigilyx-0.4.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for sigilyx-0.4.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 acc5126ee860156e05a8d90aab51cf24000b44df1c72a95e385f76bd417701fc
MD5 1592a5d90ea16d73aab27623ba0f8236
BLAKE2b-256 7661d55d95f99f3fe1f3ac9f2f5fa4a534bc2ba978d48892515740556ae5746f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigilyx-0.4.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish-pypi.yml on Sigilweaver/SigilYX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigilyx-0.4.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for sigilyx-0.4.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 fccf113099a18fb7f56e6298039bf1ba61306a70db2e956719b3cc85ef01f55b
MD5 9afda1e7b4687ce872b77ea3a345632a
BLAKE2b-256 45281089c0fea90a076a9817c5f20b3ae68f8fc65fc7a91f7c26995e4931b5c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigilyx-0.4.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: publish-pypi.yml on Sigilweaver/SigilYX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sigilyx-0.4.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for sigilyx-0.4.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9090aa0a88b49645c39f797f3358eefad73107dea20ef6c433659654019d233f
MD5 1147160580f9bd44b5bb89cad6e07adc
BLAKE2b-256 121cd2d6e53fe70cd2e794e3d6e2bf9d24a109ad3b5d70b6f897e2380234ffe4

See more details on using hashes here.

Provenance

The following attestation bundles were made for sigilyx-0.4.0-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: publish-pypi.yml on Sigilweaver/SigilYX

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.4.0 This release

5 files

0.3.3

5 files

0.3.2

5 files

0.3.1

5 files

0.3.0

4 files

0.2.1

4 files

0.0.0

2 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