Skip to main content

Module airbyte.caches.duckdb

A DuckDB implementation of the PyAirbyte cache.

Usage Example​

from airbyte as ab
from airbyte.caches import DuckDBCache

cache = DuckDBCache(
    db_path="/path/to/my/duckdb-file",
    schema_name="myschema",
)

Classes​

DuckDBCache(**data: Any) : A DuckDB cache.

Initialize the cache and backends.

Ancestors (in MRO)​

  • airbyte._processors.sql.duckdb.DuckDBConfig
  • airbyte.caches.base.CacheBase
  • airbyte.shared.sql_processor.SqlConfig
  • pydantic.main.BaseModel
  • airbyte._writers.base.AirbyteWriterInterface
  • abc.ABC

Descendants​

  • airbyte.caches.motherduck.MotherDuckCache

Class variables​

model_config :

paired_destination_config_class: ClassVar[type | None] : DestinationDuckdb(destination_path: 'str', DESTINATION_TYPE: 'Final[Duckdb]' = <Duckdb.DUCKDB: 'duckdb'>, motherduck_api_key: 'Optional[str]' = None, schema: 'Optional[str]' = None)

paired_destination_name: ClassVar[str | None] :

DuckDBConfig(**data: Any) : Configuration for DuckDB.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors (in MRO)​

  • airbyte.shared.sql_processor.SqlConfig
  • pydantic.main.BaseModel
  • abc.ABC

Descendants​

  • airbyte.caches.duckdb.DuckDBCache
  • airbyte.caches.motherduck.MotherDuckConfig

Class variables​

db_path: Path | str : Normally db_path is a Path object.

The database name will be inferred from the file name. For example, given a db_path of /path/to/my/duckdb-file, the database name is my_db.

model_config :

Methods​

get_sql_alchemy_url(self) ‑> airbyte.secrets.base.SecretString : Return the SQLAlchemy URL to use.

get_sql_engine(self) ‑> Engine : Return the SQL Alchemy engine.

This method is overridden to ensure that the database parent directory is created if it doesn't exist.

Was this page helpful?