application

Returns the Application specified by the given ID.

Arguments

id
ID
required

Returns

Nullable
Application

applicationByName

Returns the Application with the given unique name.

Arguments

uniqueName
String
required

Returns

Nullable
Application

applications

Returns the Applications within the Environment.

The applications query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.

For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.

For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.

Arguments

first
Int
after
String
last
Int
before
String

Returns

Nullable
ApplicationConnection

dataSource

Returns the Data Source specified by the given ID.

query {
  dataSource(id: "DSOXXXXX") {
    id
    uniqueName
    type
    tables (first: 100){
      nodes {
        id
        name
        columns (first: 100) {
          nodes {
            name
            type
            isNullable
            supportedDataPoolColumnTypes
          }
        }
      }
    }
  }
}

Arguments

id
ID
required

Returns

Nullable
DataSource

dataSourceByName

Returns the Data Source specified by the given unique name.

Arguments

uniqueName
String
required

Returns

Nullable
DataSource

dataSources

Returns the Data Sources within the Environment.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

The dataSources query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.

For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.

For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.

Arguments

first
Int
after
String
last
Int
before
String

Returns

Nullable
DataSourceConnection

dataPool

Returns the Data Pool specified by the given ID.

A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.

Arguments

id
ID
required

Returns

Nullable
DataPool

dataPoolByName

Returns the Data Pool specified by the given unique name.

A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.

Arguments

uniqueName
String
required

Returns

Nullable
DataPool

dataPools

Returns the Data Pools within the Environment.

A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

The dataPools query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.

For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.

For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.

Arguments

first
Int
after
String
last
Int
before
String

Returns

Nullable
DataPoolConnection

environment

Returns the Environment specified by the given ID.

Arguments

id
ID
required

Returns

Nullable
Environment

materializedViews

Returns the Materialized Views within the Environment.

The materializedViews query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.

For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.

For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.

Arguments

first
Int
after
String
last
Int
before
String

Returns

Nullable
MaterializedViewConnection

dataPoolAccessPolicy

Returns the Data Pool Access Policy specified by the given ID.

A Data Pool Access Policy limits the data that Applications can access within a Data Pool.

Arguments

id
ID
required

Returns

Nullable
DataPoolAccessPolicy

metric

Returns the Metric specified by the given ID.

A Metric is a business indicator measured over time.

Arguments

id
ID
required

Returns

Nullable
Metric

metricByName

Returns the Metric specified by the given unique name.

A Metric is a business indicator measured over time.

Arguments

uniqueName
String
required

Returns

Nullable
Metric

metrics

Returns the Metrics within the Environment.

A Metric is a business indicator measured over time. Each Metric is associated with one Data Pool, which is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries. Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads.

The metrics query uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.

For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.

For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.

Arguments

first
Int
after
String
last
Int
before
String

Returns

Nullable
MetricConnection

booster

Returns the Booster specified by the given ID.

A Booster significantly improves the query performance for a Metric.

Arguments

id
ID
required

Returns

Nullable
Booster

policy

Returns a Policy by ID.

Arguments

id
ID
required

Returns

Nullable
Policy

sync

Returns a Sync by ID.

Arguments

id
ID
required

Returns

Nullable
Sync

table

Returns a table by ID.

Arguments

id
ID
required

Returns

Nullable
Table

metricReport

Build a report, or table, consisting of multiple Metrics broken down by one-or-more dimensions.

The first few columns of the report are the dimensions you choose to break down by. The subsequent columns are the Metrics you choose to query. By default, the report sorts on the first Metric in descending order, but you can configure this with the orderByMetric and sort inputs.

Finally, reports use cursor-based pagination. You can control page size with the first and last inputs.

Arguments

input
MetricReportInput
required

Returns

Nullable
MetricReportConnection

sqlV1

Query Data Pools using SQL.

Arguments

input
SqlV1Input
required

Returns

Non-null
SqlResponse