postgres_forward_etl
Creates, updates, deletes, gets or lists a postgres_forward_etl resource.
Overview
| Name | postgres_forward_etl |
| Type | Resource |
| Id | databricks_workspace.postgres.postgres_forward_etl |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
configurations | array | List of Forward ETL configurations. |
table_mappings | array | Per-table replication mappings. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | parent, deployment_name | tenant_id, timeline_id | Get Forward ETL configuration and status for a branch. |
disable | delete | parent, deployment_name | pg_database_oid, pg_schema_oid, tenant_id, timeline_id | Disable Forward ETL for a branch. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
deployment_name | string | The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc) |
parent | string | The Branch to disable Forward ETL for. Format: projects/{project_id}/branches/{branch_id} |
pg_database_oid | integer | PostgreSQL database OID to disable. |
pg_schema_oid | integer | PostgreSQL schema OID to disable. |
tenant_id | string | Tenant ID (dashless UUID format). |
timeline_id | string | Timeline ID (dashless UUID format). |
SELECT examples
- get
Get Forward ETL configuration and status for a branch.
SELECT
configurations,
table_mappings
FROM databricks_workspace.postgres.postgres_forward_etl
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND tenant_id = '{{ tenant_id }}'
AND timeline_id = '{{ timeline_id }}'
;
DELETE examples
- disable
Disable Forward ETL for a branch.
DELETE FROM databricks_workspace.postgres.postgres_forward_etl
WHERE parent = '{{ parent }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND pg_database_oid = '{{ pg_database_oid }}'
AND pg_schema_oid = '{{ pg_schema_oid }}'
AND tenant_id = '{{ tenant_id }}'
AND timeline_id = '{{ timeline_id }}'
;