Skip to main content

introspectTables

This mutation is used to introspect the tables in the given Data Source, specified either by its ID or unique name.

The mutation returns the tables along with when they were last cached from the Data Source.

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

  • input required idOrUniqueName

    The ID or unique name input.

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

    • input.id optional String

      The unique identifier of the object.

    • input.uniqueName optional String

      The unique name of the object.


returns nullable 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 non-null DataSource

    The Data Source the table introspection was performed for.

    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.

    • dataSource.id non-null ID

      The Data Source's unique identifier.

    • dataSource.uniqueName non-null String

      The Data Source's unique name.

    • dataSource.description non-null String

      The Data Source's description.

    • dataSource.account non-null Account

      The Data Source's Account.

    • dataSource.environment non-null Environment

      The Data Source's Environment.

    • dataSource.createdAt non-null DateTime

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

    • dataSource.modifiedAt non-null DateTime

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

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

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

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

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

    • dataSource.connectionSettings non-null ConnectionSettings

      The Data Source's connection settings.


    • dataSource.tables nullable TableConnection

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

      • dataSource.tables.first optional Int

      • dataSource.tables.after optional String

      • dataSource.tables.last optional Int

      • dataSource.tables.before optional String

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

      • dataSource.tableIntrospections.first optional Int

      • dataSource.tableIntrospections.after optional String

      • dataSource.tableIntrospections.last optional Int

      • dataSource.tableIntrospections.before optional String

    • dataSource.checks nullable array of DataSourceCheck

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

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

      • dataSource.dataPools.first optional Int

      • dataSource.dataPools.after optional String

      • dataSource.dataPools.last optional Int

      • dataSource.dataPools.before optional String

  • status non-null TableIntrospectionStatus

    The status of the table introspection.

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

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

  • createdBy non-null String

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

  • modifiedAt non-null DateTime

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

  • modifiedBy non-null String

    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 nullable Int

    The number of tables introspected.

  • tables nullable TableConnection

    The tables introspected.

    • tables.first optional Int

    • tables.after optional String

    • tables.last optional Int

    • tables.before optional String

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