Mutations

Available mutations in the Management API

createEnvironment

Creates an Environment and returns the newly created Environment (or an error if creating the Environment fails).

Arguments

input · CreateEnvironmentInput · required

Show CreateEnvironmentInput

The fields for creating an Environment.

uniqueName · String · required

The Environment’s unique name.

description · String

The Environment’s description.

Returns

Non-null

EnvironmentResponse

Show EnvironmentResponse

The result of a mutation which creates or modifies an Environment.

environment · Environment

The Environment which was created or modified.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

modifyEnvironment

Modifies an Environment with the provided fields. If any of the optional fields are omitted, those properties will be unchanged on the Environment.

Arguments

input · ModifyEnvironmentInput · required

Show ModifyEnvironmentInput

The fields for modifying an Environment.

id · ID · required

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

Returns

Non-null

EnvironmentResponse

Show EnvironmentResponse

The result of a mutation which creates or modifies an Environment.

environment · Environment

The Environment which was created or modified.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

deleteEnvironment

Deletes a Environment by ID and returns its ID if the Environment was deleted successfully.

Arguments

id · ID · required

createDataPoolAccessPolicy

Creates a Data Pool Access Policy for the specified Data Pool.

Arguments

input · CreateDataPoolAccessPolicyInput · required

Show CreateDataPoolAccessPolicyInput

uniqueName · String

The Data Pool Access Policy’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Data Pool Access Policy’s description.

dataPool · ID · required

The Data Pool to which the Access Policy belongs.

columns · [String!] · required

Columns that the Access Policy makes available for querying.

If set to ["*"], all columns will be available for querying.

filterSql · String

Row-level filters that the Access Policy applies before executing queries, in the form of SQL.

Show Deprecated Fields

rows · [FilterInput!] · deprecated

Row-level filters that the Access Policy applies before executing queries.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Non-null

DataPoolAccessPolicyResponse

Show DataPoolAccessPolicyResponse

dataPoolAccessPolicy · DataPoolAccessPolicy · required

The Data Pool Access Policy.

Show DataPoolAccessPolicy

id · ID · required

The ID of the Data Pool Access Policy.

uniqueName · String · required

The Data Pool Access Policy’s unique name.

description · String · required

The Data Pool Access Policy’s description.

account · Account · required

The Data Pool Access Policy’s Account.

See Account

environment · Environment · required

The Data Pool Access Policy’s Environment.

See Environment

createdAt · DateTime · required

The Data Pool Access Policy’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool Access Policy’s last modification date and time in UTC.

createdBy · String · required

The Data Pool Access Policy’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool Access Policy’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool · required

The Data Pool to which the Access Policy belongs. See DataPool

columns · [String!] · required

Columns that the Access Policy makes available for querying.

filterSql · String

Row-level filters that the Access Policy applies before executing queries, in the form of SQL.

applications · ApplicationConnection · required

Applications that are assigned to this Data Pool Access Policy.

Arguments

first · Int

after · String

last · Int

before · String

See ApplicationConnection

Show Deprecated Fields

rows · [Filter!] · deprecated

Row-level filters that the Access Policy applies before executing queries.

deprecated: Use filtersSql instead

See Filter

modifyDataPoolAccessPolicy

Modifies a Data Pool Access Policy with the provided unique name, description, columns and rows. If any of the optional arguments are omitted, those properties will be unchanged on the Data Pool Access Policy.

Arguments

input · ModifyDataPoolAccessPolicyInput · required

Show ModifyDataPoolAccessPolicyInput

id · ID · required

uniqueName · String

The Data Pool Access Policy’s new unique name.

description · String

The Data Pool Access Policy’s new description.

columns · [String!]

Columns that the Access Policy makes available for querying. If not provided this property will not be modified.

filterSql · String

Row-level filters that the Access Policy applies before executing queries, in the form of SQL. If not provided this property will not be modified.

Show Deprecated Fields

rows · [FilterInput!] · deprecated

Row-level filters that the Access Policy applies before executing queries. If not provided this property will not be modified.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Non-null

DataPoolAccessPolicyResponse

Show DataPoolAccessPolicyResponse

dataPoolAccessPolicy · DataPoolAccessPolicy · required

The Data Pool Access Policy.

Show DataPoolAccessPolicy

id · ID · required

The ID of the Data Pool Access Policy.

uniqueName · String · required

The Data Pool Access Policy’s unique name.

description · String · required

The Data Pool Access Policy’s description.

account · Account · required

The Data Pool Access Policy’s Account.

See Account

environment · Environment · required

The Data Pool Access Policy’s Environment.

See Environment

createdAt · DateTime · required

The Data Pool Access Policy’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool Access Policy’s last modification date and time in UTC.

createdBy · String · required

The Data Pool Access Policy’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool Access Policy’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool · required

The Data Pool to which the Access Policy belongs. See DataPool

columns · [String!] · required

Columns that the Access Policy makes available for querying.

filterSql · String

Row-level filters that the Access Policy applies before executing queries, in the form of SQL.

applications · ApplicationConnection · required

Applications that are assigned to this Data Pool Access Policy.

Arguments

first · Int

after · String

last · Int

before · String

See ApplicationConnection

Show Deprecated Fields

rows · [Filter!] · deprecated

Row-level filters that the Access Policy applies before executing queries.

deprecated: Use filtersSql instead

See Filter

deleteDataPoolAccessPolicy

Deletes a Data Pool Access Policy by ID and returns its ID if the Data Pool Access Policy was deleted successfully.

Arguments

id · ID · required

assignDataPoolAccessPolicyToApplication

Assign a Data Pool Access Policy to an Application.

The Data Pool Access Policy will restrict the Data Pool rows and columns that the Application can query. If the Data Pool has accessControlEnabled set to true, the Application must have a Data Pool Access Policy assigned in order to query the Data Pool.

An Application can have at most one Data Pool Access Policy assigned for a given Data Pool. If an Application already has a Data Pool Access Policy for a given Data Pool, and you call this mutation with another Data Pool Access Policy for the same Data Pool, the Application’s Data Pool Access Policy will be replaced.

Arguments

dataPoolAccessPolicy · ID · required

application · ID · required

unAssignDataPoolAccessPolicyFromApplication

Unassign a Data Pool Access Policy from an Application.

Once unassigned, whether the Application will be able to query the Data Pool is controlled by the Data Pool’s accessControlEnabled property. If accessControlEnabled is true, the Application will no longer be able to query the Data Pool. If accessControlEnabled is false, the Application will be able to query all data in the Data Pool, unrestricted.

Arguments

dataPoolAccessPolicy · ID · required

application · ID · required

createApplication

Creates a new Application and returns the newly created Application (or an error message if creating the Application fails).

Required scopes:

• APPLICATION_ADMIN

mutation {
  createApplication(
    input: {
      uniqueName: "example_sample_application"
      description: "My dashboard app"
      scopes: [DATA_POOL_QUERY]
      propeller: P1_X_SMALL
    }
  ) {
    ... on ApplicationResponse {
      application {
        id
        uniqueName
      }
    }
    ... on FailureResponse {
      error {
        code
        message
      }
    }
  }
}

Arguments

input · createApplicationInput · required

Show createApplicationInput

The fields for creating an Application.

uniqueName · String

The Application’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Application’s description.

propeller · Propeller

The Application’s Propeller. If no Propeller is provided, Propel will set the Propeller to P1_X_SMALL.

Show Propeller

A Propeller determines your Application’s query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

• P1_X_SMALL: Max records per second: 5,000,000 records per second
• P1_SMALL: Max records per second: 25,000,000 records per second
• P1_MEDIUM: Max records per second: 100,000,000 records per second
• P1_LARGE: Max records per second: 250,000,000 records per second
• P1_X_LARGE: Max records per second: 500,000,000 records per second

scopes · [ApplicationScope!]

The Application’s API authorization scopes. If specified, at least one scope must be provided; otherwise, all scopes will be granted to the Application by default.

Show ApplicationScope

The API operations an Application is authorized to perform.

• ADMIN: Grant read/write access to Data Sources, Data Pools, Metrics and Policies.
• APPLICATION_ADMIN: Grant read/write access to Applications.
• DATA_POOL_QUERY: Grant read access to query Data Pools.
• DATA_POOL_READ: Grant read access to read Data Pools.
• DATA_POOL_STATS: Grant read access to fetch column statistics from Data Pools.
• ENVIRONMENT_ADMIN: Grant read/write access to Environments.
• METRIC_QUERY: Grant read access to query Metrics.
• METRIC_STATS: Grant read access to fetch Dimension statistics from Metrics.
• METRIC_READ: Grant read access to Metrics.

This does not allow querying Metrics. For that, see METRIC_QUERY.

Returns

Nullable

ApplicationOrFailureResponse

Show ApplicationOrFailureResponse

The result of a mutation which creates or modifies an Application.

If successful, an ApplicationResponse will be returned; otherwise, a FailureResponse will be returned.

ApplicationOrFailureResponse · ApplicationResponse | FailureResponse

Show ApplicationResponse

The result of a mutation which creates or modifies an Application.

application · Application

The Application which was created or modified.

See Application

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

modifyApplication

Modifies an Application with the provided unique name, description, Propeller, and scopes. If any of the optional arguments are omitted, those properties will be unchanged on the Application.

Arguments

input · modifyApplicationInput · required

Show modifyApplicationInput

The fields for modifying an Application.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Application to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Application’s new unique name.

description · String

The Application’s new description.

propeller · Propeller

The Application’s new Propeller.

Show Propeller

A Propeller determines your Application’s query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

• P1_X_SMALL: Max records per second: 5,000,000 records per second
• P1_SMALL: Max records per second: 25,000,000 records per second
• P1_MEDIUM: Max records per second: 100,000,000 records per second
• P1_LARGE: Max records per second: 250,000,000 records per second
• P1_X_LARGE: Max records per second: 500,000,000 records per second

scopes · [ApplicationScope!]

The Application’s new API authorization scopes.

Show ApplicationScope

The API operations an Application is authorized to perform.

• ADMIN: Grant read/write access to Data Sources, Data Pools, Metrics and Policies.
• APPLICATION_ADMIN: Grant read/write access to Applications.
• DATA_POOL_QUERY: Grant read access to query Data Pools.
• DATA_POOL_READ: Grant read access to read Data Pools.
• DATA_POOL_STATS: Grant read access to fetch column statistics from Data Pools.
• ENVIRONMENT_ADMIN: Grant read/write access to Environments.
• METRIC_QUERY: Grant read access to query Metrics.
• METRIC_STATS: Grant read access to fetch Dimension statistics from Metrics.
• METRIC_READ: Grant read access to Metrics.

This does not allow querying Metrics. For that, see METRIC_QUERY.

Returns

Nullable

ApplicationOrFailureResponse

Show ApplicationOrFailureResponse

The result of a mutation which creates or modifies an Application.

If successful, an ApplicationResponse will be returned; otherwise, a FailureResponse will be returned.

ApplicationOrFailureResponse · ApplicationResponse | FailureResponse

Show ApplicationResponse

The result of a mutation which creates or modifies an Application.

application · Application

The Application which was created or modified.

See Application

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

deleteApplication

Deletes an Application by ID and returns its ID if the Application was deleted successfully.

Arguments

id · ID · required

deleteApplicationByName

Deletes an Application by unique name and returns its ID if the Application was deleted successfully.

Arguments

uniqueName · String · required

createSnowflakeDataSource

Creates a new Data Source from the given Snowflake database using the specified Snowflake account, warehouse, schema, username, and role.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · createSnowflakeDataSourceInput · required

Show createSnowflakeDataSourceInput

The fields for creating a Snowflake Data Source.

uniqueName · String

The Data Source’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Data Source’s description.

connectionSettings · SnowflakeConnectionSettingsInput · required

The Data Source’s connection settings.

Show SnowflakeConnectionSettingsInput

The fields for creating a Snowflake Data Source’s connection settings.

account · String · required

The Snowflake account. Only include the part before the “snowflakecomputing.com” part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like “znXXXXX.us-east-2.aws”. For Google Cloud-based accounts, this looks like “ffXXXXX.us-central1.gcp”.

database · String · required

The Snowflake database name.

warehouse · String · required

The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script.

schema · String · required

The Snowflake schema.

username · String · required

The Snowflake username. It should be “PROPEL” if you used the default name in the setup script.

password · String · required

The Snowflake password.

role · String · required

The Snowflake role. It should be “PROPELLER” if you used the default name in the setup script.

Returns

Nullable

DataSourceOrFailureResponse

Show DataSourceOrFailureResponse

The result of a mutation which creates or modifies a DataSource.

If successful, an DataSourceResponse will be returned; otherwise, a FailureResponse will be returned.

DataSourceOrFailureResponse · DataSourceResponse | FailureResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

See DataSource

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

modifySnowflakeDataSource

Modifies a Data Source with the provided unique name, description, and connection settings. If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · modifySnowflakeDataSourceInput · required

Show modifySnowflakeDataSourceInput

The fields for modifying a Snowflake Data Source.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Data Source’s new unique name.

description · String

The Data Source’s new description.

connectionSettings · PartialSnowflakeConnectionSettingsInput

The Data Source’s new connection settings.

Show PartialSnowflakeConnectionSettingsInput

The fields for modifying a Snowflake Data Source’s connection settings.

account · String

The Snowflake account. Only include the part before the “snowflakecomputing.com” part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like “znXXXXX.us-east-2.aws”. For Google Cloud-based accounts, this looks like “ffXXXXX.us-central1.gcp”. If not provided this property will not be modified.

database · String

The Snowflake database name. If not provided this property will not be modified.

warehouse · String

The Snowflake warehouse name. It should be “PROPELLING” if you used the default name in the setup script. If not provided this property will not be modified.

schema · String

The Snowflake schema. If not provided this property will not be modified.

username · String

The Snowflake username. It should be “PROPEL” if you used the default name in the setup script. If not provided this property will not be modified.

password · String

The Snowflake password. If not provided this property will not be modified.

role · String

The Snowflake role. It should be “PROPELLER” if you used the default name in the setup script. If not provided this property will not be modified.

Returns

Nullable

DataSourceOrFailureResponse

Show DataSourceOrFailureResponse

The result of a mutation which creates or modifies a DataSource.

If successful, an DataSourceResponse will be returned; otherwise, a FailureResponse will be returned.

DataSourceOrFailureResponse · DataSourceResponse | FailureResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

See DataSource

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

reconnectDataSource

Attempts to reconnect a Data Source. The mutation then returns the Data Source object.

Arguments

input · idOrUniqueName · required

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

Returns

Nullable

DataSource

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Data Source’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

Show DataSourceType

The types of Data Sources.

• WEBHOOK: Indicates a Webhook Data Source.
• TWILIO_SEGMENT: Indicates a Twilio Segment Data Source.
• S3: Indicates an Amazon S3 Data Source.
• Redshift: Indicates a Redshift Data Source.
• POSTGRESQL: Indicates a PostgreSQL Data Source.
• KAFKA: Indicates a Kafka Data Source.
• Http: Indicates an Http Data Source.
• CLICKHOUSE: Indicates a ClickHouse Data Source.
• AMAZON_DYNAMODB: Indicates an Amazon DynamoDB Data Source.
• AMAZON_DATA_FIREHOSE: Indicates an Amazon Data Firehose Data Source.
• Snowflake: Indicates a Snowflake Data Source.
• INTERNAL: Indicates an internal Data Source.

status · DataSourceStatus · required

The Data Source’s status.

Show DataSourceStatus

The status of a Data Source.

• CREATED: The Data Source has been created, but it is not connected yet.
• CONNECTING: Propel is attempting to connect the Data Source.
• CONNECTED: The Data Source is connected.
• BROKEN: The Data Source failed to connect.
• DELETING: Propel is deleting the Data Source.

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

Show ConnectionSettings

ConnectionSettings · SnowflakeConnectionSettings | InternalConnectionSettings | AmazonDataFirehoseConnectionSettings | AmazonDynamoDBConnectionSettings | ClickHouseConnectionSettings | HttpConnectionSettings | KafkaConnectionSettings | PostgreSqlConnectionSettings | S3ConnectionSettings | TwilioSegmentConnectionSettings | WebhookConnectionSettings

See SnowflakeConnectionSettings

See InternalConnectionSettings

See AmazonDataFirehoseConnectionSettings

See AmazonDynamoDBConnectionSettings

See ClickHouseConnectionSettings

See HttpConnectionSettings

See KafkaConnectionSettings

See PostgreSqlConnectionSettings

See S3ConnectionSettings

See TwilioSegmentConnectionSettings

See WebhookConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

Show DataSourceCheck

The Data Source Check object.

Data Source Checks are executed when setting up your Data Source. They check that Propel will be able to receive data and setup Data Pools.

The exact Checks to perform vary by Data Source. For example, Snowflake-backed Data Sources will have their own specific Checks.

name · String · required

The name of the Data Source Check to be performed.

description · String

A description of the Data Source Check to be performed.

status · DataSourceCheckStatus · required

The status of the Data Source Check (all checks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

See DataSourceCheckStatus

error · Error

If the Data Source Check failed, this field includes a descriptive error message.

See Error

checkedAt · DateTime

The time at which the Data Source Check was performed.

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

introspectTables

Introspects the tables in a Data Source.

Returns the tables along with when they were last cached from the Data Source.

Arguments

input · idOrUniqueName · required

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

Returns

Nullable

TableIntrospection

Show TableIntrospection

The table introspection object.

When setting up a Data Source, Propel may need to introspect tables in order to determine what tables and columns are available to create Data Pools from. The table introspection represents the lifecycle of this operation (whether it’s in-progress, succeeded, or failed) and the resulting tables and columns. These will be captured as table and column objects, respectively.

dataSource · DataSource · required

The Data Source the table introspection was performed for. See DataSource

status · TableIntrospectionStatus · required

The status of the table introspection.

Show TableIntrospectionStatus

The status of a table introspection.

• NOT_STARTED: The table introspection has not started.
• STARTED: The table introspection has started.
• SUCCEEDED: The table introspection succeeded.
• FAILED: The table introspection failed.

createdAt · DateTime · required

The table introspection’s creation date and time in UTC.

createdBy · String · required

The table introspection’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedAt · DateTime · required

The table introspection’s last modification date and time in UTC.

modifiedBy · String · required

The table introspection’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

numTables · Int

The number of tables introspected.

tables · TableConnection

The tables introspected.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

testDataSource

Tests that Propel can actually connect to the data warehouse. Updates the status.

Arguments

input · idOrUniqueName · required

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

Returns

Nullable

DataSourceOrFailureResponse

Show DataSourceOrFailureResponse

The result of a mutation which creates or modifies a DataSource.

If successful, an DataSourceResponse will be returned; otherwise, a FailureResponse will be returned.

DataSourceOrFailureResponse · DataSourceResponse | FailureResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

See DataSource

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

deleteDataSource

Deletes a Data Source by ID and returns its ID if the Data Source was deleted successfully.

Arguments

id · ID · required

deleteDataSourceByName

Deletes a Data Source by unique name and returns its ID if the Data Source was deleted successfully.

Arguments

uniqueName · String · required

createDataPoolV2

Creates a new Data Pool.

Returns the newly created Data Pool or an error message if it fails.

mutation {
  createDataPoolV2(input: {
    dataSource: "DSOXXXXX"
    table: "tacosoft_sales_analytics"
    timestamp: { columnName: "timestamp" }
    columns: [
      {
        columnName: "timestamp",
        type: TIMESTAMP,
        isNullable: true
      },
      {
        columnName: "order_id",
        type: STRING,
        isNullable: true
      },
      {
        columnName: "taco_name",
        type: STRING,
        isNullable: true
      },
      {
        columnName: "toppings",
        type: JSON,
        isNullable: true
      },
      {
        columnName: "quantity",
        type: INT32,
        isNullable: true
      },
      {
        columnName: "taco_unit_price",
        type: INT32,
        isNullable: true
      },
      {
        columnName: "taco_total_price",
        type: INT32,
        isNullable: true
      }
    ]
  }) {
  dataPool {
    id
    uniqueName
    tableSettings {
      orderBy
      engine {
        ... on MergeTreeTableEngine {
          type
        }
        ... on ReplacingMergeTreeTableEngine {
          type
          ver
        }
        ... on SummingMergeTreeTableEngine {
          type
          columns
        }
        ... on AggregatingMergeTreeTableEngine {
          type
        }
        ... on PostgreSqlTableEngine {
          type
        }
      }
    }
  }
}
}

Arguments

input · CreateDataPoolInputV2 · required

Show CreateDataPoolInputV2

The fields for creating a Data Pool.

dataSource · ID

The Data Source that will be used to create the Data Pool.

table · String

The table that the Data Pool will sync from.

timestamp · TimestampInput

The table’s primary timestamp column.

Propel uses the primary timestamp to order and partition your data in Data Pools. It’s part of what makes Propel fast for larger data sets. It will also serve as the time dimension for your Metrics.

If you do not provide a primary timestamp column, you will need to supply an alternate timestamp when querying your Data Pool or its Metrics using the TimeRangeInput.

Show TimestampInput

The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

uniqueName · String

The Data Pool’s unique name. If not specified, Propel will set the ID as the unique name.

description · String

The Data Pool’s description.

columns · [DataPoolColumnInput!]

The list of columns.

Show DataPoolColumnInput

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String

The ClickHouse type to use when type is set to CLICKHOUSE.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

syncing · DataPoolSyncingInput

The Data Pool’s syncing settings.

Show DataPoolSyncingInput

The fields for modifying the Data Pool syncing.

interval · DataPoolSyncInterval · required

See DataPoolSyncInterval

accessControlEnabled · Boolean

Enables or disables access control for the Data Pool.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

tableSettings · TableSettingsInput

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

Show TableSettingsInput

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngineInput

The ClickHouse table engine for the Data Pool’s table.

This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.

See TableEngineInput

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

This field is optional. A default will be chosen based on the Data Pool’s timestamp and uniqueId values, if specified.

ttl · String

The TTL clause for the Data Pool’s table.

Show Deprecated Fields

tenant · TenantInput · deprecated

The Data Pool’s optional tenant ID column. The tenant ID column is used to control access to your data with access policies.

deprecated: Will be removed; use Data Pool Access Policies instead

Show TenantInput

The fields to specify the Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.

columnName · String · required

The name of the column that represents the tenant ID.

uniqueId · UniqueIdInput · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

Show UniqueIdInput

The fields to specify the Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

columnName · String · required

The name of the column that represents the unique ID.

Returns

Nullable

DataPoolResponse

Show DataPoolResponse

The result of a mutation which creates or modifies a Data Pool.

dataPool · DataPool

The Data Pool which was created or modified.

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

See Account

environment · Environment · required

The Data Pool’s Environment.

See Environment

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

See DataPoolStatus

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

See Timestamp

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolColumnConnection

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolColumnConnection

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

See DataPoolSetupTask

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

See DataPoolSyncing

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

See SyncsFilter

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

Whether the Data Pool has access control enabled or not.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

Arguments

expression · String · required

See ValidateExpressionResult

tableSettings · TableSettings · required

The Data Pool’s table settings.

See TableSettings

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

See DataPoolColumn

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

See DataPoolColumn

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

See DataPoolColumn

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

See Error

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

See Tenant

uniqueId · UniqueId · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

See UniqueId

modifyDataPool

Modifies a Data Pool with the provided unique name, description, and data retention time. If any of the optional arguments are omitted, those properties will be unchanged on the Data Pool.

Arguments

input · modifyDataPoolInput · required

Show modifyDataPoolInput

The fields for modifying a Data Pool.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Data Pool to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Data Pool’s new unique name.

description · String

The Data Pool’s new description.

dataRetentionInDays · Int

The Data Pool’s new data retention in days.

syncing · DataPoolSyncingInput

The Data Pool’s new syncing settings.

Show DataPoolSyncingInput

The fields for modifying the Data Pool syncing.

interval · DataPoolSyncInterval · required

See DataPoolSyncInterval

timestamp · TimestampInput

The table’s primary timestamp column.

Propel uses the primary timestamp to order and partition your data in Data Pools. It’s part of what makes Propel fast for larger data sets. It will also serve as the time dimension for your Metrics.

If you do not provide a primary timestamp column, you will need to supply an alternate timestamp when querying your Data Pool or its Metrics using the TimeRangeInput.

Show TimestampInput

The fields to specify the Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

accessControlEnabled · Boolean

Enables or disables access control for the Data Pool.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

Returns

Nullable

DataPoolOrFailureResponse

Show DataPoolOrFailureResponse

The result of a mutation which creates or modifies a Data Pool.

If successful, an DataPoolResponse will be returned; otherwise, a FailureResponse will be returned.

DataPoolOrFailureResponse · DataPoolResponse | FailureResponse

Show DataPoolResponse

The result of a mutation which creates or modifies a Data Pool.

dataPool · DataPool

The Data Pool which was created or modified.

See DataPool

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

retryDataPoolSetup

Retries to set up the Data Pool identified by the given ID.

Arguments

id · ID · required

Returns

Nullable

DataPool

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Data Pool’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

Show DataPoolStatus

The status of a Data Pool.

• CREATED: The Data Pool has been created and will be set up soon.
• PENDING: Propel is attempting to set up the Data Pool.
• LIVE: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
• SETUP_FAILED: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
• CONNECTING
• CONNECTED
• BROKEN
• PAUSING
• PAUSED
• DELETING: Propel is deleting the Data Pool and all of its associated data.

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

Show Timestamp

A Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

type · String · required

The primary timestamp column’s type.

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

Show DataPoolSetupTask

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

name · String · required

The name of the Data Pool Setup Task to be performed.

description · String

A description of the Data Pool Setup Task to be performed.

status · DataPoolSetupTaskStatus · required

The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

See DataPoolSetupTaskStatus

error · Error

If the Data Pool Setup Task failed, this field includes a descriptive error message.

See Error

completedAt · DateTime

The time at which the Data Pool Setup Task was completed.

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

Show DataPoolSyncing

Settings related to Data Pool syncing.

status · DataPoolSyncStatus · required

Indicates whether syncing is enabled or disabled.

See DataPoolSyncStatus

interval · DataPoolSyncInterval

The syncing interval.

Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

See DataPoolSyncInterval

lastSyncedAt · DateTime

The date and time of the most recent Sync in UTC.

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

Show SyncsFilter

The filter to apply when listing the Syncs for a Data Pool.

• EMPTY: Returns only Syncs with empty records.
• NOT_EMPTY: Returns only Syncs that contain one or more records.
• ALL: Returns all Syncs, regardless of whether they contain records or not.

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

Whether the Data Pool has access control enabled or not.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

Arguments

expression · String · required

Show ValidateExpressionResult

Response returned by the validateExpression query for validating expressions in Custom Metrics.

Returns whether the expression is valid or not with a reason explaining why.

valid · Boolean · required

True if the expression is valid, false otherwise.

reason · String

The reason for why the expression is not valid in case it isn’t, null otherwise.

tableSettings · TableSettings · required

The Data Pool’s table settings.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

Show Tenant

A Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.

columnName · String · required

The name of the column that represents the tenant ID.

type · String · required

The tenant ID column’s type.

uniqueId · UniqueId · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

Show UniqueId

A Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

columnName · String · required

The name of the column that represents the unique ID.

retryDataPoolSetupByName

Retries to set up the Data Pool identified by the given unique name.

Arguments

uniqueName · String · required

Returns

Nullable

DataPool

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Data Pool’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

Show DataPoolStatus

The status of a Data Pool.

• CREATED: The Data Pool has been created and will be set up soon.
• PENDING: Propel is attempting to set up the Data Pool.
• LIVE: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
• SETUP_FAILED: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
• CONNECTING
• CONNECTED
• BROKEN
• PAUSING
• PAUSED
• DELETING: Propel is deleting the Data Pool and all of its associated data.

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

Show Timestamp

A Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

type · String · required

The primary timestamp column’s type.

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

Show DataPoolSetupTask

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

name · String · required

The name of the Data Pool Setup Task to be performed.

description · String

A description of the Data Pool Setup Task to be performed.

status · DataPoolSetupTaskStatus · required

The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

See DataPoolSetupTaskStatus

error · Error

If the Data Pool Setup Task failed, this field includes a descriptive error message.

See Error

completedAt · DateTime

The time at which the Data Pool Setup Task was completed.

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

Show DataPoolSyncing

Settings related to Data Pool syncing.

status · DataPoolSyncStatus · required

Indicates whether syncing is enabled or disabled.

See DataPoolSyncStatus

interval · DataPoolSyncInterval

The syncing interval.

Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

See DataPoolSyncInterval

lastSyncedAt · DateTime

The date and time of the most recent Sync in UTC.

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

Show SyncsFilter

The filter to apply when listing the Syncs for a Data Pool.

• EMPTY: Returns only Syncs with empty records.
• NOT_EMPTY: Returns only Syncs that contain one or more records.
• ALL: Returns all Syncs, regardless of whether they contain records or not.

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

Whether the Data Pool has access control enabled or not.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

Arguments

expression · String · required

Show ValidateExpressionResult

Response returned by the validateExpression query for validating expressions in Custom Metrics.

Returns whether the expression is valid or not with a reason explaining why.

valid · Boolean · required

True if the expression is valid, false otherwise.

reason · String

The reason for why the expression is not valid in case it isn’t, null otherwise.

tableSettings · TableSettings · required

The Data Pool’s table settings.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

Show Tenant

A Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.

columnName · String · required

The name of the column that represents the tenant ID.

type · String · required

The tenant ID column’s type.

uniqueId · UniqueId · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

Show UniqueId

A Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

columnName · String · required

The name of the column that represents the unique ID.

inspectDataPoolSchema

Extracts the schema from the table and updates the schema object.

Arguments

input · idOrUniqueName · required

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

Returns

Nullable

DataPoolOrFailureResponse

Show DataPoolOrFailureResponse

The result of a mutation which creates or modifies a Data Pool.

If successful, an DataPoolResponse will be returned; otherwise, a FailureResponse will be returned.

DataPoolOrFailureResponse · DataPoolResponse | FailureResponse

Show DataPoolResponse

The result of a mutation which creates or modifies a Data Pool.

dataPool · DataPool

The Data Pool which was created or modified.

See DataPool

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

testDataPool

Tests that Propel has access to the Data Pool’s table in its corresponding Data Source and will be able to Sync data. Updates the status.

Arguments

input · idOrUniqueName · required

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

Returns

Nullable

DataPoolOrFailureResponse

Show DataPoolOrFailureResponse

The result of a mutation which creates or modifies a Data Pool.

If successful, an DataPoolResponse will be returned; otherwise, a FailureResponse will be returned.

DataPoolOrFailureResponse · DataPoolResponse | FailureResponse

Show DataPoolResponse

The result of a mutation which creates or modifies a Data Pool.

dataPool · DataPool

The Data Pool which was created or modified.

See DataPool

Show FailureResponse

The failure response object.

error · Error · required

The error that caused the failure.

See Error

deleteDataPool

Deletes a Data Pool by ID and returns its ID if the Data Pool was deleted successfully.

Arguments

id · ID · required

deleteDataPoolByName

Deletes a Data Pool by unique name and returns its ID if the Data Pool was deleted successfully.

Arguments

uniqueName · String · required

disableSyncing

Disables syncing of a Data Pool.

Arguments

id · ID · required

Returns

Nullable

DataPool

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Data Pool’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

Show DataPoolStatus

The status of a Data Pool.

• CREATED: The Data Pool has been created and will be set up soon.
• PENDING: Propel is attempting to set up the Data Pool.
• LIVE: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
• SETUP_FAILED: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
• CONNECTING
• CONNECTED
• BROKEN
• PAUSING
• PAUSED
• DELETING: Propel is deleting the Data Pool and all of its associated data.

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

Show Timestamp

A Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

type · String · required

The primary timestamp column’s type.

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

Show DataPoolSetupTask

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

name · String · required

The name of the Data Pool Setup Task to be performed.

description · String

A description of the Data Pool Setup Task to be performed.

status · DataPoolSetupTaskStatus · required

The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

See DataPoolSetupTaskStatus

error · Error

If the Data Pool Setup Task failed, this field includes a descriptive error message.

See Error

completedAt · DateTime

The time at which the Data Pool Setup Task was completed.

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

Show DataPoolSyncing

Settings related to Data Pool syncing.

status · DataPoolSyncStatus · required

Indicates whether syncing is enabled or disabled.

See DataPoolSyncStatus

interval · DataPoolSyncInterval

The syncing interval.

Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

See DataPoolSyncInterval

lastSyncedAt · DateTime

The date and time of the most recent Sync in UTC.

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

Show SyncsFilter

The filter to apply when listing the Syncs for a Data Pool.

• EMPTY: Returns only Syncs with empty records.
• NOT_EMPTY: Returns only Syncs that contain one or more records.
• ALL: Returns all Syncs, regardless of whether they contain records or not.

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

Whether the Data Pool has access control enabled or not.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

Arguments

expression · String · required

Show ValidateExpressionResult

Response returned by the validateExpression query for validating expressions in Custom Metrics.

Returns whether the expression is valid or not with a reason explaining why.

valid · Boolean · required

True if the expression is valid, false otherwise.

reason · String

The reason for why the expression is not valid in case it isn’t, null otherwise.

tableSettings · TableSettings · required

The Data Pool’s table settings.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

Show Tenant

A Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.

columnName · String · required

The name of the column that represents the tenant ID.

type · String · required

The tenant ID column’s type.

uniqueId · UniqueId · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

Show UniqueId

A Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

columnName · String · required

The name of the column that represents the unique ID.

enableSyncing

Re-enables syncing of a Data Pool.

Arguments

id · ID · required

Returns

Nullable

DataPool

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Data Pool’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

Show DataPoolStatus

The status of a Data Pool.

• CREATED: The Data Pool has been created and will be set up soon.
• PENDING: Propel is attempting to set up the Data Pool.
• LIVE: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
• SETUP_FAILED: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
• CONNECTING
• CONNECTED
• BROKEN
• PAUSING
• PAUSED
• DELETING: Propel is deleting the Data Pool and all of its associated data.

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

Show Timestamp

A Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

type · String · required

The primary timestamp column’s type.

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

Show DataPoolSetupTask

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

name · String · required

The name of the Data Pool Setup Task to be performed.

description · String

A description of the Data Pool Setup Task to be performed.

status · DataPoolSetupTaskStatus · required

The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

See DataPoolSetupTaskStatus

error · Error

If the Data Pool Setup Task failed, this field includes a descriptive error message.

See Error

completedAt · DateTime

The time at which the Data Pool Setup Task was completed.

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

Show DataPoolSyncing

Settings related to Data Pool syncing.

status · DataPoolSyncStatus · required

Indicates whether syncing is enabled or disabled.

See DataPoolSyncStatus

interval · DataPoolSyncInterval

The syncing interval.

Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

See DataPoolSyncInterval

lastSyncedAt · DateTime

The date and time of the most recent Sync in UTC.

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

Show SyncsFilter

The filter to apply when listing the Syncs for a Data Pool.

• EMPTY: Returns only Syncs with empty records.
• NOT_EMPTY: Returns only Syncs that contain one or more records.
• ALL: Returns all Syncs, regardless of whether they contain records or not.

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

Whether the Data Pool has access control enabled or not.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

Arguments

expression · String · required

Show ValidateExpressionResult

Response returned by the validateExpression query for validating expressions in Custom Metrics.

Returns whether the expression is valid or not with a reason explaining why.

valid · Boolean · required

True if the expression is valid, false otherwise.

reason · String

The reason for why the expression is not valid in case it isn’t, null otherwise.

tableSettings · TableSettings · required

The Data Pool’s table settings.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

Show Tenant

A Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.

columnName · String · required

The name of the column that represents the tenant ID.

type · String · required

The tenant ID column’s type.

uniqueId · UniqueId · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

Show UniqueId

A Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

columnName · String · required

The name of the column that represents the unique ID.

createCountMetric

Creates a new Count Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateCountMetricInput

Show CreateCountMetricInput

The fields for creating a new Count Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

createCountDistinctMetric

Creates a new Count Distinct Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateCountDistinctMetricInput

Show CreateCountDistinctMetricInput

The fields for creating a new Count Distinct Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

dimension · DimensionInput · required

The Dimension over which the count distinct operation is going to be performed.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

createSumMetric

Creates a new Sum Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateSumMetricInput

Show CreateSumMetricInput

The fields for creating a new Sum Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

measure · DimensionInput · required

The column to be summed.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

createAverageMetric

Creates a new Average Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateAverageMetricInput

Show CreateAverageMetricInput

The fields for creating a new Average Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

measure · DimensionInput · required

The column to be averaged.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

createMinMetric

Creates a new Min Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateMinMetricInput

Show CreateMinMetricInput

The fields for creating a new Minimum (Min) Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

measure · DimensionInput · required

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

createMaxMetric

Creates a new Max Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateMaxMetricInput

Show CreateMaxMetricInput

The fields for creating a new Maximum (Max) Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

measure · DimensionInput · required

The column to calculate the maximum from.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

createCustomMetric

Creates a new Custom Metric from the given Data Pool and returns the newly created Metric (or an error message if creating the Metric fails).

Arguments

input · CreateCustomMetricInput

Show CreateCustomMetricInput

The fields for creating a new Custom Metric.

dataPool · ID · required

The Data Pool that powers this Metric.

uniqueName · String

The Metric’s unique name. If not specified, Propel will set the ID as unique name.

description · String

The Metric’s description.

filterSql · String

The Metric’s Filters, in the form of SQL. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

dimensions · [DimensionInput!]

The Metric’s Dimensions. Dimensions define the columns that will be available to filter the Metric at query time.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

expression · String · required

The expression that defines the aggregation function for this Metric.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s Filters. Metric Filters allow defining a Metric with a subset of records from the given Data Pool. If no Filters are present, all records will be included.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

modifyMetric

Modifies a Metric by ID with the provided unique name, description, and Dimensions. If any of the optional arguments are omitted, those properties will be unchanged on the Metric.

Arguments

input · ModifyMetricInput

Show ModifyMetricInput

The fields for modifying a Metric.

metric · ID · required

The ID of the Metric to modify.

uniqueName · String

The Metric’s new unique name.

description · String

The Metric’s new description.

dimensions · [DimensionInput!]

The Metric’s new Dimensions. Used to add or remove Dimensions.

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

filterSql · String

The Metric’s new Filters, in the form of SQL. Used to add or remove Metric Filters.

accessControlEnabled · Boolean

Enables or disables access control for the Metric.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The Metric’s new Filters. Used to add or remove Metric Filters.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Nullable

MetricResponse

Show MetricResponse

The result of a mutation which creates or modifies a Metric.

metric · Metric

The Metric which was created or modified.

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

See Account

environment · Environment · required

The Metric’s Environment.

See Environment

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

See Dimension

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

See Dimension

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

See MetricType

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

See MetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

See Dimension

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

See CounterInput

See CounterResponse

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

See TimeSeriesInput

See TimeSeriesResponse

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

See LeaderboardInput

See LeaderboardResponse

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

migrateMetric

Migrates a Metric from one Data Pool to another.

Arguments

input · MigrateMetricInput · required

Show MigrateMetricInput

The fields for migrating a Metric’s Data Pool.

metricId · ID · required

The Metric that is going to be migrated.

newDataPoolId · ID · required

The DataPool to which the Metric is going to be migrated.

Returns

Nullable

Metric

Show Metric

The Metric object.

A Metric is a business indicator measured over time.

id · ID · required

The Metric’s unique identifier.

uniqueName · String · required

The Metric’s unique name.

description · String · required

The Metric’s description.

account · Account · required

The Metric’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Metric’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Metric’s creation date and time in UTC.

modifiedAt · DateTime · required

The Metric’s last modification date and time in UTC.

createdBy · String · required

The Metric’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Metric’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Data Pool that powers this Metric. See DataPool

dimensions · [Dimension!] · required

The Metric’s Dimensions. These Dimensions are available to Query Filters.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

timestamp · Dimension

The Metric’s timestamp, if any. This is the same as its Data Pool’s timestamp, if any.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

boosters · BoosterConnection · required

List the Boosters associated to the Metric.

Arguments

first · Int

after · String

last · Int

before · String

See BoosterConnection

type · MetricType · required

The Metric’s type. The different Metric types determine how the values are calculated.

Show MetricType

The available Metric types.

• COUNT: Counts the number of records that matches the Metric Filters. For time series, it will count the values for each time granularity.
• SUM: Sums the values of the specified column for every record that matches the Metric Filters. For time series, it will sum the values for each time granularity.
• COUNT_DISTINCT: Counts the number of distinct values in the specified column for every record that matches the Metric Filters. For time series, it will count the distinct values for each time granularity.
• AVERAGE: Averages the values of the specified column for every record that matches the Metric Filters. For time series, it will average the values for each time granularity.
• MIN: Selects the minimum value of the specified column for every record that matches the Metric Filters. For time series, it will select the minimum value for each time granularity.
• MAX: Selects the maximum value of the specified column for every record that matches the Metric Filters. For time series, it will select the maximum value for each time granularity.
• CUSTOM: Aggregates values based on the provided custom expression.

settings · MetricSettings · required

The settings for the Metric. The settings are specific to the Metric’s type.

Show MetricSettings

A Metric’s settings, depending on its type.

MetricSettings · CountMetricSettings | SumMetricSettings | CountDistinctMetricSettings | AverageMetricSettings | MinMetricSettings | MaxMetricSettings | CustomMetricSettings

See CountMetricSettings

See SumMetricSettings

See CountDistinctMetricSettings

See AverageMetricSettings

See MinMetricSettings

See MaxMetricSettings

See CustomMetricSettings

Show Deprecated Fields

measure · Dimension · deprecated

The Metric’s measure. Access this from the Metric’s settings object instead.

deprecated: Use the Metric settings object instead.

Show Dimension

The Dimension object that represents a column in a table.

columnName · String · required

The column name it represents.

type · String · required

The column data type.

isNullable · Boolean

Whether the column is nullable.

Show Deprecated Fields

isUniqueKey · Boolean · deprecated

Whether the column is a unique key.

deprecated: This is Snowflake-specific, and will be removed

stats · DimensionStatistics · deprecated

The statistics for the dimension values. Fetching statistics incurs query costs.

deprecated: Issue normal queries for calculating stats

See DimensionStatistics

counter · CounterResponse · deprecated

Query the Metric in counter format. Returns the Metric’s value for the given time range and filters.

deprecated: Use the top-level counter query instead

Arguments

input · CounterInput · required

Show CounterInput

The fields for querying a Metric in counter format.

A Metric’s counter query returns a single value over a given time range.

metric · MetricInput

The Metric to query. You can query a pre-configured Metric by ID or name, or you can query an ad hoc Metric that you define inline.

See MetricInput

timeRange · TimeRangeInput

The time range for calculating the counter.

See TimeRangeInput

timeZone · String

The time zone to use. Dates and times are always returned in UTC, but setting the time zone influences relative time ranges and granularities.

You can set this to “America/Los_Angeles”, “Europe/Berlin”, or any other value in the IANA time zone database. Defaults to “UTC”.

filterSql · String

The Query Filters to apply before retrieving the counter data, in the form of SQL. If no Query Filters are provided, all data is included.

Show Deprecated Fields

metricId · ID · deprecated

The ID of the Metric to query.

Required if metricName is not specified.

deprecated: Use metric

metricName · String · deprecated

The name of the Metric to query.

Required if metricId is not specified.

deprecated: Use metric

filters · [FilterInput!] · deprecated

The Query Filters to apply before retrieving the counter data. If no Query Filters are provided, all data is included.

deprecated: Use filterSql instead

See FilterInput

Show CounterResponse

The counter response object. It contains a single Metric value for the given time range and Query Filters.

value · String

The value of the counter.

query · QueryInfo · required

The Query statistics and metadata.

See QueryInfo

timeSeries · TimeSeriesResponse · deprecated

Query the Metric in time series format. Returns arrays of timestamps and the Metric’s values for the given time range and filters.

deprecated: Use the top-level timeSeries query instead

Arguments

input · TimeSeriesInput · required

Show TimeSeriesInput

The fields for querying a Metric in time series format.

A Metric’s time series query returns the values over a given time range aggregated by a given time granularity; day, month, or year, for example.

metric · MetricInput

The Metric to Query. It can be a pre-created one or it can be inlined here.

See MetricInput

timeRange · TimeRangeInput

The time range for calculating the time series.

See TimeRangeInput

timeZone · String

The time zone to use. Dates and times are always returned in UTC, but setting the time zone influences relative time ranges and granularities.

You can set this to “America/Los_Angeles”, “Europe/Berlin”, or any other value in the IANA time zone database. Defaults to “UTC”.

granularity · TimeSeriesGranularity · required

The time granularity (hour, day, month, etc.) to aggregate the Metric values by.

See TimeSeriesGranularity

filterSql · String

The Query Filters to apply before retrieving the time series data, in the form of SQL. If no Query Filters are provided, all data is included.

groupBy · [String!]

Columns to group by.

Show Deprecated Fields

metricId · ID · deprecated

The ID of the Metric to query.

Required if metricName is not specified.

deprecated: Use metric

metricName · String · deprecated

The name of the Metric to query.

Required if metricId is not specified.

deprecated: Use metric

filters · [FilterInput!] · deprecated

The Query Filters to apply before retrieving the time series data. If no Query Filters are provided, all data is included.

deprecated: Use filterSql instead

See FilterInput

Show TimeSeriesResponse

The time series response object. It contains an array of time series labels and an array of Metric values for the given time range and Query Filters.

labels · [String!] · required

The time series labels.

values · [String] · required

The time series values.

groups · [TimeSeriesResponseGroup!]

The time series values for each group in groupBy, if specified.

See TimeSeriesResponseGroup

query · QueryInfo · required

The Query statistics and metadata.

See QueryInfo

leaderboard · LeaderboardResponse · deprecated

Query the Metric in leaderboard format. Returns a table (array of rows) with the selected dimensions and the Metric’s corresponding values for the given time range and filters.

deprecated: Use the top-level leaderboard query instead

Arguments

input · LeaderboardInput · required

Show LeaderboardInput

The fields for querying a Metric in leaderboard format.

A Metric’s leaderboard query returns an ordered table of Dimension and Metric values over a given time range.

metric · MetricInput

The Metric to query. You can query a pre-configured Metric by ID or name, or you can query an ad hoc Metric that you define inline.

See MetricInput

timeRange · TimeRangeInput

The time range for calculating the leaderboard.

See TimeRangeInput

timeZone · String

The time zone to use. Dates and times are always returned in UTC, but setting the time zone influences relative time ranges and granularities.

You can set this to “America/Los_Angeles”, “Europe/Berlin”, or any other value in the IANA time zone database. Defaults to “UTC”.

dimensions · [DimensionInput!] · required

One or many Dimensions to group the Metric values by. Typically, Dimensions in a leaderboard are what you want to compare and rank.

See DimensionInput

sort · Sort

The sort order of the rows. It can be ascending (ASC) or descending (DESC) order. Defaults to descending (DESC) order when not provided.

See Sort

rowLimit · Int · required

The number of rows to be returned. It can be a number between 1 and 1,000.

filterSql · String

The Query Filters to apply before retrieving the leaderboard data, in the form of SQL. If no Query Filters are provided, all data is included.

Show Deprecated Fields

metricId · ID · deprecated

The ID of the Metric to query.

Required if metricName is not specified.

deprecated: Use metric

metricName · String · deprecated

The name of the Metric to query.

Required if metricId is not specified.

deprecated: Use metric

filters · [FilterInput!] · deprecated

The Query Filters to apply before retrieving the leaderboard data. If no Query Filters are provided, all data is included.

deprecated: Use filterSql instead

See FilterInput

Show LeaderboardResponse

The leaderboard response object. It contains an array of headers and a table (array of rows) with the selected Dimensions and corresponding Metric values for the given time range and Query Filters.

headers · [String!] · required

The table headers. It contains the Dimension and Metric names.

rows · [[String]!] · required

An ordered array of rows. Each row contains the Dimension values and the corresponding Metric value. A Dimension value can be empty. A Metric value will never be empty.

query · QueryInfo · required

The Query statistics and metadata.

See QueryInfo

policies · PolicyConnection · required · deprecated

List the Policies associated to the Metric.

deprecated: Use Data Pool Access Policies instead

Arguments

first · Int

after · String

last · Int

before · String

See PolicyConnection

accessControlEnabled · Boolean · required · deprecated

Whether or not access control is enabled for the Metric.

deprecated: Use Data Pool Access Policies instead

deleteMetric

Deletes a Metric by ID and returns its ID if the Metric was deleted successfully.

Arguments

id · ID · required

deleteMetricByName

Deletes a Metric by unique name and returns its ID if the Metric was deleted successfully.

Arguments

uniqueName · String · required

createBooster

Creates a new Booster for the given Metric and returns the newly created Booster.

A Booster significantly improves the query performance for a Metric.

Arguments

input · CreateBoosterInput · required

Show CreateBoosterInput

The fields for creating a new Booster.

Boosters can be understood as an aggregating index. The index is formed from left to right as follows:

1. The Data Pool’s Tenant ID column (if present)
2. Metric Filter columns (if present)
3. Query Filter Dimensions (see dimensions)
4. The Data Pool’s timestamp column

metric · ID · required

The Booster’s Metric.

dimensions · [DimensionInput!] · required

Dimensions to include in the Booster.

Follow these guidelines when specifying Dimensions:

1. Specify Dimensions in descending order of importance for filtering and in ascending order of cardinality.
2. Take into consideration hierarchical relationships as well (for example, a “country” Dimension should appear before a “state” Dimension).

Show DimensionInput

The fields for creating or modifying a Dimension.

columnName · String · required

The name of the column to create the Dimension from.

Returns

Nullable

BoosterResponse

Show BoosterResponse

The result of a mutation which creates or modifies a Booster.

booster · Booster

The Booster which was created or modified.

Show Booster

Boosters allow you to optimize Metric Queries for a subset of commonly used Dimensions. A Metric can have one or many Boosters to optimize for the different Query patterns.

Boosters can be understood as an aggregating index. The index is formed from left to right as follows:

1. The Data Pool’s Tenant ID column (if present)
2. Metric Filter columns (if present)
3. Query Filter Dimensions (see dimensions)
4. The Data Pool’s timestamp column

id · ID · required

The Booster’s unique identifier.

account · Account · required

The Booster’s Account.

See Account

environment · Environment · required

The Booster’s Environment.

See Environment

createdAt · DateTime · required

The Booster’s creation date and time in UTC.

modifiedAt · DateTime · required

The Booster’s last modification date and time in UTC.

createdBy · String · required

The Booster’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Booster’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

metric · Metric · required

The Metric this Booster is associated to. See Metric

status · BoosterStatus · required

The status of the Booster (once LIVE it will be available for speeding up Metric queries).

See BoosterStatus

error · Error

If the Booster fails during the optimization process, this field includes a descriptive error message.

See Error

progress · Float

When the Booster is OPTIMIZING, this represents its progress as a number from 0 to 1. In all other states, progress is null.

dimensions · [Dimension!] · required

Dimensions included in the Booster.

See Dimension

recordCount · String

The number of records in the Booster.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Booster.

deleteBooster

Deletes a Booster by ID and then returns the same ID if the Booster was deleted successfully.

A Booster significantly improves the query performance for a Metric.

Arguments

id · ID · required

createDeletionJob

Schedules a new Deletion Job on the specified Data Pool.

Arguments

input · CreateDeletionJobInput · required

Show CreateDeletionJobInput

The fields for creating a Deletion Job.

dataPool · ID · required

The Data Pool that is going to get the data deleted

filterSql · String

The filters that will be used for deleting data, in the form of SQL. Data matching these filters will be deleted.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The list of filters that will be used for deleting data. Data matching these filters will be deleted.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Non-null

DeletionJobResponse

Show DeletionJobResponse

The response returned by the Deletion Job.

job · DeletionJob · required

The Deletion Job that was just created.

Show DeletionJob

Deletion Job scheduled for a specific Data Pool.

The Deletion Job represents the asynchronous process of deleting data given some filters inside a Data Pool. It tracks the deletion process until it is finished, showing the progress and the outcome when it is finished.

id · ID · required

The Deletion Job’s ID.

createdAt · DateTime · required

The Deletion Job’s creation date and time in UTC.

createdBy · String · required

Who created the Deletion Job.

modifiedAt · DateTime · required

The Deletion Job’s last modification date and time in UTC.

modifiedBy · String · required

Who last modified the Deletion Job.

account · Account · required

Account to which the Deletion Job belongs.

See Account

environment · Environment · required

Environment to which the Deletion Job belongs.

See Environment

dataPool · DataPool · required

The Data Pool whose records will be deleted by the Deletion Job. See DataPool

status · JobStatus · required

The current Deletion Job’s status.

See JobStatus

filterSql · String

The filters that will be used for deleting data, in the form of SQL. Data matching the filters will be deleted.

error · Error

The error that occurred while deleting data, if any.

See Error

progress · Float · required

The current progress of the Deletion Job, from 0.0 to 1.0.

startedAt · DateTime

The time at which the Deletion Job started.

succeededAt · DateTime

The time at which the Deletion Job succeeded.

failedAt · DateTime

The time at which the Deletion Job failed.

Show Deprecated Fields

filters · [Filter!] · deprecated

The list of filters that will be used for deleting data. Data matching the filters will be deleted.

deprecated: Use filterSql instead

See Filter

createAddColumnToDataPoolJob

Schedules a new AddColumnToDataPoolJob on the specified Data Pool.

Arguments

input · CreateAddColumnToDataPoolJobInput · required

Show CreateAddColumnToDataPoolJobInput

The fields for creating an Add Column Job.

dataPool · ID · required

The Data Pool to which the column will be added.

columnName · String · required

Name of the new column.

columnType · ColumnType · required

Type of the new column.

Show ColumnType

The Propel data types.

• BOOLEAN: True or false.
• STRING: A variable-length string.
• FLOAT: A 32-bit signed double-precision floating point number.
• DOUBLE: A 64-bit signed double-precision floating point number.
• INT8: An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.
• INT16: A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.
• INT32: A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.
• INT64: A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.
• DATE: A date without a timestamp. For example, “YYYY-MM-DD”.
• TIMESTAMP: A date with a timestamp. For example, “yyy-MM-dd HH:mm:ss”.
• JSON: A JavaScript Object Notation (JSON) document.
• CLICKHOUSE: A ClickHouse-specific type.

columnClickHouseType · String

The ClickHouse type of the new column when columnType is set to CLICKHOUSE.

jsonProperty · String

JSON property to which the new column corresponds.

Returns

Non-null

AddColumnToDataPoolJobResponse

Show AddColumnToDataPoolJobResponse

The response returned by the Add Column Job.

job · AddColumnToDataPoolJob · required

The AddColumnToDataPool Job that was just created.

Show AddColumnToDataPoolJob

AddColumnToDataPoolJob scheduled for a specific Data Pool.

The Add Column Job represents the asynchronous process of adding a column, given its name and type, to a Data Pool. It tracks the process of adding a column until it is finished, showing the progress and the outcome when it is finished.

id · ID · required

The AddColumnToDataPoolJob’s ID.

createdAt · DateTime · required

The AddColumnToDataPoolJob’s creation date and time in UTC.

createdBy · String · required

Who created the AddColumnToDataPoolJob.

modifiedAt · DateTime · required

The AddColumnToDataPoolJob’s last modification date and time in UTC.

modifiedBy · String · required

Who modified the AddColumnToDataPoolJob last.

account · Account · required

Account to which the AddColumnToDataPoolJob belongs.

See Account

environment · Environment · required

Environment to which the AddColumnToDataPoolJob belongs.

See Environment

dataPool · DataPool · required

The Data Pool to which a column will be added by the Job. See DataPool

status · JobStatus · required

The current AddColumnToDataPoolJob’s status.

See JobStatus

columnName · String · required

Name of the new column.

columnType · ColumnType · required

Type of the new column.

See ColumnType

columnClickHouseType · String

The ClickHouse type of the new column when columnType is set to CLICKHOUSE.

jsonProperty · String

JSON property to which the new column corresponds.

error · Error

The error that occurred while adding the column data, if any.

See Error

progress · Float · required

The current progress of the AddColumnToDataPool Job, from 0.0 to 1.0.

startedAt · DateTime

The time at which the AddColumnToDataPool Job started.

succeededAt · DateTime

The time at which the AddColumnToDataPool Job succeeded.

failedAt · DateTime

The time at which the AddColumnToDataPool Job failed.

createUpdateDataPoolRecordsJob

Schedules a new UpdateDataPoolRecords Job on the specified Data Pool.

Arguments

input · CreateUpdateDataPoolRecordsJobInput · required

Show CreateUpdateDataPoolRecordsJobInput

The fields for creating an Update Data Pool Records Job.

dataPool · ID · required

The Data Pool that is going to get its records updated.

filterSql · String

The filters that will be used for updating records, in the form of SQL. Records matching these filters will be updated.

set · [UpdateDataPoolRecordsJobSetColumnInput!] · required

Describes how the job will update the records.

Show UpdateDataPoolRecordsJobSetColumnInput

The fields for creating an Update Data Pool Records Job.

{
"column": "status",
"expression": "'completed'"
}

{
"column": "counter",
"expression": "counter + 1"
}

{
"column": "full_name",
"expression": "concat(first_name, ' ', last_name)"
}

column · String · required

The name of the column to update.

expression · String · required

The value to which the column will be updated. Once evaluated, it should be of the same data type as the column.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The list of filters that will be used for updating records. Records matching these filters will be updated.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Non-null

UpdateDataPoolRecordsJobResponse

Show UpdateDataPoolRecordsJobResponse

The response returned by the Update Data Pool Records Job.

job · UpdateDataPoolRecordsJob · required

The UpdateDataPoolRecords Job that was just created.

Show UpdateDataPoolRecordsJob

UpdateDataPoolRecords Job scheduled for a specific Data Pool. The Update Data Pool Records Job represents the asynchronous process of updating records given some filters, inside a Data Pool. It tracks the process of updating records until it is finished, showing the progress and the outcome when it is finished.

id · ID · required

The UpdateDataPoolRecords Job’s ID

createdAt · DateTime · required

The UpdateDataPoolRecords Job’s creation date and time in UTC

createdBy · String · required

Who created the UpdateDataPoolRecords Job

modifiedAt · DateTime · required

The UpdateDataPoolRecords Job’s last modification date and time in UTC

modifiedBy · String · required

Who last modified the UpdateDataPoolRecords Job

account · Account · required

Account to which the UpdateDataPoolRecords Job belongs

See Account

environment · Environment · required

Environment to which the UpdateDataPoolRecords Job belongs

See Environment

dataPool · DataPool · required

The Data Pool whose records will be updated by the UpdateDataPoolRecords Job See DataPool

status · JobStatus · required

The current UpdateDataPoolRecords Job’s status

See JobStatus

filterSql · String

The filters that will be used for updating data, in the form of SQL. Data matching the filters will be updated.

set · [UpdateDataPoolRecordsJobSetColumn!] · required

Describes how the job will update the records.

See UpdateDataPoolRecordsJobSetColumn

error · Error

The error that occurred while updating data, if any.

See Error

progress · Float · required

The current progress of the UpdateDataPoolRecords Job, from 0.0 to 1.0.

startedAt · DateTime

The time at which the UpdateDataPoolRecords Job started.

succeededAt · DateTime

The time at which the UpdateDataPoolRecords Job succeeded.

failedAt · DateTime

The time at which the UpdateDataPoolRecords Job failed.

Show Deprecated Fields

filters · [Filter!] · deprecated

The list of filters that will be used for updating data. Data matching the filters will be updated.

deprecated: Use filterSql instead

See Filter

syncDataPool

Manually trigger a Sync for a Data Pool.

Arguments

dataPoolId · ID · required

Returns

Nullable

Sync

Show Sync

The Sync object.

This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.

id · ID · required

The Sync’s unique identifier.

account · Account

The Sync’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment

The Sync’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Sync’s creation date and time in UTC.

modifiedAt · DateTime · required

The Sync’s last modification date and time in UTC.

createdBy · String · required

The Sync’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Sync’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Sync’s Data Pool. See DataPool

dataSource · DataSource

The Sync’s Data Pool’s Data Source.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

processedRecords · String

The number of new, updated, and deleted records contained within the Sync, if known. This excludes filtered records.

size · String

The (compressed) size of the Sync, in bytes, if known.

status · SyncStatus · required

The status of the Sync (all Syncs begin as SYNCING before transitioning to SUCCEEDED or FAILED).

Show SyncStatus

The status of a Sync.

• SYNCING: Propel is actively syncing records contained within the Sync.
• SUCCEEDED: The Sync succeeded. Propel successfully synced all records contained within the Sync.
• FAILED: The Sync failed. Propel failed to sync some or all records contained within the Sync.
• DELETING: Propel is deleting the Sync.

startedAt · DateTime

The time at which the Sync started.

succeededAt · DateTime

The time at which the Sync succeeded.

failedAt · DateTime

The time at which the Sync failed.

error · Error

If the Sync failed, this represents the reason the Sync failed.

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

Show Deprecated Fields

newRecords · String · deprecated

The number of new records contained within the Sync, if known. This excludes filtered records.

deprecated: All records are considered to be processed; see processedRecords instead

updatedRecords · String · deprecated

The number of updated records contained within the Sync, if known. This excludes filtered records.

deprecated: All records are considered to be processed; see processedRecords instead

deletedRecords · String · deprecated

The number of deleted records contained within the Sync, if known. This excludes filtered records.

deprecated: All records are considered to be processed; see processedRecords instead

invalidRecords · String · deprecated

The number of filtered records contained within the Sync, due to issues such as a missing timestamp Dimension, if any are known to be invalid.

deprecated: All records are considered to be processed; see processedRecords instead

resyncDataPool

Manually trigger a re-Sync for a Data Pool.

Arguments

dataPoolId · ID · required

Returns

Nullable

Sync

Show Sync

The Sync object.

This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.

id · ID · required

The Sync’s unique identifier.

account · Account

The Sync’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment

The Sync’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Sync’s creation date and time in UTC.

modifiedAt · DateTime · required

The Sync’s last modification date and time in UTC.

createdBy · String · required

The Sync’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Sync’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataPool · DataPool

The Sync’s Data Pool. See DataPool

dataSource · DataSource

The Sync’s Data Pool’s Data Source.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

processedRecords · String

The number of new, updated, and deleted records contained within the Sync, if known. This excludes filtered records.

size · String

The (compressed) size of the Sync, in bytes, if known.

status · SyncStatus · required

The status of the Sync (all Syncs begin as SYNCING before transitioning to SUCCEEDED or FAILED).

Show SyncStatus

The status of a Sync.

• SYNCING: Propel is actively syncing records contained within the Sync.
• SUCCEEDED: The Sync succeeded. Propel successfully synced all records contained within the Sync.
• FAILED: The Sync failed. Propel failed to sync some or all records contained within the Sync.
• DELETING: Propel is deleting the Sync.

startedAt · DateTime

The time at which the Sync started.

succeededAt · DateTime

The time at which the Sync succeeded.

failedAt · DateTime

The time at which the Sync failed.

error · Error

If the Sync failed, this represents the reason the Sync failed.

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

Show Deprecated Fields

newRecords · String · deprecated

The number of new records contained within the Sync, if known. This excludes filtered records.

deprecated: All records are considered to be processed; see processedRecords instead

updatedRecords · String · deprecated

The number of updated records contained within the Sync, if known. This excludes filtered records.

deprecated: All records are considered to be processed; see processedRecords instead

deletedRecords · String · deprecated

The number of deleted records contained within the Sync, if known. This excludes filtered records.

deprecated: All records are considered to be processed; see processedRecords instead

invalidRecords · String · deprecated

The number of filtered records contained within the Sync, due to issues such as a missing timestamp Dimension, if any are known to be invalid.

deprecated: All records are considered to be processed; see processedRecords instead

createMaterializedView

Creates a new Materialized View. Returns the newly created Materialized View (or an error message if creating the Materialized View fails).

Arguments

input · CreateMaterializedViewInput · required

Show CreateMaterializedViewInput

The fields for creating a Materialized View.

uniqueName · String

The Materialized View’s unique name. If not specified, Propel will set the ID as the unique name.

description · String

The Materialized View’s description.

sql · String · required

The SQL that the Materialized View will execute.

destination · CreateMaterializedViewDestinationInput · required

By default, a destination Data Pool with default settings will be created for the Materialized View; however, you can customize the destination Data Pool (or point to an existing Data Pool), by setting this field. Use this to target an existing Data Pool or the engine settings of a new Data Pool.

Show CreateMaterializedViewDestinationInput

The fields for targeting an existing Data Pool or a new Data Pool.

existingDataPool · DataPoolInput

If specified, the Materialized View will target an existing Data Pool. Ensure the Data Pool’s schema is compatible with your Materialized View’s SQL statement.

See DataPoolInput

newDataPool · CreateMaterializedViewDestinationNewDataPoolInput

If specified, the Materialized View will create and target a new Data Pool. You can further customize the new Data Pool’s engine settings.

See CreateMaterializedViewDestinationNewDataPoolInput

backfillOptions · BackfillOptionsInput

By default, a Materialized View only applies to records added after its creation. This option allows to backfill all the data that was present before the Materialized View creation.

Show BackfillOptionsInput

backfill · Boolean

Whether historical data should be backfilled or not

order · PartitionOrder

Defines the order in which historical data is backfilled. Defaults to OLDEST_FIRST if not specified.

See PartitionOrder

Returns

Non-null

MaterializedViewResponse

Show MaterializedViewResponse

The result of a mutation which creates or modifies a Materialized View.

materializedView · MaterializedView · required

The Materialized View which was created or modified.

Show MaterializedView

id · ID · required

The Materialized View’s unique identifier.

uniqueName · String · required

The Materialized View’s unique name.

description · String · required

The Materialized View’s description.

account · Account · required

The Materialized View’s Account.

See Account

environment · Environment · required

The Materialized View’s Environment.

See Environment

createdAt · DateTime · required

The Materialized View’s creation date and time in UTC.

modifiedAt · DateTime · required

The Materialized View’s last modification date and time in UTC.

createdBy · String · required

The Materialized View’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Materialized View’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

sql · String · required

The SQL that the Materialized View executes.

destination · DataPool · required

The Materialized View’s destination (AKA “target”) Data Pool.

See DataPool

source · DataPool

The Materialized View’s source Data Pool.

See DataPool

others · [DataPool!] · required

Other Data Pools queried by the Materialized View.

See DataPool

modifyMaterializedView

Modifies a Materialized View. If any of the optional arguments are omitted, those properties will be unchanged on the Materialized View.

Arguments

input · ModifyMaterializedViewInput · required

Show ModifyMaterializedViewInput

The fields for modifying a Materialized View.

id · ID · required

The ID of the Materialized View to modify.

uniqueName · String

The Materialized View’s new unique name.

description · String

The Materialized View’s new description.

Returns

Non-null

MaterializedViewResponse

Show MaterializedViewResponse

The result of a mutation which creates or modifies a Materialized View.

materializedView · MaterializedView · required

The Materialized View which was created or modified.

Show MaterializedView

id · ID · required

The Materialized View’s unique identifier.

uniqueName · String · required

The Materialized View’s unique name.

description · String · required

The Materialized View’s description.

account · Account · required

The Materialized View’s Account.

See Account

environment · Environment · required

The Materialized View’s Environment.

See Environment

createdAt · DateTime · required

The Materialized View’s creation date and time in UTC.

modifiedAt · DateTime · required

The Materialized View’s last modification date and time in UTC.

createdBy · String · required

The Materialized View’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Materialized View’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

sql · String · required

The SQL that the Materialized View executes.

destination · DataPool · required

The Materialized View’s destination (AKA “target”) Data Pool.

See DataPool

source · DataPool

The Materialized View’s source Data Pool.

See DataPool

others · [DataPool!] · required

Other Data Pools queried by the Materialized View.

See DataPool

deleteMaterializedView

Deletes a Materialized View and returns its ID if the Materialized View was deleted successfully. Note that deleting a Materialized View does not delete its target Data Pool. If you want to delete its target Data Pool, you must use the deleteDataPool mutation.

Arguments

id · ID · required

createAmazonDataFirehoseDataSource

Creates a new Amazon Data Firehose Data Source from the given settings.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateAmazonDataFirehoseDataSourceInput · required

Show CreateAmazonDataFirehoseDataSourceInput

connectionSettings · AmazonDataFirehoseConnectionSettingsInput · required

The Amazon Data Firehose Data Source’s connection settings

Show AmazonDataFirehoseConnectionSettingsInput

The Amazon Data Firehose Data Source’s connection settings.

accessControlEnabled · Boolean

Enables or disables access control for the Data Pool. If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

basicAuth · HttpBasicAuthInput · required

HTTP basic access authentication credentials. You must configure these same credentials to be included in the X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint.

See HttpBasicAuthInput

columns · [AmazonDataFirehoseDataSourceColumnInput!]

Additional columns for the table in Propel.

See AmazonDataFirehoseDataSourceColumnInput

tableSettings · TableSettingsInput

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp value, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

See TableSettingsInput

timestamp · String

The primary timestamp column, if any.

description · String

The Amazon Data Firehose Data Source’s description.

uniqueName · String

The Amazon Data Firehose Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyAmazonDataFirehoseDataSource

Modifies the Data Source by the ID or unique name provided with the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyAmazonDataFirehoseDataSourceInput · required

Show ModifyAmazonDataFirehoseDataSourceInput

connectionSettings · PartialAmazonDataFirehoseConnectionSettingsInput

The Amazon Data Firehose Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialAmazonDataFirehoseConnectionSettingsInput

The Amazon Data Firehose Data Source’s connection settings.

basicAuth · HttpBasicAuthInput

HTTP basic access authentication credentials. You must configure these same credentials to be included in the X-Amz-Firehose-Access-Key header when Amazon Data Firehose issues requests to its custom HTTP endpoint. If not provided this property will not be modified.

See HttpBasicAuthInput

description · String

The Amazon Data Firehose Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Amazon Data Firehose Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Amazon Data Firehose Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createAmazonDynamoDBDataSource

Creates a new Amazon DynamoDB Data Source from the given settings.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateAmazonDynamoDBDataSourceInput · required

Show CreateAmazonDynamoDBDataSourceInput

connectionSettings · AmazonDynamoDBConnectionSettingsInput · required

The Amazon DynamoDB Data Source’s connection settings

Show AmazonDynamoDBConnectionSettingsInput

The Amazon DynamoDB Data Source’s connection settings.

accessControlEnabled · Boolean

Enables or disables access control for the Data Pool. If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

basicAuth · HttpBasicAuthInput · required

HTTP basic access authentication credentials. You must configure these same credentials to be included in the X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its custom HTTP endpoint.

See HttpBasicAuthInput

columns · [AmazonDynamoDBDataSourceColumnInput!]

Additional columns for the table in Propel.

See AmazonDynamoDBDataSourceColumnInput

tableSettings · TableSettingsInput

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp value, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

See TableSettingsInput

timestamp · String

The primary timestamp column, if any.

description · String

The Amazon DynamoDB Data Source’s description.

uniqueName · String

The Amazon DynamoDB Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyAmazonDynamoDBDataSource

Modifies the Data Source by the ID or unique name provided with the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyAmazonDynamoDBDataSourceInput · required

Show ModifyAmazonDynamoDBDataSourceInput

connectionSettings · PartialAmazonDynamoDBConnectionSettingsInput

The Amazon DynamoDB Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialAmazonDynamoDBConnectionSettingsInput

The Amazon DynamoDB Data Source’s connection settings.

basicAuth · HttpBasicAuthInput

HTTP basic access authentication credentials. You must configure these same credentials to be included in the X-Amz-Firehose-Access-Key header when Amazon Data Firehose transmits records from your DynamoDB table to its custom HTTP endpoint. If not provided this property will not be modified.

See HttpBasicAuthInput

description · String

The Amazon DynamoDB Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Amazon DynamoDB Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Amazon DynamoDB Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createClickHouseDataSource

This mutation creates a new ClickHouse Data Source.

The mutation returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateClickHouseDataSourceInput · required

Show CreateClickHouseDataSourceInput

connectionSettings · ClickHouseConnectionSettingsInput · required

The ClickHouse Data Source’s connection settings

Show ClickHouseConnectionSettingsInput

The ClickHouse Data Source connection settings.

database · String · required

Which database to connect to

password · String · required

The password for the provided user

url · String · required

The URL where the ClickHouse host is listening to HTTP[S] connections

user · String · required

The user for authenticating against the ClickHouse host

description · String

The ClickHouse Data Source’s description.

uniqueName · String

The ClickHouse Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyClickHouseDataSource

This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyClickHouseDataSourceInput · required

Show ModifyClickHouseDataSourceInput

connectionSettings · PartialClickHouseConnectionSettingsInput

The ClickHouse Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialClickHouseConnectionSettingsInput

The ClickHouse Data Source connection settings.

database · String

Which database to connect to If not provided this property will not be modified.

password · String

The password for the provided user If not provided this property will not be modified.

url · String

The URL where the ClickHouse host is listening to HTTP[S] connections If not provided this property will not be modified.

user · String

The user for authenticating against the ClickHouse host If not provided this property will not be modified.

description · String

The ClickHouse Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the ClickHouse Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The ClickHouse Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createHttpDataSource

Creates a new HTTP Data Source from the given settings.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateHttpDataSourceInput · required

Show CreateHttpDataSourceInput

connectionSettings · HttpConnectionSettingsInput · required

The HTTP Data Source’s connection settings

Show HttpConnectionSettingsInput

The HTTP Data Source connection settings.

basicAuth · HttpBasicAuthInput

The HTTP Basic authentication settings for uploading new data.

If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.

See HttpBasicAuthInput

tables · [HttpDataSourceTableInput!] · required

The HTTP Data Source’s tables.

See HttpDataSourceTableInput

description · String

The HTTP Data Source’s description.

uniqueName · String

The HTTP Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyHttpDataSource

This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyHttpDataSourceInput · required

Show ModifyHttpDataSourceInput

connectionSettings · PartialHttpConnectionSettingsInput

The HTTP Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialHttpConnectionSettingsInput

The HTTP Data Source connection settings.

basicAuth · HttpBasicAuthInput

The HTTP Basic authentication settings for uploading new data.

If this parameter is not provided, anyone with the URL to your tables will be able to upload data. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.

See HttpBasicAuthInput

basicAuthEnabled · Boolean

Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.

tables · [HttpDataSourceTableInput!]

The HTTP Data Source’s tables. If not provided this property will not be modified.

See HttpDataSourceTableInput

description · String

The HTTP Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the HTTP Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The HTTP Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createKafkaDataSource

This mutation creates a new Kafka Data Source.

The mutation returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateKafkaDataSourceInput · required

Show CreateKafkaDataSourceInput

connectionSettings · KafkaConnectionSettingsInput · required

The Kafka Data Source’s connection settings

Show KafkaConnectionSettingsInput

The Kafka Data Source connection settings.

auth · String · required

The type of authentication to use. Can be SCRAM-SHA-256, SCRAM-SHA-512, PLAIN or NONE

bootstrapServers · [String!] · required

The bootstrap server(s) to connect to

password · String · required

The password for the provided user

tls · Boolean

Whether the the connection to the Kafka servers is encrypted or not

user · String · required

The user for authenticating against the Kafka servers

description · String

The Kafka Data Source’s description.

uniqueName · String

The Kafka Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyKafkaDataSource

This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyKafkaDataSourceInput · required

Show ModifyKafkaDataSourceInput

connectionSettings · PartialKafkaConnectionSettingsInput

The Kafka Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialKafkaConnectionSettingsInput

The Kafka Data Source connection settings.

auth · String

The type of authentication to use. Can be SCRAM-SHA-256, SCRAM-SHA-512, PLAIN or NONE If not provided this property will not be modified.

bootstrapServers · [String!] · required

The bootstrap server(s) to connect to If not provided this property will not be modified.

password · String

The password for the provided user If not provided this property will not be modified.

tls · Boolean

Whether the the connection to the Kafka servers is encrypted or not If not provided this property will not be modified.

user · String

The user for authenticating against the Kafka servers If not provided this property will not be modified.

description · String

The Kafka Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Kafka Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Kafka Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createPostgreSqlDataSource

Creates a new PostgreSQL Data Source.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Example:

mutation {
  createPostgreSqlDataSource(input: {
    uniqueName: "example_postgresql_data_source"
    description: "My PostgreSQL Data Source"
    connectionSettings: {
      database: "example_database"
      schema: "public"
      host: "postgresql.example.com"
      port: 5432
      user: "user"
      password: "password"
    }
  }) {
    dataSource {
      id
      uniqueName
    }
  }
}

Replace the placeholder values with your actual configuration.

Arguments

input · CreatePostgreSqlDataSourceInput · required

Show CreatePostgreSqlDataSourceInput

connectionSettings · PostgreSqlConnectionSettingsInput · required

The PostgreSQL Data Source’s connection settings

Show PostgreSqlConnectionSettingsInput

The PostgreSQL Data Source connection settings.

database · String

Which database to connect to

host · String · required

The host where PostgreSQL is listening

password · String · required

The password for the provided user

port · Int

The port where PostgreSQL is listening (usually 5432)

schema · String

Which schema to use

user · String · required

The user for authenticating against PostgreSQL

description · String

The PostgreSQL Data Source’s description.

uniqueName · String

The PostgreSQL Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyPostgreSqlDataSource

Selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyPostgreSqlDataSourceInput · required

Show ModifyPostgreSqlDataSourceInput

connectionSettings · PartialPostgreSqlConnectionSettingsInput

The PostgreSQL Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialPostgreSqlConnectionSettingsInput

The PostgreSQL Data Source connection settings.

database · String

Which database to connect to If not provided this property will not be modified.

host · String

The host where PostgreSQL is listening If not provided this property will not be modified.

password · String

The password for the provided user If not provided this property will not be modified.

port · Int

The port where PostgreSQL is listening (usually 5432) If not provided this property will not be modified.

schema · String

Which schema to use If not provided this property will not be modified.

user · String

The user for authenticating against PostgreSQL If not provided this property will not be modified.

description · String

The PostgreSQL Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the PostgreSQL Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The PostgreSQL Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createS3DataSource

Creates a new Amazon S3 Data Source pointed at the specified Amazon S3 bucket.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateS3DataSourceInput · required

Show CreateS3DataSourceInput

connectionSettings · S3ConnectionSettingsInput · required

The Amazon S3 Data Source’s connection settings

Show S3ConnectionSettingsInput

The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.

awsAccessKeyId · String · required

The AWS access key ID for an IAM user with sufficient access to the Amazon S3 bucket.

awsSecretAccessKey · String · required

The AWS secret access key for an IAM user with sufficient access to the Amazon S3 bucket.

bucket · String · required

The name of the Amazon S3 bucket.

tables · [S3DataSourceTableInput!] · required

The Amazon S3 Data Source’s tables.

See S3DataSourceTableInput

description · String

The Amazon S3 Data Source’s description.

uniqueName · String

The Amazon S3 Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyS3DataSource

This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyS3DataSourceInput · required

Show ModifyS3DataSourceInput

connectionSettings · PartialS3ConnectionSettingsInput

The Amazon S3 Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialS3ConnectionSettingsInput

The connection settings for an Amazon S3 Data Source. These include the Amazon S3 bucket name, the AWS access key ID, and the tables (along with their paths). We do not allow fetching the AWS secret access key after it has been set.

awsAccessKeyId · String

The AWS access key ID for an IAM user with sufficient access to the Amazon S3 bucket. If not provided this property will not be modified.

awsSecretAccessKey · String

The AWS secret access key for an IAM user with sufficient access to the Amazon S3 bucket. If not provided this property will not be modified.

bucket · String

The name of the Amazon S3 bucket. If not provided this property will not be modified.

tables · [S3DataSourceTableInput!]

The Amazon S3 Data Source’s tables. If not provided this property will not be modified.

See S3DataSourceTableInput

description · String

The Amazon S3 Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Amazon S3 Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Amazon S3 Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createTwilioSegmentDataSource

Creates a new Twilio Segment Data Source from the given settings.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateTwilioSegmentDataSourceInput · required

Show CreateTwilioSegmentDataSourceInput

connectionSettings · TwilioSegmentConnectionSettingsInput · required

The Twilio Segment Data Source’s connection settings

Show TwilioSegmentConnectionSettingsInput

The Twilio Segment Data Source connection settings.

accessControlEnabled · Boolean

Enables or disables access control for the Data Pool. If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

basicAuth · HttpBasicAuthInput

The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.

See HttpBasicAuthInput

columns · [TwilioSegmentDataSourceColumnInput!]

The additional columns for the table in Propel.

See TwilioSegmentDataSourceColumnInput

tableSettings · TableSettingsInput

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

See TableSettingsInput

timestamp · String

The primary timestamp column, if any.

description · String

The Twilio Segment Data Source’s description.

uniqueName · String

The Twilio Segment Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyTwilioSegmentDataSource

Modifies the Data Source by the ID or unique name provided with the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyTwilioSegmentDataSourceInput · required

Show ModifyTwilioSegmentDataSourceInput

connectionSettings · PartialTwilioSegmentConnectionSettingsInput

The Twilio Segment Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialTwilioSegmentConnectionSettingsInput

The Twilio Segment Data Source connection settings.

basicAuth · HttpBasicAuthInput

The HTTP basic authentication settings for the Twilio Segment Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.

See HttpBasicAuthInput

basicAuthEnabled · Boolean

Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.

description · String

The Twilio Segment Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Twilio Segment Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Twilio Segment Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

createWebhookDataSource

Creates a new Webhook Data Source from the given settings.

Returns the newly created Data Source (or an error message if creating the Data Source fails).

Arguments

input · CreateWebhookDataSourceInput · required

Show CreateWebhookDataSourceInput

connectionSettings · WebhookConnectionSettingsInput · required

The Webhook Data Source’s connection settings

Show WebhookConnectionSettingsInput

The Webhook Data Source connection settings.

accessControlEnabled · Boolean

Enables or disables access control for the Data Pool. If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

basicAuth · HttpBasicAuthInput

The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it.

See HttpBasicAuthInput

columns · [WebhookDataSourceColumnInput!]

The additional columns for the table in Propel.

See WebhookDataSourceColumnInput

tableSettings · TableSettingsInput

Override the Data Pool’s table settings. These describe how the Data Pool’s table is created in ClickHouse, and a default will be chosen based on the Data Pool’s timestamp and uniqueId values, if any. You can override these defaults in order to specify a custom table engine, custom ORDER BY, etc.

See TableSettingsInput

tenant · String

The tenant ID column, if any.

timestamp · String

The primary timestamp column, if any.

uniqueId · String

The unique ID column, if any. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated.

description · String

The Webhook Data Source’s description.

uniqueName · String

The Webhook Data Source’s unique name. If not specified, Propel will set the ID as unique name.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

modifyWebhookDataSource

Modifies the Data Source by the ID or unique name provided with the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

Arguments

input · ModifyWebhookDataSourceInput · required

Show ModifyWebhookDataSourceInput

connectionSettings · PartialWebhookConnectionSettingsInput

The Webhook Data Source’s new connection settings. If not provided this property will not be modified.

Show PartialWebhookConnectionSettingsInput

The Webhook Data Source connection settings.

basicAuth · HttpBasicAuthInput

The HTTP basic authentication settings for the Webhook Data Source URL. If this parameter is not provided, anyone with the webhook URL will be able to send events. While it’s OK to test without HTTP Basic authentication, we recommend enabling it. If not provided this property will not be modified.

See HttpBasicAuthInput

basicAuthEnabled · Boolean

Set this to false to disable HTTP Basic authentication. Any previously stored HTTP Basic authentication settings will be cleared out. If not provided this property will not be modified.

description · String

The Webhook Data Source’s new description. If not provided this property will not be modified.

idOrUniqueName · idOrUniqueName · required

The ID or unique name of the Webhook Data Source to modify.

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

uniqueName · String

The Webhook Data Source’s new unique name. If not provided this property will not be modified.

Returns

Non-null

DataSourceResponse

Show DataSourceResponse

The result of a mutation which creates or modifies a Data Source.

dataSource · DataSource

The Data Source which was created or modified.

Show DataSource

The Data Source object.

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.

id · ID · required

The Data Source’s unique identifier.

uniqueName · String · required

The Data Source’s unique name.

description · String · required

The Data Source’s description.

account · Account · required

The Data Source’s Account.

See Account

environment · Environment · required

The Data Source’s Environment.

See Environment

createdAt · DateTime · required

The Data Source’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Source’s last modification date and time in UTC.

createdBy · String · required

The Data Source’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Source’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · DataSourceType · required

The Data Source’s type.

See DataSourceType

status · DataSourceStatus · required

The Data Source’s status.

See DataSourceStatus

connectionSettings · ConnectionSettings · required

The Data Source’s connection settings.

See ConnectionSettings

tables · TableConnection

The tables contained within the Data Source, according to the most recent table introspection.

Arguments

first · Int

after · String

last · Int

before · String

See TableConnection

tableIntrospections · TableIntrospectionConnection

A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.

Arguments

first · Int

after · String

last · Int

before · String

See TableIntrospectionConnection

checks · [DataSourceCheck!]

A list of checks performed on the Data Source during its most recent connection attempt.

See DataSourceCheck

dataPools · DataPoolConnection

If you list Data Pools via the dataPools field on a Data Source, you will get Data Pools for the Data Source.

The dataPools field 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

See DataPoolConnection

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to checks instead

See Error

Show Deprecated Fields

reconnectDataPool

deprecated

Deprecated. Use retryDataPoolSetup instead.

deprecated: Use retryDataPoolSetup instead

Arguments

input · idOrUniqueName · required

Show idOrUniqueName

The ID or unique name input.

If both ID and unique name are provided, the ID will take precedence.

id · String

The unique identifier of the object.

uniqueName · String

The unique name of the object.

Returns

Nullable

DataPool

Show DataPool

The Data Pool object. Data Pools are Propel’s high-speed data store and cache

id · ID · required

The Data Pool’s unique identifier.

uniqueName · String · required

The Data Pool’s unique name.

description · String · required

The Data Pool’s description.

account · Account · required

The Data Pool’s Account.

Show Account

The Account object.

id · ID · required

The Account’s unique identifier.

environment · Environment · required

The Data Pool’s Environment.

Show Environment

The Environments object.

Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

id · ID · required

The Environment’s unique identifier.

uniqueName · String

The Environment’s unique name.

description · String

The Environment’s description.

createdAt · DateTime

The Environment’s creation date and time in UTC.

modifiedAt · DateTime

The Environment’s last modification date and time in UTC.

createdBy · String

The Environment’s creator. It can be either a User ID, an Environment ID, or “system” if it was created by Propel.

modifiedBy · String

The Environment’s last modifier. It can be either a User ID, an Environment ID, or “system” if it was modified by Propel.

account · Account

The Environment’s Account.

See Account

createdAt · DateTime · required

The Data Pool’s creation date and time in UTC.

modifiedAt · DateTime · required

The Data Pool’s last modification date and time in UTC.

createdBy · String · required

The Data Pool’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Data Pool’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

dataSource · DataSource · required

The Data Pool’s Data Source. See DataSource

status · DataPoolStatus · required

The Data Pool’s status.

Show DataPoolStatus

The status of a Data Pool.

• CREATED: The Data Pool has been created and will be set up soon.
• PENDING: Propel is attempting to set up the Data Pool.
• LIVE: The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
• SETUP_FAILED: The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
• CONNECTING
• CONNECTED
• BROKEN
• PAUSING
• PAUSED
• DELETING: Propel is deleting the Data Pool and all of its associated data.

dataRetentionInDays · Int · required

The Data Pool’s data retention in days (not yet supported).

table · String · required

The name of the Data Pool’s table.

timestamp · Timestamp

The Data Pool’s primary timestamp column, if any.

Show Timestamp

A Data Pool’s primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.

columnName · String · required

The name of the column that represents the primary timestamp.

type · String · required

The primary timestamp column’s type.

recordCount · String

The number of records in the Data Pool.

sizeInTerabytes · Float

The amount of storage in terabytes used by the Data Pool.

columns · DataPoolColumnConnection

The Data Pool’s columns.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

availableMeasures · DataPoolColumnConnection

The list of measures (numeric columns) in the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

Show DataPoolColumnConnection

The Data Pool column connection object.

Learn more about pagination in GraphQL.

edges · [DataPoolColumnEdge!] · required

The Data Pool column connection’s edges.

See DataPoolColumnEdge

nodes · [DataPoolColumn!] · required

The Data Pool column connection’s nodes.

See DataPoolColumn

pageInfo · PageInfo · required

The Data Pool column connection’s page info.

See PageInfo

setupTasks · [DataPoolSetupTask!]

A list of setup tasks performed on the Data Pool during its most recent setup attempt.

Show DataPoolSetupTask

The Data Pool Setup Task object.

Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.

The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.

name · String · required

The name of the Data Pool Setup Task to be performed.

description · String

A description of the Data Pool Setup Task to be performed.

status · DataPoolSetupTaskStatus · required

The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).

See DataPoolSetupTaskStatus

error · Error

If the Data Pool Setup Task failed, this field includes a descriptive error message.

See Error

completedAt · DateTime

The time at which the Data Pool Setup Task was completed.

syncing · DataPoolSyncing · required

Settings related to Data Pool syncing.

Show DataPoolSyncing

Settings related to Data Pool syncing.

status · DataPoolSyncStatus · required

Indicates whether syncing is enabled or disabled.

See DataPoolSyncStatus

interval · DataPoolSyncInterval

The syncing interval.

Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

See DataPoolSyncInterval

lastSyncedAt · DateTime

The date and time of the most recent Sync in UTC.

syncs · SyncConnection

The list of Syncs of the Data Pool.

Arguments

filter · SyncsFilter

Show SyncsFilter

The filter to apply when listing the Syncs for a Data Pool.

• EMPTY: Returns only Syncs with empty records.
• NOT_EMPTY: Returns only Syncs that contain one or more records.
• ALL: Returns all Syncs, regardless of whether they contain records or not.

first · Int

after · String

last · Int

before · String

See SyncConnection

metrics · MetricConnection

The list of Metrics powered by the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See MetricConnection

deletionJobs · DeletionJobConnection

The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See DeletionJobConnection

addColumnToDataPoolJobs · AddColumnToDataPoolJobConnection

The Add Column Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See AddColumnToDataPoolJobConnection

updateDataPoolRecordsJobs · UpdateDataPoolRecordsJobConnection

The UpdateDataPoolRecords Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

Arguments

first · Int

after · String

last · Int

before · String

See UpdateDataPoolRecordsJobConnection

accessControlEnabled · Boolean · required

Whether the Data Pool has access control enabled or not.

If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

dataPoolAccessPolicies · DataPoolAccessPolicyConnection · required

A paginated list of Data Pool Access Policies available on the Data Pool.

Arguments

first · Int

after · String

last · Int

before · String

See DataPoolAccessPolicyConnection

validateExpression · ValidateExpressionResult · required

Validates a custom expression against the Data Pool’s available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

Arguments

expression · String · required

Show ValidateExpressionResult

Response returned by the validateExpression query for validating expressions in Custom Metrics.

Returns whether the expression is valid or not with a reason explaining why.

valid · Boolean · required

True if the expression is valid, false otherwise.

reason · String

The reason for why the expression is not valid in case it isn’t, null otherwise.

tableSettings · TableSettings · required

The Data Pool’s table settings.

Show TableSettings

A Data Pool’s table settings.

These describe how the Data Pool’s table is created in ClickHouse.

engine · TableEngine

The ClickHouse table engine for the Data Pool’s table.

See TableEngine

partitionBy · [String!]

The PARTITION BY clause for the Data Pool’s table.

primaryKey · [String!]

The PRIMARY KEY clause for the Data Pool’s table.

orderBy · [String!]

The ORDER BY clause for the Data Pool’s table.

ttl · String

The TTL clause for the Data Pool’s table.

partitionByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PARTITION BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

primaryKeyColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its PRIMARY KEY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

orderByColumns · [DataPoolColumn!]

The Data Pool’s columns that participate in its ORDER BY clause.

Show DataPoolColumn

columnName · String · required

The name of the Data Source column that this Data Pool column derives from.

type · ColumnType · required

The Data Pool column’s type. This may differ from the corresponding Data Source column’s type.

See ColumnType

clickHouseType · String · required

The ClickHouse type. This is the exact representation of the type in ClickHouse.

isNullable · Boolean · required

Whether the column is nullable, meaning whether it accepts a null value.

Show Deprecated Fields

name · String · deprecated

The name of the Data Source column that this Data Pool column derives from.

deprecated: Start using columnName instead

Show Deprecated Fields

error · Error · deprecated

deprecated: Refer to setupTasks instead

Show Error

The error object.

code · Int

The error code.

message · String · required

The error message.

tenant · Tenant · deprecated

The Data Pool’s tenant ID, if configured.

deprecated: Will be removed; use Data Pool Access Policies instead

Show Tenant

A Data Pool’s tenant ID column. The tenant ID column is used to control access to your data with access policies.

columnName · String · required

The name of the column that represents the tenant ID.

type · String · required

The tenant ID column’s type.

uniqueId · UniqueId · deprecated

The Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

deprecated: Will be removed; use table settings to define the primary key.

Show UniqueId

A Data Pool’s unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

columnName · String · required

The name of the column that represents the unique ID.

createPolicy

deprecated

Creates a new Policy granting an Application access to a Metric’s data.

deprecated: Use Data Pool Access Policies instead

Arguments

input · CreatePolicyInput · required

Show CreatePolicyInput

The fields for creating a Policy.

metric · ID · required

The Metric to which the Policy will be applied.

type · PolicyType · required

The type of Policy to create.

Show PolicyType

The types of Policies that can be applied to a Metric.

• ALL_ACCESS: Grants access to all Metric data.
• TENANT_ACCESS: Grants access to a specified tenant’s Metric data.

application · ID · required

The Application that will be granted access to the Metric.

Returns

Nullable

PolicyResponse

Show PolicyResponse

The result of a mutation which creates or modifies a Policy.

policy · Policy

The Policy which was created or modified.

Show Policy

The Policy type. It governs an Application’s access to a Metric’s data.

id · ID · required

The Policy’s unique identifier.

account · Account · required

The Policy’s Account.

See Account

environment · Environment · required

The Policy’s Environment.

See Environment

createdAt · DateTime · required

The Policy’s creation date and time in UTC.

modifiedAt · DateTime · required

The Policy’s last modification date and time in UTC.

createdBy · String · required

The Policy’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Policy’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · PolicyType · required

The type of Policy.

See PolicyType

application · Application · required

The Application that is granted access. See Application

metric · Metric · required

The Metric that the Application is granted access to. See Metric

modifyPolicy

deprecated

Modifies an existing Policy. You can modify the Application’s level of access to the Metric’s data.

deprecated: Use Data Pool Access Policies instead

Arguments

input · ModifyPolicyInput · required

Show ModifyPolicyInput

The fields for modifying a Policy.

policy · ID · required

The Policy’s unique identifier.

type · PolicyType · required

The type of Policy.

Show PolicyType

The types of Policies that can be applied to a Metric.

• ALL_ACCESS: Grants access to all Metric data.
• TENANT_ACCESS: Grants access to a specified tenant’s Metric data.

Returns

Nullable

PolicyResponse

Show PolicyResponse

The result of a mutation which creates or modifies a Policy.

policy · Policy

The Policy which was created or modified.

Show Policy

The Policy type. It governs an Application’s access to a Metric’s data.

id · ID · required

The Policy’s unique identifier.

account · Account · required

The Policy’s Account.

See Account

environment · Environment · required

The Policy’s Environment.

See Environment

createdAt · DateTime · required

The Policy’s creation date and time in UTC.

modifiedAt · DateTime · required

The Policy’s last modification date and time in UTC.

createdBy · String · required

The Policy’s creator. It can be either a User ID, an Application ID, or “system” if it was created by Propel.

modifiedBy · String · required

The Policy’s last modifier. It can be either a User ID, an Application ID, or “system” if it was modified by Propel.

type · PolicyType · required

The type of Policy.

See PolicyType

application · Application · required

The Application that is granted access. See Application

metric · Metric · required

The Metric that the Application is granted access to. See Metric

deletePolicy

deprecated

Deletes a Policy. The associated Application will no longer have access to the Metric’s data.

deprecated: Use Data Pool Access Policies instead

Arguments

id · ID · required

requestDelete

deprecated

Schedules a new Deletion Job on the specified Data Pool.

deprecated: This has been renamed to createDeletionJob

Arguments

input · DeletionRequestInput · required

Show DeletionRequestInput

The fields for creating a Deletion Job.

dataPool · ID · required

The Data Pool that is going to get the data deleted

filterSql · String

The filters that will be used for deleting data, in the form of SQL. Data matching these filters will be deleted.

Show Deprecated Fields

filters · [FilterInput!] · deprecated

The list of filters that will be used for deleting data. Data matching these filters will be deleted.

deprecated: Use filterSql instead

Show FilterInput

The fields of a filter.

You can construct more complex filters using and and or. For example, to construct a filter equivalent to

(value > 0 AND value <= 100) OR status = "confirmed"

you could write

{
  "column": "value",
  "operator": "GREATER_THAN",
  "value": "0",
  "and": [{
    "column": "value",
    "operator": "LESS_THAN_OR_EQUAL_TO",
    "value": "0"
  }],
  "or": [{
    "column": "status",
    "operator": "EQUALS",
    "value": "confirmed"
  }]
}

Note that and takes precedence over or.

column · String · required

The name of the column to filter on.

operator · FilterOperator · required

The operation to perform when comparing the column and filter values.

See FilterOperator

value · String

The value to compare the column to.

and · [FilterInput!]

Additional filters to AND with this one. AND takes precedence over OR.

or · [FilterInput!]

Additional filters to OR with this one. AND takes precedence over OR.

Returns

Non-null

RequestDeleteResponse

Show RequestDeleteResponse

The response returned by the Deletion Job.

job · DeletionJob · required

The Deletion Job that was just created.

Show DeletionJob

Deletion Job scheduled for a specific Data Pool.

The Deletion Job represents the asynchronous process of deleting data given some filters inside a Data Pool. It tracks the deletion process until it is finished, showing the progress and the outcome when it is finished.

id · ID · required

The Deletion Job’s ID.

createdAt · DateTime · required

The Deletion Job’s creation date and time in UTC.

createdBy · String · required

Who created the Deletion Job.

modifiedAt · DateTime · required

The Deletion Job’s last modification date and time in UTC.

modifiedBy · String · required

Who last modified the Deletion Job.

account · Account · required

Account to which the Deletion Job belongs.

See Account

environment · Environment · required

Environment to which the Deletion Job belongs.

See Environment

dataPool · DataPool · required

The Data Pool whose records will be deleted by the Deletion Job. See DataPool

status · JobStatus · required

The current Deletion Job’s status.

See JobStatus

filterSql · String

The filters that will be used for deleting data, in the form of SQL. Data matching the filters will be deleted.

error · Error

The error that occurred while deleting data, if any.

See Error

progress · Float · required

The current progress of the Deletion Job, from 0.0 to 1.0.

startedAt · DateTime

The time at which the Deletion Job started.

succeededAt · DateTime

The time at which the Deletion Job succeeded.

failedAt · DateTime

The time at which the Deletion Job failed.

Show Deprecated Fields

filters · [Filter!] · deprecated

The list of filters that will be used for deleting data. Data matching the filters will be deleted.

deprecated: Use filterSql instead

See Filter