Skip to main content

dataSourceByName

This query returns the Data Source specified by the given unique name.

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.

Arguments


Returns

Nullable 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.

  • dataSourceByName.id non-null ID

    The Data Source's unique identifier.

  • dataSourceByName.uniqueName non-null String

    The Data Source's unique name.

  • dataSourceByName.description non-null String

    The Data Source's description.

  • dataSourceByName.account non-null Account

    The Data Source's Account.

  • dataSourceByName.environment non-null Environment

    The Data Source's Environment.

  • dataSourceByName.createdAt non-null DateTime

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

  • dataSourceByName.modifiedAt non-null DateTime

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

  • dataSourceByName.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.

  • dataSourceByName.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.

  • dataSourceByName.type non-null DataSourceType

    The Data Source's type.

    The types of Data Sources.

    • WEBHOOK

      Indicates a Webhook Data Source.

    • S3

      Indicates an S3 Data Source.

    • Redshift

      Indicates a Redshift Data Source.

    • Http

      Indicates an Http Data Source.

    • BIGQUERY

      Indicates a BigQuery Data Source.

    • Snowflake

      Indicates a Snowflake Data Source.

  • dataSourceByName.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.

  • dataSourceByName.connectionSettings non-null ConnectionSettings

    The Data Source's connection settings.


  • dataSourceByName.tables nullable TableConnection

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

  • dataSourceByName.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.

  • dataSourceByName.checks nullable array of DataSourceCheck

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

  • dataSourceByName.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.