pyfivetran.endpoints.schema

Module Contents

Classes

ConnectorSchemaEndpoint

API

class pyfivetran.endpoints.schema.ConnectorSchemaEndpoint(client: pyfivetran.endpoints.base.Client)[source]

Bases: pyfivetran.endpoints.base.Endpoint

BASE_URL: str = None
modify_connector_column_config(connector_id: str, schema_name: str, table_name: str, column_name: str, enabled: Optional[bool] = None, hashed: Optional[bool] = None) → pyfivetran.shed.GeneralApiResponse[source]

Modifies the column configuration for a specific connector.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • schema_name – The schema name within the Fivetran system

  • table_name – The table name within the Fivetran system

  • column_name – The column name within the Fivetran system

  • enabled – Whether the column is enabled

  • hashed – Whether the column is hashed

Returns:

GeneralApiResponse

modify_connector_database_schema_config(connector_id: str, schema_name: str, enabled: Optional[bool] = None, tables: Optional[Dict[Any, Any]] = None) → pyfivetran.shed.GeneralApiResponse[source]

Modify connector database schema config.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • schema_name – The schema name within the Fivetran system

  • enabled – Whether the schema is enabled

  • tables – The tables within the schema

Returns:

GeneralApiResponse

modify_connector_schema_config(connector_id: str, schemas: Optional[Dict[Any, Any]] = None, schema_change_handling: Optional[Literal[ALLOW_ALL, ALLOW_COLUMNS, BLOCK_ALL]] = None) → pyfivetran.shed.GeneralApiResponse[source]

Updates the schema configuration for a specific connector.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • schemas – The schemas within the Fivetran system

  • schema_change_handling – The schema change handling

Returns:

GeneralApiResponse

modify_table_config(connector_id: str, schema_name: str, table_name: str, enabled: Optional[bool] = None, columns: Optional[Dict[Any, Any]] = None, sync_mode: Optional[Literal[SOFT_DELETE, HISTORY, LIVE]] = None) → pyfivetran.shed.GeneralApiResponse[source]

Updates the table configuration for a specific connector.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • schema_name – The schema name within the Fivetran system

  • table_name – The table name within the Fivetran system

  • enabled – Whether the table is enabled

  • columns – The columns within the table

  • sync_mode – The sync mode for the table

Returns:

GeneralApiResponse

resync_connector_table_data(connector_id: str, **prop_kwargs: Optional[Dict[str, Any]]) → pyfivetran.shed.GeneralApiResponse[source]

Triggers a historical sync of all data for multiple schema tables within a connector. This action does not override the standard sync frequency you defined in the Fivetran dashboard.

Parameters:

connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

reload_connector_schema_config(connector_id: str, exclude_mode: Optional[str] = None) → pyfivetran.shed.GeneralApiResponse[source]

Reloads the schema configuration for a specific connector.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • exclude_mode – The exclude mode

Returns:

GeneralApiResponse

get_connector_schema_config(connector_id: str) → pyfivetran.shed.GeneralApiResponse[source]

Get the connector schema config for an existing connector within your Fivetran account.

Parameters:

connector_id – Unique ID of the connector in Fivetran

Returns:

GeneralApiResponse

get_source_table_columns_config(connector_id: str, schema: str, table: str) → pyfivetran.shed.GeneralApiResponse[source]

Get the source table columns config for an existing connector within your Fivetran account.

Parameters:

  • connector_id – Unique ID of the connector in Fivetran

  • schema – The schema name within the Fivetran system

  • table – The table name within the Fivetran system

Returns:

GeneralApiResponse