setup

etl_craft.services.setup

setup: check a configuration, then create or bring up to date the Engine DB.

Setup first runs doctor's checks, apart from the Engine DB's tables and migrations, which it is about to create. If any check fails it stops with nothing changed: every connection the engine uses must work before it builds anything. Otherwise it creates the Engine DB tables in a database that has none, then applies the migrations still pending, packaged and the project's own. On an Engine DB that is up to date it changes nothing, so it can be run again safely.

Setup creates nothing outside the Engine DB's own tables: the Engine DB schema, the warehouse database and schema, and the email relay must already exist.

SetupResult dataclass

What setup checked, and what it did once the checks passed.

failed property

failed: bool

Whether a check failed, so nothing was changed.

setup

setup(config: ConnectorConfig) -> SetupResult

Check the configuration; when nothing fails, create and migrate the Engine DB.