namespaces

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

Overview

Name	namespaces
Type	Resource
Id	cloudflare.aisearch.namespaces

Fields

The following fields are returned by SELECT queries:

get

Namespace details.

Name	Datatype	Description
name	string
created_at	string (date-time)
description	string	Optional description for the namespace. Max 256 characters.

list

List of namespaces.

Name	Datatype	Description
name	string
created_at	string (date-time)
description	string	Optional description for the namespace. Max 256 characters.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, name		Read namespace.
list	select	account_id	page, per_page, search	List namespaces.
create	insert	account_id, name		Create a new namespace.
update	replace	account_id, name		Update namespace.
delete	delete	account_id, name		Delete namespace.

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
account_id	string	The Cloudflare account ID.
name	string	Resource name.
page	integer	Page number (1-indexed).
per_page	integer	Number of results per page.
search	string	Filter namespaces whose name or description contains this string (case-insensitive).

SELECT examples

get

Read namespace.

SELECT
name,
created_at,
description
FROM cloudflare.aisearch.namespaces
WHERE account_id = '{{ account_id }}' -- required
AND name = '{{ name }}' -- required
;

list

List namespaces.

SELECT
name,
created_at,
description
FROM cloudflare.aisearch.namespaces
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND search = '{{ search }}'
;

INSERT examples

create

Create a new namespace.

INSERT INTO cloudflare.aisearch.namespaces (
description,
name,
account_id
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: namespaces
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the namespaces resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional description for the namespace. Max 256 characters.
  - name: name
    value: "{{ name }}"

REPLACE examples

update

Update namespace.

REPLACE cloudflare.aisearch.namespaces
SET 
description = '{{ description }}'
WHERE 
account_id = '{{ account_id }}' --required
AND name = '{{ name }}' --required
RETURNING
result,
success;

DELETE examples

delete

Delete namespace.

DELETE FROM cloudflare.aisearch.namespaces
WHERE account_id = '{{ account_id }}' --required
AND name = '{{ name }}' --required
;