From b4a862d95ae20dcad01aeffa8d5e1cf794172e22 Mon Sep 17 00:00:00 2001 From: Dan Gallagher Date: Tue, 30 Jan 2024 06:59:51 -0500 Subject: [PATCH] reference prebuilt dynamic libraries in readme --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f1d6721..39bba82 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,10 @@ Stanchion is an ideal fit for analytical queries and wide tables because it only ## Example +Download the prebuilt dynamic library for your platform or [build from source](#Build). + ```sql -.load ./stanchion +.load /path/to/libstanchion CREATE VIRTUAL TABLE dnd_monsters USING stanchion ( @@ -58,8 +60,6 @@ zig build ext -Doptimize=ReleaseFast The SQLite extension is the dynamic library named `libstanchion` in the `zig-out` directory. -Building from source is currently the only way to use stanchion. - ## Usage ### Load Stanchion @@ -144,7 +144,7 @@ In Stanchion, the order of the records in the table (aka the clustered index) is This differs from SQLite where tables are sorted by the `ROWID` by default or by the `PRIMARY KEY` if the table is a `WITHOUT ROWID` table. -### No uniqueness (`UNIQUE` or `PRIMARY KEY`) or foreign key constraints +### No uniqueness (`UNIQUE` or `PRIMARY KEY`) or foreign key constraints This may change in the future. Implementing these will likely require external indexes. When/if a `PRIMARY KEY` is introduced, it will likley make sense to follow the lead of Clickhouse's `MergeTree` engine and require that the `PRIMARY KEY` [must be a prefix](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#choosing-a-primary-key-that-differs-from-the-sorting-key) of the `SORT KEY`. @@ -185,4 +185,3 @@ When a query filters on sort key columns, Stanchion applies that filter to the p ### Row group index The row group index is a native, row-oriented SQLite table that indexes the row groups by the starting (min) sort key of each row group. When a query filters on sort key columns, Stanchion applies that filter to the primary index to restrict which row groups are accessed. Filtering by sort key is the only indexing mechanism currently supported by Stanchion. -