Skip to main content

Session.add_external_table(external_table, /, table_name=None, *, columns=frozendict({}), config=None)

Add a table from an external database to the session.
  • Parameters:
    • external_table (ExternalTable *[*ExternalDatabaseConnectionConfigT ]) – The external database table from which to build the session table. Instances of such tables are obtained through an external database connection.
    • table_name (str | None) – The name to give to the table in the session. If None, the name of the external table is used.
    • columns (Mapping [str , str ]) – Mapping from external column names to local column names. If empty, the local columns will share the names of the external columns.
    • config (ExternalTableConfig *[*ExternalDatabaseConnectionConfigT ] | None) – The config to add the external table. Each DirectQuery plugin has its own TableConfig class.
  • Return type: Table

Example

Add the external table, filtering out some columns and renaming the remaining ones: