History

Paul Dix 40cac21e21 refactor: change all ids in catalog to their own types		2022-01-18 12:42:10 -05:00
..
migrations	fix: query pool type and sequencer create	2022-01-17 10:00:33 -05:00
src	refactor: change all ids in catalog to their own types	2022-01-18 12:42:10 -05:00
Cargo.toml	fix: workspace hack after adding iox_catalog crate	2022-01-17 10:04:24 -05:00
README.md	feat: iox_catalog sequencers (#3465 )	2022-01-17 10:00:31 -05:00

README.md

IOx Catalog

This crate contains the code for the IOx Catalog. This includes the definitions of namespaces, their tables, the columns of those tables and their types, what Parquet files are in object storage and delete tombstones. There's also some configuration information that the overal distributed system uses for operation.

To run this crate's tests you'll need Postgres installed and running locally. You'll also need to set the DATABASE_URL environment variable so that sqlx will be able to connect to your local DB. For example with user and password filled in:

DATABASE_URL=postgres://<postgres user>:<postgres password>@localhost/iox_shared

You'll then need to create the database and run the migrations. You can do this via the sqlx command line.

cargo install sqlx-cli
sqlx database create
sqlx migrate run

This will set up the database based on the files in ./migrations in this crate. SQLx also creates a table to keep track of which migrations have been run.

Tests

To run the Postgres integration tests, ensure the above setup is complete first.

Set DATABASE_URL=<dsn> env (see above)
Set TEST_INTEGRATION=1
Run cargo test

CAUTION: existing data in the database is dropped when tests are run