Skip to main content

Module init

Module init 

Source
Expand description

BIRD initialization - creates directory structure and database.

§Schema Architecture

BIRD uses a multi-schema architecture for flexible data organization:

§Data Schemas (contain actual tables)

  • local - Locally generated data (tables in DuckDB mode, parquet views in parquet mode)
  • cached_<name> - One per remote, contains data pulled/synced from that remote
  • cached_placeholder - Empty tables (ensures caches views work with no cached data)

§Attached Schemas (live remote connections)

  • remote_<name> - Attached remote databases (read-only)
  • remote_placeholder - Empty tables (ensures remotes views work with no remotes)

§Union Schemas (dynamic views)

  • caches - Union of all cached_* schemas
  • remotes - Union of all remote_* schemas
  • main - Union of local + caches (all data we own locally)
  • unified - Union of main + remotes (everything)
  • cwd - Views filtered to current working directory

§Reserved Schema Names

  • local, main, unified, cwd, caches, remotes - Core schemas
  • cached_* - Reserved prefix for cached remote data
  • remote_* - Reserved prefix for attached remotes
  • project - Reserved for attached project-level database

Constants§

DEFAULT_EVENT_FORMATS_CONFIG
Default content for event-formats.toml.

Functions§

initialize
Initialize a new BIRD installation.
is_initialized
Check if BIRD is initialized at the given location.