The catalog file
federiq.yaml declares your data sources and (optionally) your
policies. Initialize one with:
federiq init
Structure
sources:
- name: <alias>
type: <source-type>
# ... type-specific keys ...
policies:
- name: <policy-name>
applies_to: <source-alias or "*">
# ... policy keys ...
Source types
type: | Required keys | Notes |
|---|---|---|
postgres | dsn | DuckDB postgres_scanner extension |
mysql | dsn | DuckDB mysql_scanner extension |
sqlite | path | Local SQLite database file |
parquet | path | Single file, directory, or glob |
csv | path | read_csv_auto for schema inference |
http | url | JSON response, default feature |
mongo | uri, database, collection | Planned; blocked on upstream |
Managing sources from the CLI
federiq sources list
federiq sources add --name events --type parquet --path ./data/events.parquet
federiq sources remove events
federiq sources test events
federiq sources describe events
Inspecting schemas
federiq schema list # every source
federiq schema list events # one source
federiq schema describe events # columns of a single table or view
Validating
federiq config validate
federiq doctor