BaseSQLSource type: None#

class lumen.sources.base.BaseSQLSource(*, load_schema, cache_dir, cache_per_query, cache_with_dask, root, shared, name)#: The BaseSQLSource implements the additional API required by a SQL based data source.

Parameters#

load_schema

type: bool
default: True
Whether to load the schema

BaseSQLSource.create_sql_expr_source(tables: dict[str, str], **kwargs)#: Creates a new SQL Source given a set of table names and corresponding SQL expressions.

BaseSQLSource.execute(sql_query: str) → DataFrame#

Executes a SQL query and returns the result as a DataFrame.

BaseSQLSource.get(table: str, **query) → DataFrame#

Return a table; optionally filtered by the given query.

Parameters:

Returns:

A DataFrame containing the queried table.

Return type:

DataFrame

BaseSQLSource.get_schema(table: str | None = None, limit: int | None = None) → dict[str, dict[str, Any]] | dict[str, Any]#

Returns JSON schema describing the tables returned by the Source.

Parameters:

table (str | None) – The name of the table to return the schema for. If None returns schema for all available tables.
limit (int | None) – Limits the number of rows considered for the schema calculation

Returns:

JSON schema(s) for one or all the tables.

Return type:

dict

BaseSQLSource.get_sql_expr(table: str)#: Returns the SQL expression corresponding to a particular table.

BaseSQLSource.get_tables() → list[str]#

Returns the list of tables available on this source.

BaseSQLSource.normalize_table(table: str) → str#: Allows implementing table name normalization to allow fuzze matching of the table name for minor variations such as quoting differences.

BaseSQLSource.to_spec(context: dict[str, Any] | None = None) → dict[str, Any]#

Exports the full specification to reconstruct this component.