Skip to main content

Retrieve the list of demos.

Retrieve the list of demos.

Responses
200

List of demos.

Schema OPTIONAL
object[]
pipeline object

Pipeline descriptor.

description string

Pipeline description.

name string

Pipeline name.

program_code string

Program SQL code.

program_config object

Program configuration.

profile string OPTIONAL

Possible values: [dev, unoptimized, optimized]

Enumeration of possible compilation profiles that can be passed to the Rust compiler as an argument via cargo build --profile <>. A compilation profile affects among other things the compilation speed (how long till the program is ready to be run) and runtime speed (the performance while running).

runtime_config object

Global pipeline configuration settings. This is the publicly exposed type for users to configure pipelines.

clock_resolution_usecs int64 OPTIONAL

Real-time clock resolution in microseconds.

This parameter controls the execution of queries that use the NOW() function. The output of such queries depends on the real-time clock and can change over time without any external inputs. The pipeline will update the clock value and trigger incremental recomputation at most each clock_resolution_usecs microseconds.

It is set to 100 milliseconds (100,000 microseconds) by default.

Set to null to disable periodic clock updates.

cpu_profiler boolean OPTIONAL

Enable CPU profiler.

The default value is true.

max_buffering_delay_usecs int64 OPTIONAL

Maximal delay in microseconds to wait for min_batch_size_records to get buffered by the controller, defaults to 0.

min_batch_size_records int64 OPTIONAL

Minimal input batch size.

The controller delays pushing input records to the circuit until at least min_batch_size_records records have been received (total across all endpoints) or max_buffering_delay_usecs microseconds have passed since at least one input records has been buffered. Defaults to 0.

min_storage_bytes integer OPTIONAL

The minimum estimated number of bytes in a batch of data to write it to storage. This is provided for debugging and fine-tuning and should ordinarily be left unset. It only has an effect when storage is set to true.

A value of 0 will write even empty batches to storage, and nonzero values provide a threshold. usize::MAX would effectively disable storage.

resources object OPTIONAL
cpu_cores_max int64 OPTIONAL

The maximum number of CPU cores to reserve for an instance of this pipeline

cpu_cores_min int64 OPTIONAL

The minimum number of CPU cores to reserve for an instance of this pipeline

memory_mb_max int64 OPTIONAL

The maximum memory in Megabytes to reserve for an instance of this pipeline

memory_mb_min int64 OPTIONAL

The minimum memory in Megabytes to reserve for an instance of this pipeline

storage_class string OPTIONAL

Storage class to use for an instance of this pipeline. The class determines storage performance such as IOPS and throughput.

storage_mb_max int64 OPTIONAL

The total storage in Megabytes to reserve for an instance of this pipeline

storage boolean OPTIONAL

Should persistent storage be enabled for this pipeline?

  • If false (default), the pipeline's state is kept in in-memory data-structures. This is useful if the pipeline is ephemeral and does not need to be recovered after a restart. The pipeline will most likely run faster since it does not need to read from, or write to disk

  • If true, the pipeline state is stored in the specified location, is persisted across restarts, and can be checkpointed and recovered. This feature is currently experimental.

tracing boolean OPTIONAL

Enable pipeline tracing.

tracing_endpoint_jaeger string OPTIONAL

Jaeger tracing endpoint to send tracing information to.

workers int32 OPTIONAL

Number of DBSP worker threads.

title string

Demo title.

500

Failed to read demos from the demos directory.

Schema OPTIONAL
details object

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.