Skip to main content

Table

The table object.

Once a table introspection succeeds, it creates a new table object for every table it introspected.

fields

  • id non-null ID

    The table's ID.

  • name non-null String

    The table's name.

  • dataSource nullable DataSource

    The Data Source to which the table belongs.

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

  • rows nullable Int

    The number of rows contained within the table at the time of introspection. Check the table's cachedAt time, since this info can become out of date.

  • size nullable Int

    The size of the table (in bytes) at the time of introspection. Check the table's cachedAt time, since this info can become out of date.

  • cachedAt non-null DateTime

    The time at which the table was cached (i.e., the time at which it was introspected).

  • createdAt non-null DateTime

    The time at which the table was created. This is the same as its cachedAt time.

  • createdBy non-null String

    The table's creator. This corresponds to the initiator of the table Introspection. It can be either a User ID, an Application ID, or "system" if it was created by Propel.

  • columns nullable ColumnConnection

    The table's columns.

    The column connection object.

    Learn more about pagination in GraphQL.

    • columns.pageInfo non-null PageInfo

      The connection's page info.

    • columns.edges non-null array of ColumnEdge

      The connection's edges.

    • columns.nodes non-null array of Column

      The connection's nodes.

    • columns.cachedAt non-null DateTime

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

  • availableTimestamps nullable ColumnConnection

    The table's columns which can be used as a timestamp for a Data Pool.

    The column connection object.

    Learn more about pagination in GraphQL.

  • availableMeasures nullable ColumnConnection

    The table's columns which can be used as a measure for a Metric.

    The column connection object.

    Learn more about pagination in GraphQL.