index_scan
Creates, updates, deletes, gets or lists an index_scan resource.
Overview
| Name | index_scan |
| Type | Resource |
| Id | databricks_workspace.vectorsearch.index_scan |
Fields
The following fields are returned by SELECT queries:
- scanindex
Successful response with scan results.
| Name | Datatype | Description |
|---|---|---|
data | array | |
last_primary_key | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
scanindex | select | deployment_name | Scan the specified vector index and return the first |
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
- scanindex
Scan the specified vector index and return the first
SELECT
data,
last_primary_key
FROM databricks_workspace.vectorsearch.index_scan
WHERE deployment_name = '{{ deployment_name }}' -- required;