streams

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

Overview

Name	streams
Type	Resource
Id	cloudflare.pipelines.streams

Fields

The following fields are returned by SELECT queries:

get

Indicates a successfully retrieved Stream.

Name	Datatype	Description
id	string	Indicates a unique identifier for this stream.
name	string	Indicates the name of the Stream.
created_at	string (date-time)
endpoint	string (uri)	Indicates the endpoint URL of this stream.
format	object	(title: Json)
http	object
modified_at	string (date-time)
schema	object
version	integer	Indicates the current version of this stream.
worker_binding	object

list

Indicates a successfully created Stream.

Name	Datatype	Description
id	string	Indicates a unique identifier for this stream.
name	string	Indicates the name of the Stream.
created_at	string (date-time)
endpoint	string (uri)	Indicates the endpoint URL of this stream.
format	object	(title: Json)
http	object
modified_at	string (date-time)
schema	object
version	integer	Indicates the current version of this stream.
worker_binding	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, stream_id		Get Stream Details.
list	select	account_id	pipeline_id, page, per_page	List/Filter Streams in Account.
create	insert	account_id, name		Create a new Stream.
update	update	account_id, stream_id		Update a Stream.
delete	delete	account_id, stream_id	force	Delete Stream in Account.

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

SELECT examples

get

Get Stream Details.

SELECT
id,
name,
created_at,
endpoint,
format,
http,
modified_at,
schema,
version,
worker_binding
FROM cloudflare.pipelines.streams
WHERE account_id = '{{ account_id }}' -- required
AND stream_id = '{{ stream_id }}' -- required
;

list

List/Filter Streams in Account.

SELECT
id,
name,
created_at,
endpoint,
format,
http,
modified_at,
schema,
version,
worker_binding
FROM cloudflare.pipelines.streams
WHERE account_id = '{{ account_id }}' -- required
AND pipeline_id = '{{ pipeline_id }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Create a new Stream.

INSERT INTO cloudflare.pipelines.streams (
format,
http,
name,
schema,
worker_binding,
account_id
)
SELECT 
'{{ format }}',
'{{ http }}',
'{{ name }}' /* required */,
'{{ schema }}',
'{{ worker_binding }}',
'{{ account_id }}'
RETURNING
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: streams
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the streams resource.
  - name: format
    value:
      decimal_encoding: "{{ decimal_encoding }}"
      timestamp_format: "{{ timestamp_format }}"
      unstructured: {{ unstructured }}
      type: "{{ type }}"
      compression: "{{ compression }}"
      row_group_bytes: {{ row_group_bytes }}
  - name: http
    value:
      authentication: {{ authentication }}
      cors:
        origins:
          - "{{ origins }}"
      enabled: {{ enabled }}
    default: [object Object]
  - name: name
    value: "{{ name }}"
    description: |
      Specifies the name of the Stream.
  - name: schema
    value:
      fields:
        - metadata_key: "{{ metadata_key }}"
          name: "{{ name }}"
          sql_name: "{{ sql_name }}"
          type: "{{ type }}"
          unit: "{{ unit }}"
          fields: "{{ fields }}"
          items:
            metadata_key: "{{ metadata_key }}"
            name: "{{ name }}"
            sql_name: "{{ sql_name }}"
            type: "{{ type }}"
            unit: "{{ unit }}"
            fields:
              - metadata_key: "{{ metadata_key }}"
                name: "{{ name }}"
                sql_name: "{{ sql_name }}"
                type: "{{ type }}"
                unit: "{{ unit }}"
                fields: "{{ fields }}"
                items:
                  metadata_key: "{{ metadata_key }}"
                  name: "{{ name }}"
                  sql_name: "{{ sql_name }}"
                  type: "{{ type }}"
                  unit: "{{ unit }}"
                  fields: "{{ fields }}"
                  items: "{{ items }}"
            items:
              metadata_key: "{{ metadata_key }}"
              name: "{{ name }}"
              sql_name: "{{ sql_name }}"
              type: "{{ type }}"
              unit: "{{ unit }}"
              fields:
                - metadata_key: "{{ metadata_key }}"
                  name: "{{ name }}"
                  sql_name: "{{ sql_name }}"
                  type: "{{ type }}"
                  unit: "{{ unit }}"
                  fields: "{{ fields }}"
                  items:
                    metadata_key: "{{ metadata_key }}"
                    name: "{{ name }}"
                    sql_name: "{{ sql_name }}"
                    type: "{{ type }}"
                    unit: "{{ unit }}"
                    fields: "{{ fields }}"
                    items: "{{ items }}"
              items:
                metadata_key: "{{ metadata_key }}"
                name: "{{ name }}"
                sql_name: "{{ sql_name }}"
                type: "{{ type }}"
                unit: "{{ unit }}"
                fields: "{{ fields }}"
                items: "{{ items }}"
      format:
        decimal_encoding: "{{ decimal_encoding }}"
        timestamp_format: "{{ timestamp_format }}"
        unstructured: {{ unstructured }}
        type: "{{ type }}"
        compression: "{{ compression }}"
        row_group_bytes: {{ row_group_bytes }}
      inferred: {{ inferred }}
  - name: worker_binding
    value:
      enabled: {{ enabled }}
    default: [object Object]

UPDATE examples

update

Update a Stream.

UPDATE cloudflare.pipelines.streams
SET 
http = '{{ http }}',
worker_binding = '{{ worker_binding }}'
WHERE 
account_id = '{{ account_id }}' --required
AND stream_id = '{{ stream_id }}' --required
RETURNING
result,
success;

DELETE examples

delete

Delete Stream in Account.

DELETE FROM cloudflare.pipelines.streams
WHERE account_id = '{{ account_id }}' --required
AND stream_id = '{{ stream_id }}' --required
AND force = '{{ force }}'
;