Skip to content

Repository files navigation

KX NYSE TAQ Benchmarks

QuickStart

To run the in-memory query engine benchmark on a tiny-sized dataset, execute the following from the repository root. See the numbered steps below for details, prerequisites (KDB-X, logging and printf modules, uv, iostat (from package sysstat)), and other data sizes/benchmarks.

# Fetch the taq submodule used to download the data
git submodule update --init --recursive

# Configuration
export SIZE=tiny
export NYSEBENCHMARKDIR=$PWD/DATA     # where downloads and generated databases live
export DATADATE=$(curl -s https://ftp.nyse.com/Historical%20Data%20Samples/DAILY%20TAQ/| grep -oE 'EQY_US_ALL_TRADE_2[0-9]{7}' | grep -oE '2[0-9]{7}'|head -1)

# Step 2: download and prepare the PSV files
./external/kx/taq/scripts/getPSVs.sh --csvdir ${NYSEBENCHMARKDIR}/${SIZE}/psv --dates ${DATADATE} --size ${SIZE}

# Step 3: generate the binary databases (kdb+ for kdb/kdbxsql/pykx, Parquet for duckdb/chdb/polars/pandas)
DATAFORMAT=kdb ./generateDB.sh ${NYSEBENCHMARKDIR}/${SIZE}/psv ${NYSEBENCHMARKDIR}/${SIZE}/kdb ${DATADATE}
SYMBOLSTOREDAS=ROWGROUP DATAFORMAT=parquet ./generateDB.sh ${NYSEBENCHMARKDIR}/${SIZE}/psv ${NYSEBENCHMARKDIR}/${SIZE}/parquet/rowgroup ${DATADATE}

# Step 4: run the benchmark
export NUMANODE=0
./benchmarks/inmemory/queryEngines.sh --db-dir ${NYSEBENCHMARKDIR}/${SIZE} --param-dir ./artifacts/parameters/${SIZE} --datadate ${DATADATE} --threads "4 16" --result-dir ./results/inmemory/${SIZE}

Results are written to ./results/inmemory/${SIZE}/results.psv (one row per query, as a pipe-separated values file). See Results for the column descriptions. You can also view the results in the bundled dashboard:

uv run pysrc/convertToJSFormat.py ./results/inmemory/${SIZE} ./results/inmemory/${SIZE}/data.generated.js

Two local adjustments are needed before the page shows your data — see Result Dashboard and benchmark.kx.com for details:

  • Your CPU model must appear in the machines mapping of results/mappings.yaml, otherwise the conversion stops with an explanatory error.
  • index.html ships configured for the sizes KX publishes (full, xlarge, large), so set available_sizes and default_size at the top of the file to the size you generated, e.g. ['tiny'] / 'tiny'.

Then open index.html in a browser.

Overview

This benchmark suite uses publicly available NYSE TAQ data, with queries that are representative of common financial industry workloads.

The suite provides benchmarks to:

  • Compare in-memory query engines (KDB-X, KDB-X Python, Polars, Pandas, DuckDB, and chDB).
  • Evaluate the impact of KDB-X attributes and memory layout.

Running any benchmark involves four steps:

  • Step 1: Select a data size to control how much data is downloaded and used during the benchmark.
  • Step 2: Download the compressed PSV files from the NYSE FTP server.
  • Step 3: Convert the files into kdb+ or Parquet format.
  • Step 4: Select and run a benchmark.

Step 1: Selecting a Data Size

A single day of NYSE TAQ data is substantial. To reduce execution time, you can limit ingestion to a subset of the BBO split PSV files (the source of the quote table).

Use the SIZE environment variable to balance execution time against data coverage:

export SIZE=tiny
  • In all modes except full, only a subset of the BBO split CSV files is downloaded.
  • Only the corresponding trades are converted into the HDB (for example, only symbols whose names start with Z).

The following statistics are based on data from 2026-04-01:

SIZE Symbol first letters Memory (GB) Disk (GB) Nr of quote symbols Nr of quotes
tiny Z 1 1 259 9,422,051
small X-Z 17 9 909 143,336,607
medium T-Z 70 39 4,018 588,006,863
large P-Z 142 83 8,964 1,283,196,520
xlarge I-Z 153 124 15,127 1,901,235,410
full A-Z 296 187 26,396 2,860,612,301

Use tiny when running the benchmark with KDB-X Community Edition, which enforces a memory limit.

Warning

The tiny and small sizes are not representative of the data volumes financial industry clients work with, so do not draw conclusions from their query results. These SIZE values are intended mainly for testing that the benchmark pipeline works end-to-end.

Custom sizes

You are not limited to the predefined sizes. The underlying parsers — taqToKDB.q and main.py — accept an arbitrary first-letter interval via their -letters option, e.g. C-G.

Step 2: Obtaining the PSV Files

Although you can download, decompress, and prepare the PSV files manually, we recommend using the getPSVs.sh script from the KDB-X taq module. The taq repository is included as a git submodule; initialize it with:

git submodule update --init --recursive

Set a directory for storing the PSV files. We use a DATA directory inside the repository (it is listed in .gitignore, so the large downloads and generated databases are never committed). Point NYSEBENCHMARKDIR elsewhere if you prefer to keep the data on a different (e.g. faster or larger) filesystem:

export NYSEBENCHMARKDIR=$PWD/DATA

Fetch the latest available date from the NYSE FTP server and run getPSVs.sh:

export DATADATE=$(curl -s https://ftp.nyse.com/Historical%20Data%20Samples/DAILY%20TAQ/| grep -oE 'EQY_US_ALL_TRADE_2[0-9]{7}' | grep -oE '2[0-9]{7}'|head -1)

./external/kx/taq/scripts/getPSVs.sh --csvdir ${NYSEBENCHMARKDIR}/${SIZE}/psv --dates ${DATADATE} --size ${SIZE}

The getPSVs.sh script:

  1. Downloads the compressed PSV files using curl -C (which supports resuming interrupted downloads).
  2. Decompresses the files.
  3. Removes trailing lines.
  4. Adds the correct extension (.psv).
NYSE DAILY TAQ Specification You can read the NYSE TAQ specification (of version 4.3) at https://www.nyse.com/publicdocs/nyse/data/Daily_TAQ_Client_Spec_v4.3.pdf

Step 3: Converting PSV Files to Binary Data Formats

The PSV files must be converted to a binary format that the query engines can read directly. Both kdb+ and Parquet formats are supported. Each benchmark has its own data format requirement, so example commands are only provided in Step 4.

The ./generateDB.sh script wraps the underlying TAQ parsers. Each parser has its own dependencies.

Data Types

Once the binary databases are generated (see, you can investigate the data types of a table, e.g. quote. For the Parquet data, use parquet-tools:

parquet-tools inspect ${NYSEBENCHMARKDIR}/${SIZE}/parquet/rowgroup/quote/date=${DATADATE:0:4}-${DATADATE:4:2}-${DATADATE:6:2}/part-0.parquet

For the kdb+ data:

q ${NYSEBENCHMARKDIR}/${SIZE}/kdb <<< 'meta quote'

kdb+ Parser

The kdb+ parser requires:

  • KDB-X to be installed. The benchmark relies on modules, so KDB-X is required — it does not run on kdb+ versions prior to 5.0.
  • The KDB-X taq module to be available. This module is included as a git submodule (git submodule update --init --recursive), but its dependencies must be installed manually to the standard KX module path.

Parquet Parser

The Parquet parser uses Python and the PyArrow library. Install uv to manage your Python environment. The full list of required libraries is defined in the inline script metadata in pysrc/taqToParquet/main.py.

PSV Cleanup

Exercise caution when running cleanup: downloading PSV files can be time-consuming. Delete the PSV files only when the binary data has been generated and you are sure that no other binary format will be required.

rm -rf ${NYSEBENCHMARKDIR}/${SIZE}/psv

Step 4: Selecting and Running a Benchmark

Two benchmarks are available:

  1. In-memory query engine benchmark — compares query execution time across the KDB-X, KDB-X SQL, Polars, DuckDB, chDB, Pandas, and KDB-X Python (pykx) engines.
  2. In-memory KDB-X attribute and table format comparison — evaluates the impact of attributes and table dictionary formats.

1. In-Memory Query Engine Benchmark — benchmarks/inmemory/queryEngines.sh

Query engines read data into memory from Hive-partitioned Parquet or kdb+ format. The required format depends on the engine: the KDB-X engines read kdb+ data, while the Python dataframe/SQL engines read Parquet. If you run all engines (the default), both formats must be generated.

Engine (--engines value) Description Required data format
kdb KDB-X (q-sql) kdb+
kdbxsql KDB-X SQL kdb+
pykx KDB-X Python (pykx) kdb+
duckdb DuckDB Parquet
chdb chDB (embedded ClickHouse). Three solutions: chDB (Memory) loads the Parquet files with ClickHouse's file() function into ENGINE = Memory tables, chDB (Memory, Compressed) does the same with the two big tables LZ4-compressed in memory (ENGINE = Memory SETTINGS compress = 1), chDB (PyArrow) queries Arrow tables through chDB's Python() table function Parquet
polars Polars. Two solutions, selected with the runner's -mode flag: Polars (Eager) (-mode eager) keeps the tables as DataFrames and runs every query through the eager API, Polars (Lazy) (-mode lazy) hands the queries LazyFrames and collects them with the streaming engine. Each mode has its own query file (polars.psv / polars_lazy.psv) Parquet
pandas Pandas Parquet

So you only need the kdb+ database if you restrict the run to kdb/kdbxsql/pykx (e.g. --engines kdb,kdbxsql), and only the Parquet database if you restrict it to duckdb/chdb/polars/pandas. Convert the TAQ PSV files to the format(s) you need using ./generateDB.sh:

# kdb+ format — needed for the kdb, kdbxsql, and pykx engines
DATAFORMAT=kdb ./generateDB.sh ${NYSEBENCHMARKDIR}/${SIZE}/psv ${NYSEBENCHMARKDIR}/${SIZE}/kdb ${DATADATE}
# Hive-partitioned Parquet — needed for the duckdb, chdb, polars, and pandas engines
SYMBOLSTOREDAS=ROWGROUP DATAFORMAT=parquet ./generateDB.sh ${NYSEBENCHMARKDIR}/${SIZE}/psv ${NYSEBENCHMARKDIR}/${SIZE}/parquet/rowgroup ${DATADATE}

Once the on-disk data has been generated, you can start the benchmark. Python libraries are run via uv, so ensure uv is installed. To test the engines with 0, 4, 16, and 64 secondary threads, run:

export NUMANODE=0
./benchmarks/inmemory/queryEngines.sh --db-dir ${NYSEBENCHMARKDIR}/${SIZE} --param-dir ./artifacts/parameters/${SIZE} --datadate ${DATADATE}  --threads "0 4 16 64" --result-dir ./results/inmemory/${SIZE}/$(date +%Y%m%d_%H%M)

The script accepts the following mandatory parameters:

Parameter Description
--db-dir Directory containing the generated databases. The script expects the kdb and parquet/rowgroup subdirectories created by ./generateDB.sh.
-p, --param-dir Directory of the query parameters (e.g. ./artifacts/parameters/${SIZE}).
-d, --datadate Target date to query, in the same format as ${DATADATE}.

And the following optional parameters:

Parameter Description
-t, --threads Space-separated list of secondary-thread counts to test, e.g. "0 4 16 64". Each engine runs once per value. Default: "1 4".
-e, --engines Comma-separated subset of engines to run. Valid values: kdb, kdbxsql, duckdb, polars, chdb, pykx, pandas. Default: all of them.
-s, --solutions Comma-separated subset of solutions to run, or "ALL" to run all available solutions. Solutions are named variants of engines with different attributes/indexes. Default: "KDB-X,DuckDB (Index),Polars (Lazy),Pandas". Examples: -s "KDB-X,KDB-X (Parted),Polars (Eager)" or -s "ALL".
-i, --idx Filter queries by index: single (42), comma-separated list (32,42,50), or range (40-44). Default: run all queries.
-r, --result-dir Directory to persist merged results. Default: ./results/inmemory.
-q, --query-output-dir Directory to persist query outputs. Each solution writes its results as queryoutput_<idx>.csv into a per-solution subdirectory, for cross-engine correctness checks (see Verifying Query Output Correctness). Default: outputs are not persisted.
-h, --help Show usage and exit.

The NUMANODE environment variable is also honoured: when set, every engine is launched under numactl -N ${NUMANODE} -m ${NUMANODE} to pin CPU and memory allocation to that NUMA node.

Why pin to a NUMA node for performance testing?

On multi-socket machines, each CPU has its own local memory; accessing memory attached to another CPU goes over the inter-socket interconnect. Pinning both CPU and memory allocation to a single node is recommended for two reasons:

  1. Remote memory latency — without pinning, a thread may run on one node while its data resides on another. Remote accesses have noticeably higher latency and lower bandwidth than local ones, penalising memory-bound queries.
  2. Consistency — the OS scheduler may migrate threads between nodes and allocate pages wherever space is available, so the local/remote access mix varies between runs. Pinning removes this source of run-to-run variance, making results reproducible and comparable across engines.

The downside is that the process can only allocate from that node's share of the physical memory (roughly total / number of nodes), so large SIZE values may not fit even though the machine as a whole has enough RAM.

Tip

You can easily test different versions of a library: uv resolves the dependencies of the Python query runner from the inline script metadata in pysrc/queryrunner/main.py, so pinning a version there is all it takes. For example:

#   "pykx==4.0.0",

Engine-Specific Environment Variables

Some engines read optional environment variables at runtime. export them before launching a benchmark.

Variable Engine(s) Default Description
SYMENUMBYTABLE duckdb false ENUM encoding of the sym column. When false, a single shared sym_enum (union of symbols across all three tables) is applied to master, trade and quote. When true, each table gets its own ENUM built from only that table's distinct symbols (sym_master_enum, sym_trade_enum, sym_quote_enum). Truthy values (case-insensitive): true, 1, yes.

Results

The script merges every engine's results into a single pipe-separated values (PSV) file (set by --results), one row per query (plus a few rows for the data-loading steps).

The file starts with a header row. The columns are:

Column Description
solution distinguishes runs of the same engine with different sort/index options (e.g. kdb, kdbParted).
storagebackend Where the data is read from: memory or disk.
compparam Compression parameter used for the data.
threadcount Number of (secondary/worker) threads the engine was configured to use. 0 means no secondary threads.
runner The harness driving the engine, e.g. KDB-X or Python.
engine The query engine, e.g. pykx, duckdb_con, polars, pandas.
format Data format.
indexon Columns an index/attribute was applied to, e.g. sym. Empty if none.
idx Query index. Positive integers are benchmark queries; non-positive values are setup steps: 0 = load a partition into memory, -1 = transform, -2 = sort, -3 = index.
query The query text that was executed (or a short description for setup rows).
status Outcome: success, error (query raised an exception), skip (skipped by commenting out by a # in the query string),idxfiltered (skipped by the --idx filter), tagfiltered (skipped by the --tags filter), or instrumentfiltered (skipped by the --instrument filter).
run1timeNS Execution time of run 1 (cold) in nanoseconds. Setup rows record their elapsed time here.
run2timeNS Execution time of run 2 (warm) in nanoseconds.
run3timeNS Execution time of run 3 (warm) in nanoseconds.
run3memKB Peak memory of the query of run 3 in KB.
run1ioKB Disk I/O during run 1 in KB. Should be zero for in-memory benchmarks.
run2ioKB Disk I/O during run 2 in KB. Should be zero for in-memory benchmarks.
run3ioKB Disk I/O during run 3 in KB. Should be zero for in-memory benchmarks.
ressizeKB Size of the query result in KB.

Each benchmark query is run three times (one cold run followed by two warm runs); columns are empty when a value does not apply (e.g. timing/IO columns for an error row, or warm-run columns for setup rows).

Result Dashboard and benchmark.kx.com

The raw PSV files are complete but hard to work with: with several engines, thread counts, machines and dozens of queries per run, slicing the numbers and comparing solutions in a text file (or a spreadsheet) quickly becomes tedious.

To make the results consumable, the repository ships an interactive dashboard, index.html, that you can point at your own results. It lets you slice and dice the measurements — filter by solution, thread count, machine, data size, data date, cold/hot run, query complexity, instrument scope and query tags — and shows aggregates such as the geometric mean of per-query time ratios relative to a baseline solution of your choice, so you can read off how many times faster one solution is than another.

A second page, hardware/index.html, turns the comparison around: it puts KDB-X side by side on the machines it was benchmarked on, with the same query filters and a baseline machine of your choice, so you can read off how much of a difference the hardware makes. Both pages are configuration on top of one shared dashboard engine, assets/js/benchmark.js; what differs is only the page object at the bottom of each HTML file, which says whether the compared series are the solutions or the machines.

KX also publishes its own curated results with this dashboard at benchmark.kx.com.

To use the dashboard locally, first convert your PSV results into the JavaScript format the page loads (data.generated.js) using pysrc/convertToJSFormat.py:

uv run pysrc/convertToJSFormat.py ./results/inmemory/${SIZE} ./results/inmemory/${SIZE}/data.generated.js

Your machine's CPU model must be listed in the machines mapping of results/mappings.yaml (override the path with --mappings); the script stops with an explanatory message if it is not, since the dashboard groups results by machine.

The script scans the input directory recursively for benchmark runs — any directory holding both results.psv and environment.yaml, plus the per-solution <solution>/stats.yaml files — merges the thread counts of the same (data date, machine, solution) triple, and keeps the latest measurement when runs overlap.

A solution whose run failed — the operating system killing it for exceeding the available memory on a data size that does not fit is the usual reason — never gets to run a query, so at most its load-phase rows reach results.psv. Both runners do write the solution-level part of <solution>/stats.yaml (proprietary, engineversion, sortcols) before they load any data, though, so the directory still names the solution that ran; paired with the non-zero Exit status in the /usr/bin/time -v output of its <solution>/os.txt, the script reports it as an entry with no measurement at all, carrying that status as its exitcode (every other entry gets 0). Whatever load rows it managed to write are dropped along with it: they time a load that never finished, so reporting them would rank the solution on work it did not complete. The same goes for a single thread count that loaded but ran no query while others of the same solution completed — that thread count is left out. Runs made before the runners wrote the solution-level fields up front have no stats.yaml to go on and are reported as a warning instead. The dashboard lists such a solution in the benchmark summary with a full-length grey line, its name paled out and Exit: 137 (say) in place of a ratio — so a run that failed reads as failed rather than as one that was never attempted, instead of disappearing from the comparison altogether. It takes no part in the detailed comparison or the charts, having nothing to show there.

It also refreshes artifacts/queries/inmemory/querymeta.generated.js, the fallback copy of the query metadata used when the page is opened via file:// (browsers block fetch() for local files).

You may then need to adjust the small configuration block at the top of index.html:

  • available_sizes lists the data sizes with published results, and default_size the one shown initially. KX only publishes full, xlarge and large results, so set these to the sizes you actually generated (e.g. ['tiny']).
  • The data.generated.js location is derived from the selected size as results/inmemory/<size>/data.generated.js. Change that path if you keep your generated file elsewhere.
  • hardware/index.html has the same block (loading ../results/inmemory/<size>/data.generated.js), with default_size set to the largest size benchmarked on more than one machine.

2. In-Memory KDB-X Attribute Benchmark — benchmarks/inmemory/kdbAttributes.sh

Data is read into memory from kdb+ format. Convert the TAQ PSV files to this format using ./generateDB.sh:

DATAFORMAT=kdb ./generateDB.sh ${NYSEBENCHMARKDIR}/${SIZE}/psv ${NYSEBENCHMARKDIR}/${SIZE}/kdb ${DATADATE}

Once the on-disk data has been generated, you can start the benchmark. To test with 0, 4, 16, and 64 secondary threads, run:

export NUMANODE=0
./benchmarks/inmemory/kdbAttributes.sh --db-dir ${NYSEBENCHMARKDIR}/${SIZE} --param-dir ./artifacts/parameters/${SIZE} --datadate ${DATADATE} --threads "0 4 16 64" --result-dir ./results/inmemory/${SIZE}/$(date +%Y%m%d_%H%M)

Results

The scripts write the results as pipe-separated values (PSV) files of the same format as queryEngines.sh

Limitations

No missing values. The NYSE TAQ data is clean and complete. Real-world datasets often contain null or missing values, which can significantly impact query performance — engines differ in how they represent, filter, and aggregate over nulls. This benchmark does not evaluate:

  • Query engines' null-handling performance and memory footprint
  • Cost of null checks in filters and joins
  • Performance of coalesce, fill-forward, or imputation operations
  • Sparse data scenarios common in financial time-series (e.g., sparse quote updates for inactive symbols)

If your workload involves significant null handling or sparse data, benchmark results here may not reflect real-world performance for that use case.

No nested data. Trade and quote records are flat — each row is a scalar record with no lists, maps, or nested structures in cells. kdb+'s vector processing and adverbs are particularly powerful on nested data; for example, arrays of trades per quote, or maps of custom attributes. This benchmark cannot demonstrate:

  • The performance advantage of kdb+'s functional operators on ragged or deeply nested structures
  • Memory and query efficiency of columnar storage with nested payloads
  • Cross-engine performance on complex data reshaping (e.g., grouping trades into vectors per quote)

Benchmarks over flat tables may understate kdb+'s relative performance on nested-data workloads.

Extending the Benchmarks

The suite is designed to be extended in two common ways: adding another query engine, and growing the query set. Both are described below. Whichever you do, every engine must produce the same output for every query — see Verifying Query Output Correctness.

Adding a New Python-Based In-Memory Query Engine

Python engines live in pysrc/queryrunner/executors/inmemory/. Each engine is a single class that is driven by the shared runner pysrc/queryrunner/main.py. The runner handles flushing, timing (one cold run followed by two warm runs), result writing, and PSV output; your class only has to load the data and execute queries.

Use an existing executor as a template. polars_eager.py and pandas.py read the Hive-partitioned Parquet database; pykx.py reads the kdb+ database instead.

When one engine is benchmarked in several configurations, the shared machinery lives in a base class and each variant is a thin subclass — see polars_base.py with polars_eager.py / polars_lazy_streaming.py, and chdb_base.py with chdb.py / chdb_pyarrow.py. The Polars base class implements load_resources, the stats and the CSV writer once and leaves the API-specific steps (_scan, _transform, _sort, _frame, _collect) to the subclasses, so the eager variant is DataFrames throughout while the lazy one keeps LazyFrames in the eval context and collects results with the streaming engine.

  1. Create the executor class. Implement the informal interface the runner expects (see main.py and the existing executors):

    Method Responsibility
    __init__(self, param, sort_cols, ...) Stash parameters/options and build any engine-specific lookup tables (e.g. timeBuckets).
    load_resources(self, db_path, datadate, writer, row_start, ios) Load exnames/master/trade/quote into memory, then transform, sort by sort_cols, and (optionally) index. Emit one setup row per phase via writer.writerow(row_start + [...]): idx 0 = load, -1 = transform, -2 = sort, -3 = index.
    prepare_run(self) Reset any per-run state before each of the 3 timed runs.
    get_parameters(self, parameter) Pre-process the raw parameter string into whatever execute_query expects (excluded from the measured time).
    execute_query(self, idx, tags, query_str, params, runidx) Execute the query and return the result object.
    get_table_size(df) (static) Result/table size in KB, or None if unavailable.
    get_engine_stats(self) The solution-level part of the -statsDir stats.yaml: the proprietary and engineversion (version string of the engine library) keys. Called before load_resources, so it must not depend on loaded data.
    get_table_stats(self) One stats.yaml section per table, appended after load_resources to what the pre-load write left.
    write_csv(self, res, out_file) Serialize a result to CSV for cross-engine output comparison. The CSV must be in kdb+-loadable format, so values need special formatting: booleans as 1/0 (not true/false), and temporal values as kdb+ literals (e.g. timespans like 0D09:30:00.000000000). See the write_csv implementations in polars_base.py and pandas.py for the duration/boolean conversions.
  2. Wire it into the runner. In main.py, add an elif engine == "<name>": branch inside the inmemory block that imports and instantiates your class as runner and sets threadnr. Also add "<name>" to the -engine argument's choices list in build_parser.

  3. Declare dependencies. Add any new library to the inline script metadata (the PEP 723 # /// script block at the top of main.py) so uv run installs it.

  4. Add a query file. Create artifacts/queries/inmemory/<name>.psv with the queries written in your engine's syntax. It must stay index-aligned with querymeta.psv — see Extending the Query Set.

  5. Add it to the driver. In benchmarks/inmemory/queryEngines.sh, add an engine_enabled <name> block that calls uv run pysrc/queryrunner/main.py ... -engine <name> -queryfile ./artifacts/queries/inmemory/<name>.psv ... followed by add_solution_name, and add <name> to the default ENGINES list. Optionally add a matching run in get_table_stats. Each engine is launched once per requested thread count; if the library is configured through an environment variable, set it inline as the existing engines do (e.g. POLARS_MAX_THREADS, DUCKDB_THREADS, OMP_NUM_THREADS).

  6. Test your solution. You don't need to download real TAQ data: small test PSV files ship with the TAQ submodule in external/kx/taq/test/data/ (fetch the submodule first). The scripts in the test/ directory use them — test/inmemory.sh generates a smaller than tiny kdb+ and Parquet database from the test PSVs and runs both benchmark scripts against it end-to-end. Run it after wiring in your engine to verify the whole pipeline; then check your engine's query outputs against an existing engine with a --query-output-dir run and src/compareOutput.q (see Verifying Query Output Correctness).

Extending the Query Set with New Queries

Queries are defined per engine in PSV files under artifacts/queries/inmemory/ (kdb.psv, sql.psv, duckdb.psv, chdb.psv, polars.psv, polars_lazy.psv, pandas.psv, pykx.psv, and the attribute-benchmark variants kdb_noattr.psv, kdb_tabledict.psv). A single engine can have more than one query file when it is benchmarked in several configurations: polars.psv holds the eager-API queries and polars_lazy.psv the same queries written against LazyFrames — identical except that the six pivot queries have to collect() first, since pivot has no lazy equivalent. Each file has the columns:

Column Meaning
idx Query index. Must be identical, row for row, across every query file and querymeta.psv.
tags Optional engine-specific extra tags (usually empty).
query The query text in that engine's syntax.
parameter Comma-separated names of parameters injected into the query (e.g. datadate, aFreqInstr, twentyInstrs, timeBuckets). Empty if the query takes none.

Engine-independent metadata lives in artifacts/queries/inmemory/querymeta.psv (idx|tags|instrument|complexity|description|sortby|comment). The complexity column rates how involved the query logic is: simple, advanced, or complex.

The instrument column is mandatory and states how many instruments the query works on: single, multi, or all (no instrument filter). Each single and multi query appears twice, split into variants:

  • single-instrument queries by instrument frequency — single:infrequent and single:frequent (using the infreqInstr and freqInstr parameters);
  • multi-instrument queries by instrument-set size — multi:50 and multi:1000infreq (using the fiftyInstrs and thousandInfreqInstrs parameters).

Both runners accept an optional -instrument parameter that runs only the queries with that scope. A base scope like single or multi also matches its variants, or you can select one exactly with e.g. single:frequent or multi:50 (others are reported as instrumentfiltered).

At runtime the runners join each query to its meta row by idx and abort on any index mismatch between a query file and querymeta.psv or on a missing/invalid instrument value (see the checks in main.py and src/runQueries.q). Consequently, every query you add must appear — at the same row position and with the same index — in all engine files you want to benchmark and in querymeta.psv.

Parameter names in the parameter column are resolved from the per-size files in artifacts/parameters/${SIZE}/*.txt. To introduce a brand-new parameter, add its .txt file to every size directory and load it in both load_parameters (main.py) and src/getQueryParameters.q.

Appending a query (no existing indices change):

  1. Add a row with the next free idx to each engine query file, expressing the same logical query in that engine's syntax.
  2. Add a matching row (same idx) to querymeta.psv with a description, instrument and complexity values, and tags.

Inserting a query in the middle (existing indices must shift): because indices are sequential, inserting renumbers every query after the insertion point. Rather than renumbering by hand, use artifacts/queries/reindex.sh:

  1. Insert the new row at the same position in each query file and in querymeta.psv (the idx value can be left inconsistent for now).
  2. Renumber the idx column of every affected file to 1, 2, 3, … based on row order:
    ./artifacts/queries/reindex.sh artifacts/queries/inmemory/*.psv
    The script rewrites each PSV in place (preserving the header) and numbers purely by row position, so indices stay aligned across files as long as the inserted row sits at the same position in each. Commit or back up first, and pass only the query/meta PSVs — not result files.

Verifying Query Output Correctness

A benchmark is only meaningful if every engine computes the same result for each query. This is a hard requirement: a query added to a new engine must return output equivalent to the existing engines (same rows, columns, and values), so that timings compare like for like. For integer and categorical/enum columns (symbols, dates, times, etc.) equivalence is exact — any difference, in even a single cell, fails the verification. Floating-point columns are the tricky exception: engines may legitimately differ in the last bits due to summation order and intermediate precision, so they are compared within a small tolerance (FLOATDIFFTHREASHOLD, see below) rather than bit-for-bit.

To check this, persist each engine's query outputs and compare them:

  1. Persist the outputs. Both driver scripts (queryEngines.sh and kdbAttributes.sh) accept -q, --query-output-dir <dir>. When given, each solution writes its results as queryoutput_<idx>.csv into a per-solution subdirectory of <dir>. The CSVs are in kdb+-loadable format (see the write_csv requirement in Adding a New Engine).

    ./benchmarks/inmemory/queryEngines.sh --db-dir ... --param-dir ... --datadate ... \
        --query-output-dir ./results/inmemory/output
  2. Compare two engines. Point src/compareOutput.q at the two per-engine output directories. For every query in the metadata file it checks row count, column count, column names, and then compares content cell-by-cell, logging the first mismatch per column. Integer and categorical/enum columns must match exactly — any difference is a failure. Only floats get slack: they compare within FLOATDIFFTHREASHOLD (and char columns via like), since floating-point results can drift slightly across engines:

    q src/compareOutput.q -querymeta ./artifacts/queries/inmemory/querymeta.psv \
        -queryoutput1 ./results/inmemory/output/KDB-X \
        -queryoutput2 ./results/inmemory/output/Polars_Eager_

    The subdirectory is named after the solution, with every character outside [a-zA-Z0-9._-] replaced by _ — so DuckDB (Index) becomes DuckDB_Index_ and Polars (Lazy) becomes Polars_Lazy_.

    It exits 0 when every query matches; otherwise it logs the differences and continues per query. Pass -idx to restrict the comparison to specific query indices — single (42), list (32,42,50) or range (40-44) — and -debug to keep the process alive after comparison for investigation of differences.

About

No description, website, or topics provided.

Resources

Stars

12 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages