datasets

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

Overview

Name	datasets
Type	Resource
Id	cloudflare.cloudforce_one.datasets

Fields

The following fields are returned by SELECT queries:

list

Returns a list of dataset in an account.

Name	Datatype	Description
name	string
isPublic	boolean
uuid	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id
create	insert	account_id, name, isPublic
edit	update	account_id, dataset_id, name, isPublic
copy	exec	account_id, dataset_id, destDatasetId, eventIds	keepRawData
move	exec	account_id, dataset_id, destDatasetId, eventIds	keepRawData
populate	exec	account_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.
dataset_id	string	The dataset ID.
keepRawData	boolean	If true, copies raw data to the destination dataset. Default is false (raw data is stripped/not copied). Raw data is always deleted from the source.

SELECT examples

list

Returns a list of dataset in an account.

SELECT
name,
isPublic,
uuid
FROM cloudflare.cloudforce_one.datasets
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.cloudforce_one.datasets (
isPublic,
name,
account_id
)
SELECT 
{{ isPublic }} /* required */,
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
name,
isPublic,
uuid
;

Manifest

# Description fields are for documentation purposes
- name: datasets
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the datasets resource.
  - name: isPublic
    value: {{ isPublic }}
    description: |
      If true, then anyone can search the dataset. If false, then its limited to the account.
  - name: name
    value: "{{ name }}"
    description: |
      Used to describe the dataset within the account context.

UPDATE examples

edit

No description available.

UPDATE cloudflare.cloudforce_one.datasets
SET 
isPublic = {{ isPublic }},
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND name = '{{ name }}' --required
AND isPublic = {{ isPublic }} --required
RETURNING
name,
isPublic,
uuid;

Lifecycle Methods

copy

Returns the number of copied events

EXEC cloudflare.cloudforce_one.datasets.copy 
@account_id='{{ account_id }}' --required, 
@dataset_id='{{ dataset_id }}' --required, 
@keepRawData={{ keepRawData }} 
@@json=
'{
"destDatasetId": "{{ destDatasetId }}", 
"eventIds": "{{ eventIds }}"
}'
;

move

Returns the number of moved events

EXEC cloudflare.cloudforce_one.datasets.move 
@account_id='{{ account_id }}' --required, 
@dataset_id='{{ dataset_id }}' --required, 
@keepRawData={{ keepRawData }} 
@@json=
'{
"destDatasetId": "{{ destDatasetId }}", 
"eventIds": "{{ eventIds }}"
}'
;

populate

Returns population results with counts and any errors

EXEC cloudflare.cloudforce_one.datasets.populate 
@account_id='{{ account_id }}' --required
;