FFQ (FastFlowQuery) — Workspace Skeleton

This is a v1 repo skeleton with feature-gated optional components:

• distributed (gRPC coordinator/worker)
• vector (vector datatype + similarity kernels)
• qdrant (vector connector)
• s3 (object-store provider)

By default, cargo build builds the lightweight ffq-client crate (embedded-only).

Quick Start

For a practical step-by-step v1 run guide (embedded, distributed, synthetic and official benchmarks):

1. docs/v1/quickstart.md

Quick REPL start:

cargo run -p ffq-client -- repl --catalog tests/fixtures/catalog/tpch_dbgen_sf1_parquet.tables.json

Then run:

SELECT l_orderkey, l_quantity FROM lineitem LIMIT 5;

Full REPL reference:

1. docs/v1/repl.md

For a concept-first deep guide (architecture, optimizer, distributed control plane, labs, glossary, FAQ):

1. docs/learn/README.md

Environment

• Copy .env.example to .env for local overrides.
• ffq-client loads .env automatically (best-effort) on session creation.
• For distributed mode, set FFQ_COORDINATOR_ENDPOINT, e.g. http://127.0.0.1:50051.

License

Licensed under the Apache License, Version 2.0. See LICENSE.