postgres_data_apis

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

Overview

Name	postgres_data_apis
Type	Resource
Id	databricks_workspace.postgres.postgres_data_apis

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	parent, deployment_name, data_api		Enable Data API for a database.

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	Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id}

INSERT examples

create

Enable Data API for a database.

INSERT INTO databricks_workspace.postgres.postgres_data_apis (
data_api,
parent,
deployment_name
)
SELECT 
'{{ data_api }}' /* required */,
'{{ parent }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: postgres_data_apis
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the postgres_data_apis resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the postgres_data_apis resource.
  - name: data_api
    description: |
      The Data API configuration to create.
    value:
      create_time: "{{ create_time }}"
      name: "{{ name }}"
      parent: "{{ parent }}"
      spec:
        db_aggregates_enabled: {{ db_aggregates_enabled }}
        db_anon_role: "{{ db_anon_role }}"
        db_extra_search_path:
          - "{{ db_extra_search_path }}"
        db_max_rows: {{ db_max_rows }}
        db_schemas:
          - "{{ db_schemas }}"
        jwt_cache_max_lifetime: "{{ jwt_cache_max_lifetime }}"
        jwt_role_claim_key: "{{ jwt_role_claim_key }}"
        openapi_mode: "{{ openapi_mode }}"
        server_cors_allowed_origins:
          - "{{ server_cors_allowed_origins }}"
        server_timing_enabled: {{ server_timing_enabled }}
      status:
        available_schemas:
          - "{{ available_schemas }}"
        db_aggregates_enabled: {{ db_aggregates_enabled }}
        db_anon_role: "{{ db_anon_role }}"
        db_extra_search_path:
          - "{{ db_extra_search_path }}"
        db_max_rows: {{ db_max_rows }}
        db_schemas:
          - "{{ db_schemas }}"
        jwt_cache_max_lifetime: "{{ jwt_cache_max_lifetime }}"
        jwt_role_claim_key: "{{ jwt_role_claim_key }}"
        openapi_mode: "{{ openapi_mode }}"
        server_cors_allowed_origins:
          - "{{ server_cors_allowed_origins }}"
        server_timing_enabled: {{ server_timing_enabled }}
        url: "{{ url }}"
      update_time: "{{ update_time }}"