Skip to main content

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.

Learn more about Data Sources.

fields

  • id non-null ID

    The Data Source's unique identifier.

  • uniqueName non-null String

    The Data Source's unique name.

  • description non-null String

    The Data Source's description.

  • account non-null Account

    The Data Source's Account.

    The Account object.

    • account.id non-null ID

      The Account's unique identifier.

  • environment non-null Environment

    The Data Source's 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.

  • createdAt non-null DateTime

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

  • modifiedAt non-null DateTime

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

  • createdBy non-null String

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

  • modifiedBy non-null String

    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 non-null DataSourceType

    The Data Source's type.

    The types of Data Sources.

    • Snowflake

      Indicates a Snowflake Data Source.

    • Http

      Indicates an Http Data Source.

  • status non-null DataSourceStatus

    The Data Source's status.

    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 non-null ConnectionSettings

    The Data Source's connection settings.


  • tables nullable TableConnection

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

    The table connection object.

    Learn more about pagination in GraphQL.

    • tables.pageInfo non-null PageInfo

      The connection's page info.

    • tables.edges non-null array of TableEdge

      The connection's edges.

    • tables.nodes non-null array of Table

      The connection's nodes.

    • tables.cachedAt non-null DateTime

      The time at which the tables were cached (i.e., the time at which they were introspected).

  • tableIntrospections nullable 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.

    The table introspection connection object.

    Learn more about pagination in GraphQL.

  • checks nullable array of DataSourceCheck

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

    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.

    • checks.name non-null String

      The name of the Data Source Check to be performed.

    • checks.description nullable String

      A description of the Data Source Check to be performed.

    • checks.status non-null DataSourceCheckStatus

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

      The status of a Data Source Check.

      • NOT_STARTED

        The Check has not started.

      • SUCCEEDED

        The Check succeeded.

      • FAILED

        The Check failed.

    • checks.error nullable Error

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

    • checks.checkedAt nullable DateTime

      The time at which the Data Source Check was performed.

  • dataPools nullable 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.

    The Data Pool connection object.

    Learn more about pagination in GraphQL.