Module Contents



Copy data from SQL results to provided Google Spreadsheet.

class*, sql, spreadsheet_id, sql_conn_id, parameters=None, database=None, spreadsheet_range='Sheet1', gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None, **kwargs)[source]

Bases: airflow.providers.common.sql.operators.sql.BaseSQLOperator

Copy data from SQL results to provided Google Spreadsheet.

  • sql (str) – The SQL to execute.

  • spreadsheet_id (str) – The Google Sheet ID to interact with.

  • conn_id – the connection ID used to connect to the database.

  • parameters (Iterable | Mapping[str, Any] | None) – The parameters to render the SQL query with.

  • database (str | None) – name of database which overwrite the defined one in connection

  • spreadsheet_range (str) – The A1 notation of the values to retrieve.

  • gcp_conn_id (str) – The connection ID to use when fetching connection info.

  • delegate_to (str | None) – The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled.

  • impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).

template_fields: Sequence[str] = ('sql', 'spreadsheet_id', 'spreadsheet_range', 'impersonation_chain')[source]
template_ext: Sequence[str] = ('.sql',)[source]
ui_color = '#a0e08c'[source]

Derive when creating an operator.

Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?