endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	databricks_workspace.vectorsearch.endpoints

Fields

The following fields are returned by SELECT queries:

getendpoint

Details of the endpoint.

Name	Datatype	Description
id	string
name	string
creation_timestamp	integer
creator	string
endpoint_status	object
endpoint_type	string
last_updated_timestamp	integer
last_updated_user	string
num_indexes	integer

listendpoints

List of all endpoints

Name	Datatype	Description
id	string
name	string
creation_timestamp	integer
creator	string
endpoint_status	object
endpoint_type	string
last_updated_timestamp	integer
last_updated_user	string
num_indexes	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getendpoint	select	deployment_name
listendpoints	select	deployment_name
createendpoint	insert	deployment_name		Create a new endpoint.
deleteendpoint	delete	deployment_name

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)

SELECT examples

getendpoint

Details of the endpoint.

SELECT
id,
name,
creation_timestamp,
creator,
endpoint_status,
endpoint_type,
last_updated_timestamp,
last_updated_user,
num_indexes
FROM databricks_workspace.vectorsearch.endpoints
WHERE deployment_name = '{{ deployment_name }}' -- required;

listendpoints

List of all endpoints

SELECT
id,
name,
creation_timestamp,
creator,
endpoint_status,
endpoint_type,
last_updated_timestamp,
last_updated_user,
num_indexes
FROM databricks_workspace.vectorsearch.endpoints
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createendpoint

Create a new endpoint.

INSERT INTO databricks_workspace.vectorsearch.endpoints (
data__name,
data__endpoint_type,
deployment_name
)
SELECT 
'{{ name }}',
'{{ endpoint_type }}',
'{{ deployment_name }}'
RETURNING
id,
name,
creation_timestamp,
creator,
endpoint_status,
endpoint_type,
last_updated_timestamp,
last_updated_user
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the endpoints resource.
    - name: name
      value: required
    - name: endpoint_type
      value: string

DELETE examples

deleteendpoint

No description available.

DELETE FROM databricks_workspace.vectorsearch.endpoints
WHERE deployment_name = '{{ deployment_name }}' --required;