postgres_endpoints

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

Overview

Name	postgres_endpoints
Type	Resource
Id	databricks_workspace.postgres.postgres_endpoints

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
create_time	string (date-time)
parent	string	The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
▶spec	object	The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state.
▶status	object	Current operational status of the compute endpoint.
uid	string	System-generated unique ID for the endpoint.
update_time	string (date-time)	A timestamp indicating when the compute endpoint was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	parent, deployment_name	page_size, page_token	Returns a paginated list of compute endpoints in the branch.
create	insert	parent, endpoint_id, deployment_name, endpoint		Creates a new compute endpoint in the 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)
endpoint_id	string	The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name. The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. For example, primary becomes projects/my-app/branches/development/endpoints/primary.
parent	string	The Branch where this Endpoint will be created. Format: projects/{project_id}/branches/{branch_id}
page_size	integer	Upper bound for items returned. Cannot be negative.
page_token	string	Page token from a previous response. If not provided, returns the first page.

SELECT examples

list

Returns a paginated list of compute endpoints in the branch.

SELECT
name,
create_time,
parent,
spec,
status,
uid,
update_time
FROM databricks_workspace.postgres.postgres_endpoints
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a new compute endpoint in the branch.

INSERT INTO databricks_workspace.postgres.postgres_endpoints (
endpoint,
parent,
endpoint_id,
deployment_name
)
SELECT 
'{{ endpoint }}' /* required */,
'{{ parent }}',
'{{ endpoint_id }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: postgres_endpoints
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the postgres_endpoints resource.
  - name: endpoint_id
    value: "{{ endpoint_id }}"
    description: Required parameter for the postgres_endpoints resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the postgres_endpoints resource.
  - name: endpoint
    description: |
      The Endpoint to create.
    value:
      create_time: "{{ create_time }}"
      name: "{{ name }}"
      parent: "{{ parent }}"
      spec:
        endpoint_type: "{{ endpoint_type }}"
        autoscaling_limit_max_cu: {{ autoscaling_limit_max_cu }}
        autoscaling_limit_min_cu: {{ autoscaling_limit_min_cu }}
        disabled: {{ disabled }}
        no_suspension: {{ no_suspension }}
        settings:
          pg_settings: "{{ pg_settings }}"
        suspend_timeout_duration: "{{ suspend_timeout_duration }}"
      status:
        autoscaling_limit_max_cu: {{ autoscaling_limit_max_cu }}
        autoscaling_limit_min_cu: {{ autoscaling_limit_min_cu }}
        current_state: "{{ current_state }}"
        disabled: {{ disabled }}
        endpoint_type: "{{ endpoint_type }}"
        hosts:
          host: "{{ host }}"
        pending_state: "{{ pending_state }}"
        settings:
          pg_settings: "{{ pg_settings }}"
        suspend_timeout_duration: "{{ suspend_timeout_duration }}"
      uid: "{{ uid }}"
      update_time: "{{ update_time }}"