SQL API

Use cases

Bespoke data access patterns

Query with SQL directly for access patterns that don’t fit into the other APIs.

Features

Using the Data Pool ID:

SELECT * FROM DPOXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Using the Data Pool Name without spaces:

SELECT * FROM events

Using the Data Pool Name with spaces:

SELECT * FROM "TacoSoft Demo Data"

Example

Example 1: Simple SQL query

Get the first 3 rows from the “TacoSoft Demo Data” Data Pool.

query {
  sqlV1(input: {
    query: """
      SELECT
        order_id,
        quantity,
        taco_name,
        sauce_name
      FROM "TacoSoft Demo Data"
      LIMIT 3
    """
  }) {
    columns {
      columnName
    }
    rows
  }
}

Usage

Arguments

Input to the SqlV1 api.

query

String

required

The SQL query.

dialect

SqlDialectV1

The SQL dialect to use. If not provided, the query is parsed on a best-effort basis.

Response

Response from the SQL API.

columns

[SqlColumnResponse!]

required

The column names in the same order as present in the data field.

rows

[[String]!]

required

The data gathered by the SQL query. The data is returned in an N x M matrix format, where the first dimension are the rows retrieved, and the second dimension are the columns. Each cell can be either a string or null, and the string can represent a number, text, date or boolean value.

info

QueryInfo

required

The Query statistics and metadata.

The Query Info object. It contains metadata and statistics about a Query performed.

required

The Query’s unique identifier.

createdAt

DateTime

required

The date and time in UTC when the Query was created.

createdBy

String

required

The unique identifier of the actor that performed the Query.

modifiedAt

DateTime

required

The date and time in UTC when the Query was last modified.

modifiedBy

String

required

The unique identifier of the actor that modified the Query.

bytesProcessed

String

required

The bytes processed by the Query.

durationInMilliseconds

Int

required

The duration of the Query in milliseconds.

recordsProcessed

String

required

The number of records processed by the Query.

resultingBytes

Int

required

The bytes returned by the Query.

resultingRecords

Int

required

The number of records returned by the Query.

propeller

Propeller

The Propeller used for this query.

status

QueryStatus

required

The Query status.

type

QueryType

required

The Query type.

subtype

QuerySubtype

The Query subtype.

sql

String

required

The SQL the query executed.

Embeddable UI components

useSql

A React Hook for querying data using raw SQL.

Get Started

APIs

Metrics

Guides

Use cases

Bespoke data access patterns

Features

Example

Example 1: Simple SQL query

Usage

Arguments

Response

Embeddable UI components

useSql

Get Started

APIs

Metrics

Guides

​Use cases

Bespoke data access patterns

​Features

​Example

​Example 1: Simple SQL query

​Usage

​Arguments

​Response

​Embeddable UI components

useSql

Use cases

Features

Example

Example 1: Simple SQL query

Usage

Arguments

Response

Embeddable UI components