v1_pipelines

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

Overview

Name	v1_pipelines
Type	Resource
Id	cloudflare.pipelines.v1_pipelines

Fields

The following fields are returned by SELECT queries:

get_by_account

Indicates a successfully retrieved Pipeline.

Name	Datatype	Description
id	string	Indicates a unique identifier for this pipeline.
name	string	Indicates the name of the Pipeline.
created_at	string
failure_reason	string	Indicates the reason for the failure of the Pipeline.
modified_at	string
sql	string	Specifies SQL for the Pipeline processing flow.
status	string	Indicates the current status of the Pipeline.
tables	array	List of streams and sinks used by this pipeline.

list

Indicates a successfully listed Pipelines.

Name	Datatype	Description
id	string	Indicates a unique identifier for this pipeline.
name	string	Indicates the name of the Pipeline.
created_at	string
modified_at	string
sql	string	Specifies SQL for the Pipeline processing flow.
status	string	Indicates the current status of the Pipeline.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	account_id, pipeline_id		Get Pipelines Details.
list	select	account_id	page, per_page	List/Filter Pipelines in Account.
create_v1	insert	account_id, name, sql		Create a new Pipeline.

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.
pipeline_id	string
page	number
per_page	number

SELECT examples

get_by_account

Get Pipelines Details.

SELECT
id,
name,
created_at,
failure_reason,
modified_at,
sql,
status,
tables
FROM cloudflare.pipelines.v1_pipelines
WHERE account_id = '{{ account_id }}' -- required
AND pipeline_id = '{{ pipeline_id }}' -- required
;

list

List/Filter Pipelines in Account.

SELECT
id,
name,
created_at,
modified_at,
sql,
status
FROM cloudflare.pipelines.v1_pipelines
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create_v1

Create a new Pipeline.

INSERT INTO cloudflare.pipelines.v1_pipelines (
name,
sql,
account_id
)
SELECT 
'{{ name }}' /* required */,
'{{ sql }}' /* required */,
'{{ account_id }}'
RETURNING
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: v1_pipelines
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the v1_pipelines resource.
  - name: name
    value: "{{ name }}"
    description: |
      Specifies the name of the Pipeline.
  - name: sql
    value: "{{ sql }}"
    description: |
      Specifies SQL for the Pipeline processing flow.