Documentation

Simple table selection.

The field for the table accepts table selection arguments, and expects a selection of fields

table_name(limit: 10) {
  col1: col1_type
  col2: col2_type
}: [table!]!

Simple table connection selection.

The field for the table accepts table connection selection argument, and expects a selection of connection fields

table_name_connection(first: 1) {
  pageInfo: {
    hasNextPage: Boolean!
    endCursor: String!
  }
  edges: {
    cursor: String!
    node: {
      id: ID!
      col1: col1_type
      col2: col2_type
    }
  }
}: table_nameConnection!

Table selection by primary key.

table_name(id: 42) {
  col1: col1_type
  col2: col2_type
}: table

Returns Nothing if there's nothing that can be selected with current permissions or if there are primary keys the user doesn't have select permissions for.

Table aggregation selection

Parser for an aggregation selection of a table. > table_aggregate(limit: 10) { > aggregate: table_aggregate_fields > group_by(...): table_group_by > nodes: [table!]! > } :: table_aggregate!

Returns Nothing if there's nothing that can be selected with current permissions.

Fields of a table

type table{
  # table columns
  column_1: column1_type
  .
  column_n: columnn_type

  # table relationships
  object_relationship: remote_table
  array_relationship: [remote_table!]!

  # computed fields
  computed_field: field_type

  # remote relationships
  remote_field: field_type
}

List of table fields object. Just a nonNullableObjectList wrapper over tableSelectionSet. > table_name: [table!]!

Connection fields of a table

type tableConnection{
  pageInfo: PageInfo!
  edges: [tableEdge!]!
}

type PageInfo{
  startCursor: String!
  endCursor: String!
  hasNextPage: Boolean!
  hasPreviousPage: Boolean!
}

type tableEdge{
  cursor: String!
  node: table!
}

Arguments for a table selection. Default implementation for BackendSchema.

distinct_on: [table_select_column!]
limit: Int
offset: Int
order_by: [table_order_by!]
where: table_bool_exp

Argument to filter rows returned from table selection > where: table_bool_exp

Argument to sort rows returned from table selection > order_by: [table_order_by!]

Argument to distinct select on columns returned from table selection > distinct_on: [table_select_column!]

Argument to limit rows returned from table selection > limit: NonNegativeInt

Argument to skip some rows, in conjunction with order_by > offset: BigInt

Arguments for a table connection selection

distinct_on: [table_select_column!]
order_by: [table_order_by!]
where: table_bool_exp
first: Int
last: Int
before: String
after: String

Aggregation fields

type table_aggregate_fields{
  count(distinct: Boolean, columns: [table_select_column!]): Int!
  sum: table_sum_fields
  avg: table_avg_fields
  stddev: table_stddev_fields
  stddev_pop: table_stddev_pop_fields
  variance: table_variance_fields
  var_pop: table_var_pop_fields
  max: table_max_fields
  min: table_min_fields
}

shared implementation between tables and logical models