namespaces

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

Overview

Name	namespaces
Type	Resource
Id	cloudflare.kv.namespaces

Fields

The following fields are returned by SELECT queries:

get

Get a Namespace response.

Name	Datatype	Description
id	string	Namespace identifier tag. (example: 0f2ac74b498b48028cb68387c421e279)
supports_url_encoding	boolean	True if keys written on the URL will be URL-decoded before storing. For example, if set to "true", a key written on the URL as "%3F" will be stored as "?".
title	string	A human-readable string name for a Namespace. (example: My Own Namespace)

list

List Namespaces response.

Name	Datatype	Description
id	string	Namespace identifier tag. (example: 0f2ac74b498b48028cb68387c421e279)
supports_url_encoding	boolean	True if keys written on the URL will be URL-decoded before storing. For example, if set to "true", a key written on the URL as "%3F" will be stored as "?".
title	string	A human-readable string name for a Namespace. (example: My Own Namespace)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	namespace_id, account_id		Get the namespace corresponding to the given ID.
list	select	account_id	page, per_page, order, direction	Returns the namespaces owned by an account.
create	insert	account_id, title		Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.
update	replace	namespace_id, account_id, title		Modifies a namespace's title.
delete	delete	namespace_id, account_id		Deletes the namespace corresponding to the given ID.

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.
namespace_id	string	The Workers KV namespace ID.
direction	string
order	string
page	number
per_page	number

SELECT examples

get

Get the namespace corresponding to the given ID.

SELECT
id,
supports_url_encoding,
title
FROM cloudflare.kv.namespaces
WHERE namespace_id = '{{ namespace_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Returns the namespaces owned by an account.

SELECT
id,
supports_url_encoding,
title
FROM cloudflare.kv.namespaces
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order = '{{ order }}'
AND direction = '{{ direction }}'
;

INSERT examples

create

Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.

INSERT INTO cloudflare.kv.namespaces (
title,
account_id
)
SELECT 
'{{ title }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
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: title
    value: "{{ title }}"
    description: |
      A human-readable string name for a Namespace.

REPLACE examples

update

Modifies a namespace's title.

REPLACE cloudflare.kv.namespaces
SET 
title = '{{ title }}'
WHERE 
namespace_id = '{{ namespace_id }}' --required
AND account_id = '{{ account_id }}' --required
AND title = '{{ title }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes the namespace corresponding to the given ID.

DELETE FROM cloudflare.kv.namespaces
WHERE namespace_id = '{{ namespace_id }}' --required
AND account_id = '{{ account_id }}' --required
;