Skip to content

etl

Functions:

  • extract_transform_load –

    Workflow for (1) extracting, transforming, and loading the Heurist database architecture into a DuckDB database and (2) extracting, transforming, and loading record types' records into the created DuckDB database.

extract_transform_load 

extract_transform_load(
    client: HeuristAPIConnection,
    duckdb_connection: DuckDBPyConnection,
    user: tuple = (),
    record_group_names: tuple = DEFAULT_RECORD_GROUPS,
) -> None

Workflow for (1) extracting, transforming, and loading the Heurist database architecture into a DuckDB database and (2) extracting, transforming, and loading record types' records into the created DuckDB database.

Parameters:

  • client

    (HeuristAPIConnection) –

    Context of a Heurist API connection.

  • duckdb_connection

    (DuckDBPyConnection) –

    Connection to a DuckDB database.

  • user

    (tuple, default: () ) –

    IDs (integers) of targeted users.

  • record_group_names

    (tuple, default: DEFAULT_RECORD_GROUPS ) –

    Names of the record group types. Must include at least 1. Defaults to ("My record types").

Returns:

  • None –

    duckdb.DuckDBPyConnection: Open connection to the created DuckDB database.