Skip to main content

TableConnection

The table connection object.

Learn more about pagination in GraphQL.

fields

  • pageInfo non-null PageInfo

    The connection's page info.

    The page info object used for pagination.

    • pageInfo.startCursor nullable String

      Points to the first item returned in the results. Used when paginating backward.

    • pageInfo.endCursor nullable String

      Points to the last item returned in the results. Used when paginating forward.

    • pageInfo.hasNextPage non-null Boolean

      A boolean that indicates whether a next page of results exists. Can be used to display a "next page" button in user interfaces, for example.

    • pageInfo.hasPreviousPage non-null Boolean

      A boolean that indicates whether a previous page of results exists. Can be used to display a "previous page" button in user interfaces, for example.

  • edges non-null array of TableEdge

    The connection's edges.

    The table edge object.

    Learn more about pagination in GraphQL.

  • nodes non-null array of Table

    The connection's nodes.

    The table object.

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

    • nodes.id non-null ID

      The table's ID.

    • nodes.name non-null String

      The table's name.

    • nodes.dataSource nullable DataSource

      The Data Source to which the table belongs.

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

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

    • nodes.cachedAt non-null DateTime

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

    • nodes.createdAt non-null DateTime

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

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

    • nodes.columns nullable ColumnConnection

      The table's columns.

    • nodes.availableTimestamps nullable ColumnConnection

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

    • nodes.availableMeasures nullable ColumnConnection

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

  • cachedAt non-null DateTime

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