Skip to main content
Session.add_external_table(
    external_table: ExternalTable[ExternalDatabaseConnectionConfigT],
    /,
    table_name: str | None = None,
    *,
    columns: Mapping[str, str] = frozendict({}),
    config: ExternalTableConfig[ExternalDatabaseConnectionConfigT] | None = None,
) → Table
Add a table from an external database to the session.

Parameters

external_table

The external database table from which to build the session table. Instances of such tables are obtained through an external database connection.

table_name

The name to give to the table in the session. If None, the name of the external table is used.

columns

Mapping from external column names to local column names. If empty, the local columns will share the names of the external columns.

config

The config to add the external table. Each DirectQuery plugin has its own TableConfig class.
Add the external table, filtering out some columns and renaming the remaining ones: