diff --git a/docs/generated/airbyte.html b/docs/generated/airbyte.html index 2c5ba3eb..5ad45f6e 100644 --- a/docs/generated/airbyte.html +++ b/docs/generated/airbyte.html @@ -2,14 +2,14 @@
- + class CachedDataset(airbyte.datasets._sql.SQLDataset): - +
- +

A dataset backed by a SQL table cache.

Because this dataset includes all records from the underlying table, we also expose the @@ -19,14 +19,14 @@

- + CachedDataset(cache: 'SQLCacheBase', stream_name: str) - +
- - + +
@@ -36,10 +36,10 @@ def to_pandas(self) -> pandas.core.frame.DataFrame: - +
- +

Return a pandas DataFrame representation of the dataset.

The base implementation simply passes the record iterator to Panda's DataFrame constructor.

@@ -49,15 +49,15 @@
- + def to_sql_table(self) -> 'Table': - +
- - + +
@@ -73,14 +73,14 @@
Inherited Members
- + class DuckDBCache(airbyte.caches.duckdb.DuckDBCacheBase): - +
- +

A DuckDB implementation of the cache.

Parquet is used for local file storage before bulk loading. @@ -94,11 +94,11 @@

Inherited Members
file_writer_class = <class 'airbyte._file_writers.parquet.ParquetWriter'> - +
- - + +
@@ -143,14 +143,14 @@
Inherited Members
- + class DuckDBCacheConfig(airbyte.caches.base.SQLCacheConfigBase, airbyte._file_writers.parquet.ParquetWriterConfig): - +
- +

Configuration for the DuckDB cache.

Also inherits config from the ParquetWriter, which is responsible for writing files to disk.

@@ -161,10 +161,10 @@
Inherited Members
db_path: pathlib.Path | str - +
- +

Normally db_path is a Path object.

There are some cases, such as when connecting to MotherDuck, where it could be a string that @@ -177,10 +177,10 @@

Inherited Members
schema_name: str - +
- +

The name of the schema to write to. Defaults to "main".

@@ -193,10 +193,10 @@
Inherited Members
def get_sql_alchemy_url(self) -> str: - +
- +

Return the SQLAlchemy URL to use.

@@ -204,14 +204,14 @@
Inherited Members
- + def get_database_name(self) -> str: - +
- +

Return the name of the database.

@@ -252,14 +252,14 @@
Inherited Members
- + def get_available_connectors() -> list[str]: - +
- +

Return a list of all available connectors.

Connectors will be returned in alphabetical order, with the standard prefix "source-".

@@ -269,14 +269,14 @@
Inherited Members
- + def get_source( name: str, config: dict[str, typing.Any] | None = None, *, version: str | None = None, pip_url: str | None = None, local_executable: pathlib.Path | str | None = None, install_if_missing: bool = True) -> Source: - +
- +

Get a connector by name and version.

Args: @@ -299,14 +299,14 @@

Inherited Members
- + def get_default_cache() -> DuckDBCache: - +
- +

Get a local cache for storing data, using the default database path.

Cache files are stored in the .cache directory, relative to the current @@ -317,14 +317,14 @@

Inherited Members
- + def get_secret( secret_name: str, source: SecretSource | list[SecretSource] = <SecretSource.ANY: 4>, *, prompt: bool = True) -> str: - +
- +

Get a secret from the environment.

The optional source argument of enum type SecretSource or list of SecretSource options. @@ -340,14 +340,14 @@

Inherited Members
- + def new_local_cache( cache_name: str | None = None, cache_dir: str | pathlib.Path | None = None, *, cleanup: bool = True) -> DuckDBCache: - +
- +

Get a local cache for storing data, using a name string to seed the path.

Args: @@ -363,14 +363,14 @@

Inherited Members
- + class ReadResult(collections.abc.Mapping[str, airbyte.datasets._sql.CachedDataset]): - +
- +

A Mapping is a generic container for associating key/value pairs.

@@ -381,60 +381,60 @@
Inherited Members
- + ReadResult( processed_records: int, cache: airbyte.caches.base.SQLCacheBase, processed_streams: list[str]) - +
- - + +
processed_records - +
- - + +
- + def get_sql_engine(self) -> sqlalchemy.engine.base.Engine: - +
- - + +
streams: collections.abc.Mapping[str, CachedDataset] - +
- - + +
cache: airbyte.caches.base.SQLCacheBase - +
- - + +
@@ -452,14 +452,14 @@
Inherited Members
- + class SecretSource(enum.Enum): - +
- +

An enumeration.

@@ -469,11 +469,11 @@
Inherited Members
ENV = <SecretSource.ENV: 1> - + - - + +
@@ -481,11 +481,11 @@
Inherited Members
DOTENV = <SecretSource.DOTENV: 2> - +
- - + +
@@ -493,11 +493,11 @@
Inherited Members
GOOGLE_COLAB = <SecretSource.GOOGLE_COLAB: 3> - +
- - + +
@@ -505,11 +505,11 @@
Inherited Members
ANY = <SecretSource.ANY: 4> - +
- - + +
@@ -517,11 +517,11 @@
Inherited Members
PROMPT = <SecretSource.PROMPT: 5> - +
- - + +
@@ -537,27 +537,27 @@
Inherited Members
- + class Source: - +
- +

A class representing a source that can be called.

- + Source( executor: airbyte._executor.Executor, name: str, config: dict[str, typing.Any] | None = None, streams: list[str] | None = None, *, validate: bool = False) - +
- +

Initialize the source.

If config is provided, it will be validated against the spec if validate is True.

@@ -569,34 +569,34 @@
Inherited Members
executor - +
- - + +
name - +
- - + +
- + def set_streams(self, streams: list[str]) -> None: - +
- +

Deprecated. See select_streams().

@@ -604,14 +604,14 @@
Inherited Members
- + def select_all_streams(self) -> None: - +
- +

Select all streams.

This is a more streamlined equivalent to:

@@ -625,14 +625,14 @@
Inherited Members
- + def select_streams(self, streams: list[str]) -> None: - +
- +

Select the stream names that should be read from the connector.

Currently, if this is not set, all streams will be read.

@@ -642,14 +642,14 @@
Inherited Members
- + def get_selected_streams(self) -> list[str]: - +
- +

Get the selected streams.

If no streams are selected, return an empty list.

@@ -659,14 +659,14 @@
Inherited Members
- + def set_config(self, config: dict[str, typing.Any], *, validate: bool = False) -> None: - +
- +

Set the config for the connector.

If validate is True, raise an exception if the config fails validation.

@@ -679,14 +679,14 @@
Inherited Members
- + def get_config(self) -> dict[str, typing.Any]: - +
- +

Get the config for the connector.

@@ -694,14 +694,14 @@
Inherited Members
- + def validate_config(self, config: dict[str, typing.Any] | None = None) -> None: - +
- +

Validate the config against the spec.

If config is not provided, the already-set config will be validated.

@@ -711,14 +711,14 @@
Inherited Members
- + def get_available_streams(self) -> list[str]: - +
- +

Get the available streams from the spec.

@@ -728,10 +728,10 @@
Inherited Members
docs_url: str - +
- +

Get the URL to the connector's documentation.

@@ -741,10 +741,10 @@
Inherited Members
discovered_catalog: airbyte_protocol.models.airbyte_protocol.AirbyteCatalog - +
- +

Get the raw catalog for the given streams.

If the catalog is not yet known, we call discover to get it.

@@ -756,10 +756,10 @@
Inherited Members
configured_catalog: airbyte_protocol.models.airbyte_protocol.ConfiguredAirbyteCatalog - +
- +

Get the configured catalog for the given streams.

If the raw catalog is not yet known, we call discover to get it.

@@ -775,14 +775,14 @@
Inherited Members
- + def get_records(self, stream: str) -> airbyte.datasets._lazy.LazyDataset: - +
- +

Read a stream from the connector.

This involves the following steps:

@@ -801,14 +801,14 @@
Inherited Members
- + def check(self) -> None: - +
- +

Call check on the connector.

This involves the following steps:

@@ -825,14 +825,14 @@
Inherited Members
- + def install(self) -> None: - +
- +

Install the connector if it is not yet installed.

@@ -840,14 +840,14 @@
Inherited Members
- + def uninstall(self) -> None: - +
- +

Uninstall the connector if it is installed.

This only works if the use_local_install flag wasn't used and installation is managed by @@ -858,14 +858,14 @@

Inherited Members
- + def read( self, cache: airbyte.caches.base.SQLCacheBase | None = None, *, write_strategy: str | airbyte.strategies.WriteStrategy = <WriteStrategy.AUTO: 'auto'>, force_full_refresh: bool = False) -> ReadResult: - +
- +

Read from the connector and write to the cache.

Args: @@ -886,4 +886,4 @@

Inherited Members
- + \ No newline at end of file