session_stores

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

Overview

Name	session_stores
Type	Resource
Id	databricks_workspace.agentkit.session_stores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Resource name in the form ``session-stores/{session_store_id}``.
creator_user_id	string	Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context.
create_time	string (date-time)	Time when the store was created.
description	string	Human-readable description of the session store.
metadata	object	Mutable caller-defined string labels.
update_time	string (date-time)	Time when the store was last updated.

list

Name	Datatype	Description
name	string	Resource name in the form ``session-stores/{session_store_id}``.
creator_user_id	string	Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context.
create_time	string (date-time)	Time when the store was created.
description	string	Human-readable description of the session store.
metadata	object	Mutable caller-defined string labels.
update_time	string (date-time)	Time when the store was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	session_store_id, deployment_name, workspace_domain		Gets a session store by resource name.
list	select	deployment_name, workspace_domain	page_size, page_token	Lists session stores.
create	insert	session_store_id, deployment_name, workspace_domain		Creates a session store.
update	update	session_store_id, update_mask, deployment_name, workspace_domain		Updates a session store's description and metadata.
delete	delete	session_store_id, deployment_name, workspace_domain		Deletes a session store, its sessions and items, and its service-managed storage. Memory entries

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: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
session_store_id	string	The session_store_id segment of the name resource name (session-stores/{session_store_id}). Resource name in the form session-stores/{session_store_id}.
update_mask	object	Fields to update. Only description and metadata are mutable; any other path returns INVALID_PARAMETER_VALUE.
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})
page_size	integer	Maximum number of session stores to return. Defaults to 10; must be between 1 and 100.
page_token	string	Token returned by a previous list request.

SELECT examples

get

Gets a session store by resource name.

SELECT
name,
creator_user_id,
create_time,
description,
metadata,
update_time
FROM databricks_workspace.agentkit.session_stores
WHERE session_store_id = '{{ session_store_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

Lists session stores.

SELECT
name,
creator_user_id,
create_time,
description,
metadata,
update_time
FROM databricks_workspace.agentkit.session_stores
WHERE deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a session store.

INSERT INTO databricks_workspace.agentkit.session_stores (
create_time,
creator_user_id,
description,
metadata,
name,
update_time,
session_store_id,
deployment_name,
workspace_domain
)
SELECT 
'{{ create_time }}',
'{{ creator_user_id }}',
'{{ description }}',
'{{ metadata }}',
'{{ name }}',
'{{ update_time }}',
'{{ session_store_id }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
RETURNING
name,
creator_user_id,
create_time,
description,
metadata,
update_time
;

Manifest

# Description fields are for documentation purposes
- name: session_stores
props:
  - name: session_store_id
    value: "{{ session_store_id }}"
    description: Required parameter for the session_stores resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the session_stores resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the session_stores resource.
  - name: create_time
    value: "{{ create_time }}"
    description: |
      Time when the store was created.
  - name: creator_user_id
    value: "{{ creator_user_id }}"
    description: |
      Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context.
  - name: description
    value: "{{ description }}"
    description: |
      Human-readable description of the session store.
  - name: metadata
    value: "{{ metadata }}"
    description: |
      Mutable caller-defined string labels.
  - name: name
    value: "{{ name }}"
    description: |
      Resource name in the form ``session-stores/{session_store_id}``.
  - name: update_time
    value: "{{ update_time }}"
    description: |
      Time when the store was last updated.

UPDATE examples

update

Updates a session store's description and metadata.

UPDATE databricks_workspace.agentkit.session_stores
SET 
create_time = '{{ create_time }}',
creator_user_id = '{{ creator_user_id }}',
description = '{{ description }}',
metadata = '{{ metadata }}',
name = '{{ name }}',
update_time = '{{ update_time }}'
WHERE 
session_store_id = '{{ session_store_id }}' --required
AND update_mask = '{{ update_mask }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
RETURNING
name,
creator_user_id,
create_time,
description,
metadata,
update_time;

DELETE examples

delete

Deletes a session store, its sessions and items, and its service-managed storage. Memory entries

DELETE FROM databricks_workspace.agentkit.session_stores
WHERE session_store_id = '{{ session_store_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND workspace_domain = '{{ workspace_domain }}' --required
;