Directories
¶
| Path | Synopsis |
|---|---|
|
Package api is brevis-sql-api as a library: the command, with the hooks a binary of your own registers.
|
Package api is brevis-sql-api as a library: the command, with the hooks a binary of your own registers. |
|
cmd
|
|
|
brevis-sql
command
brevis-sql turns plain `.sql` files into tables and views, in dependency order, as an ordinary Brevis step.
|
brevis-sql turns plain `.sql` files into tables and views, in dependency order, as an ordinary Brevis step. |
|
brevis-sql-api
command
brevis-sql-api: declared, read-only SQL served over HTTP.
|
brevis-sql-api: declared, read-only SQL served over HTTP. |
|
A brevis-sql-api with hooks: register what this binary knows, hand it the file.
|
A brevis-sql-api with hooks: register what this binary knows, hand it the file. |
|
internal
|
|
|
api
Package api is `brevis-sql-api`: declared, read-only SQL served over HTTP.
|
Package api is `brevis-sql-api`: declared, read-only SQL served over HTTP. |
|
api/cache
Package cache holds an endpoint's answers, compressed, until a model they read is rebuilt.
|
Package cache holds an endpoint's answers, compressed, until a model they read is rebuilt. |
|
api/render
Package render turns an endpoint's SQL template into a statement and its arguments, and never writes a caller's value into the statement.
|
Package render turns an endpoint's SQL template into a statement and its arguments, and never writes a caller's value into the statement. |
|
check
Package check turns a model's `tests:` into SQL.
|
Package check turns a model's `tests:` into SQL. |
|
connections
Package connections is the warehouses Brevis may reach, declared once.
|
Package connections is the warehouses Brevis may reach, declared once. |
|
dialect
Package dialect is the part of building a model that differs per warehouse.
|
Package dialect is the part of building a model that differs per warehouse. |
|
dialect/bigquery
Package bigquery builds models on Google BigQuery.
|
Package bigquery builds models on Google BigQuery. |
|
dialect/dialecttest
Package dialecttest is the suite every dialect has to pass.
|
Package dialecttest is the suite every dialect has to pass. |
|
dialect/dialecttest/leakprobe
command
Command leakprobe is the other half of `scripts/leak-check.sh`: a harness that never cleans up, and the questions you ask BigQuery afterwards.
|
Command leakprobe is the other half of `scripts/leak-check.sh`: a harness that never cleans up, and the questions you ask BigQuery afterwards. |
|
dialect/postgres
Package postgres builds models on PostgreSQL.
|
Package postgres builds models on PostgreSQL. |
|
generation
Package generation is what `brevis-sql build` writes when a model is rebuilt, and what `brevis-sql-api` reads to know its cached answers are stale -- through a Redis client of its own, written against RESP2.
|
Package generation is what `brevis-sql build` writes when a model is rebuilt, and what `brevis-sql-api` reads to know its cached answers are stale -- through a Redis client of its own, written against RESP2. |
|
model
Package model reads one `.sql` file as a model: a header, a query, and the name the two of them make.
|
Package model reads one `.sql` file as a model: a header, a query, and the name the two of them make. |
|
project
Package project reads a directory of models and works out the order.
|
Package project reads a directory of models and works out the order. |
|
refs
Package refs answers one question about a query: which relations does it READ.
|
Package refs answers one question about a query: which relations does it READ. |
|
run
Package run builds a project's models against a warehouse.
|
Package run builds a project's models against a warehouse. |
|
serve
Package serve answers read-only questions about a warehouse, over HTTP, so the console never holds a warehouse credential.
|
Package serve answers read-only questions about a warehouse, over HTTP, so the console never holds a warehouse credential. |
|
sqltok
Package sqltok splits SQL into tokens and does nothing else with them.
|
Package sqltok splits SQL into tokens and does nothing else with them. |
Click to show internal directories.
Click to hide internal directories.