queries

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

Overview

Name	queries
Type	Resource
Id	cloudflare.workers.queries

Fields

The following fields are returned by SELECT queries:

get

Successful request

Name	Datatype	Description
id	string
name	string	Query name
adhoc	boolean	If the query wasn't explcitly saved
created	string
createdBy	string
description	string	(example: Query description)
parameters	object
updated	string
updatedBy	string

list

Successful request

Name	Datatype	Description
id	string
name	string	Query name
adhoc	boolean	If the query wasn't explcitly saved
created	string
createdBy	string
description	string	(example: Query description)
parameters	object
updated	string
updatedBy	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	query_id, account_id		Retrieve a saved query.
list	select	account_id	page, perPage, order, orderBy	List saved queries.
queries_post	insert	account_id, description, name, parameters		Persist query for later use.
queries_patch	update	query_id, account_id, description, name, parameters		Update saved query.
queries_delete	delete	query_id, account_id		Delete a saved query.

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.
query_id	string
order	string
orderBy	string
page	number
perPage	number

SELECT examples

get

Retrieve a saved query.

SELECT
id,
name,
adhoc,
created,
createdBy,
description,
parameters,
updated,
updatedBy
FROM cloudflare.workers.queries
WHERE query_id = '{{ query_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

List saved queries.

SELECT
id,
name,
adhoc,
created,
createdBy,
description,
parameters,
updated,
updatedBy
FROM cloudflare.workers.queries
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND perPage = '{{ perPage }}'
AND order = '{{ order }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

queries_post

Persist query for later use.

INSERT INTO cloudflare.workers.queries (
description,
name,
parameters,
account_id
)
SELECT 
'{{ description }}' /* required */,
'{{ name }}' /* required */,
'{{ parameters }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: queries
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the queries resource.
  - name: description
    value: "{{ description }}"
  - name: name
    value: "{{ name }}"
    description: |
      Query name
  - name: parameters
    value:
      calculations:
        - alias: "{{ alias }}"
          key: "{{ key }}"
          keyType: "{{ keyType }}"
          operator: "{{ operator }}"
      datasets:
        - "{{ datasets }}"
      filterCombination: "{{ filterCombination }}"
      filters:
        - filterCombination: "{{ filterCombination }}"
          filters: "{{ filters }}"
          kind: "{{ kind }}"
          key: "{{ key }}"
          operation: "{{ operation }}"
          type: "{{ type }}"
          value: "{{ value }}"
      groupBys:
        - type: "{{ type }}"
          value: "{{ value }}"
      havings:
        - key: "{{ key }}"
          operation: "{{ operation }}"
          value: {{ value }}
      limit: {{ limit }}
      needle:
        isRegex: {{ isRegex }}
        matchCase: {{ matchCase }}
        value: "{{ value }}"
      orderBy:
        order: "{{ order }}"
        value: "{{ value }}"

UPDATE examples

queries_patch

Update saved query.

UPDATE cloudflare.workers.queries
SET 
description = '{{ description }}',
name = '{{ name }}',
parameters = '{{ parameters }}'
WHERE 
query_id = '{{ query_id }}' --required
AND account_id = '{{ account_id }}' --required
AND description = '{{ description }}' --required
AND name = '{{ name }}' --required
AND parameters = '{{ parameters }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

queries_delete

Delete a saved query.

DELETE FROM cloudflare.workers.queries
WHERE query_id = '{{ query_id }}' --required
AND account_id = '{{ account_id }}' --required
;