postgres_catalogs

Creates, updates, deletes, gets or lists a postgres_catalogs resource.

Overview

Name	postgres_catalogs
Type	Resource
Id	databricks_workspace.postgres.postgres_catalogs

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	catalog_id, deployment_name, catalog		Register a Postgres database in the Unity Catalog.

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
catalog_id	string	The ID in the Unity Catalog. It becomes the full resource name, for example "my_catalog" becomes "catalogs/my_catalog".
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

INSERT examples

create

Register a Postgres database in the Unity Catalog.

INSERT INTO databricks_workspace.postgres.postgres_catalogs (
catalog,
catalog_id,
deployment_name
)
SELECT 
'{{ catalog }}' /* required */,
'{{ catalog_id }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: postgres_catalogs
props:
  - name: catalog_id
    value: "{{ catalog_id }}"
    description: Required parameter for the postgres_catalogs resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the postgres_catalogs resource.
  - name: catalog
    value:
      catalog_id: "{{ catalog_id }}"
      create_time: "{{ create_time }}"
      name: "{{ name }}"
      spec:
        postgres_database: "{{ postgres_database }}"
        branch: "{{ branch }}"
        create_database_if_missing: {{ create_database_if_missing }}
      status:
        branch: "{{ branch }}"
        postgres_database: "{{ postgres_database }}"
        project: "{{ project }}"
      uid: "{{ uid }}"
      update_time: "{{ update_time }}"