index_query
Creates, updates, deletes, gets or lists an index_query resource.
Overview
| Name | index_query |
| Type | Resource |
| Id | databricks_workspace.vectorsearch.index_query |
Fields
The following fields are returned by SELECT queries:
- queryindex
Successful response with query results.
| Name | Datatype | Description |
|---|---|---|
manifest | object | |
next_page_token | string | |
result | object |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
queryindex | select | deployment_name | Query the specified vector index. |
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
- queryindex
Query the specified vector index.
SELECT
manifest,
next_page_token,
result
FROM databricks_workspace.vectorsearch.index_query
WHERE deployment_name = '{{ deployment_name }}' -- required;