Skip to content

Commit

Permalink
fix: release-plz rejects ignored but checked in files (#1159)
Browse files Browse the repository at this point in the history
I used a checked-in example.vortex file in the query engine section.
Release-plz rejects files that are checked-in but match an ignore
pattern. Seems better anyway to generate the Vortex file at doc creation
time.
  • Loading branch information
danking authored Oct 29, 2024
1 parent 54c1993 commit d884d9f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
Binary file removed docs/_static/example.vortex
Binary file not shown.
16 changes: 9 additions & 7 deletions docs/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,20 @@ Query Engines

:class:`~vortex.dataset.VortexDataset` implements the :class:`pyarrow.dataset.Dataset` API which
enables many Python-based query engines to pushdown row filters and column projections on Vortex
files.
files. All the query engine examples use the same Vortex file:

>>> import vortex
>>> import pyarrow.parquet as pq
>>> vtx = vortex.array(pq.read_table("_static/example.parquet"))
>>> vortex.io.write_path(vtx, 'example.vortex')
>>> ds = vortex.dataset.from_path(
... 'example.vortex'
... )

Polars
^^^^^^

>>> import polars as pl
>>> ds = vortex.dataset.from_path(
... '_static/example.vortex'
... )
>>> lf = pl.scan_pyarrow_dataset(ds)
>>> lf = lf.select('tip_amount', 'fare_amount')
>>> lf = lf.head(3)
Expand All @@ -157,9 +162,6 @@ DuckDB
^^^^^^

>>> import duckdb
>>> ds = vortex.dataset.from_path(
... '_static/example.vortex'
... )
>>> duckdb.sql('select ds.tip_amount, ds.fare_amount from ds limit 3').show()
┌────────────┬─────────────┐
│ tip_amount │ fare_amount │
Expand Down

0 comments on commit d884d9f

Please sign in to comment.