airbyte-lib cache / sync result digram

mermaid.chart

---
title: airbyte_lib
---
classDiagram
    VenvExecutor <|-- Executor
    PathExecutor <|-- Executor
    class Executor{
        +execute(args: List[str]) IO[str]
        +ensure_installation()
        +ConnectorMetadata connector
    }
    Executor --> ConnectorMetadata
    class ConnectorMetadata{
        +name
        +version
    }
    Source --> Executor
    class Source{
        +install()
        +uninstall()
        +get_available_streams() List[str]
        +set_config(config)
        +check()
        +read(selected_streams: List[str], cache?: Cache, full_refresh?: bool) ReadResult
        +get_records(stream: str) LazyDataset

    }

    class Cache{
        +get_sql_engine() sqlalchemy.Engine
        +get_records(stream: str) CachedDataset
        +streams: Dict[str, CachedDataset]
    }

    Cache --> CachedDataset

    class ReadResult{
        -streams: Dict[str, CachedDataset]
        +cache: Cache
        +success: bool
        +records_synced: int
        +get_records(stream: str) CachedDataset
        +get_new_records(stream: str) LazyDataset
    }

    ReadResult --> CachedDataset
    ReadResult --> Cache

    class CachedDataset{
        +get_sql_table() sqlalchemy.Table
    }

    class LazyDataset{
        
    }

    class Dataset{
        +__iter__() Iterable[Dict[str, Any]]
        +to_pandas() pandas.DataFrame
    }

    CachedDataset <|-- Dataset
    LazyDataset <|-- Dataset