Object Types

Object types define a collection of fields representing an entity in a GraphQL schema.

Developer Defined Plus Data Connect Generated

type BasicTable

Field Type Description
uuidField UUID
uuidArrayField [UUID]
stringField String
stringArrayField [String]
intField Int
intArrayField [Int]
int64Field Int64
int64ArrayField [Int64]
floatField Float
floatArrayField [Float]
booleanField Boolean
booleanArrayField [Boolean]
timestampField Timestamp
timestampArrayField [Timestamp]
dateField Date
dateArrayField [Date]
vectorField Vector
id UUID! ✨ Implicit primary key field. It's a UUID column default to a generated new value. See @table for how to customize it.

type JoinTable

Field Type Description
left LeftTable!
right RightTable!
leftId UUID! ✨ Implicit foreign key field based on JoinTable.left. It must match the value of LeftTable.id. See @ref for how to customize it.
rightId UUID! ✨ Implicit foreign key field based on JoinTable.right. It must match the value of RightTable.id. See @ref for how to customize it.

type LeftTable

Field Type Description
id UUID!
joinTables_on_left [JoinTable!]! ✨ List JoinTable objects in a one-to-many relationship (where JoinTable.left is this object).
rightTables_via_JoinTable [RightTable!]! ✨ List RightTable objects using JoinTable as the join table (a JoinTable object exists where its left is this and its right is that).

type ManyTable

Field Type Description
oneTable OneTable!
id UUID! ✨ Implicit primary key field. It's a UUID column default to a generated new value. See @table for how to customize it.
oneTableId UUID! ✨ Implicit foreign key field based on ManyTable.oneTable. It must match the value of OneTable.id. See @ref for how to customize it.

type MaybeTable

Field Type Description
oneTable OneTable!
id UUID! ✨ Implicit primary key field. It's a UUID column default to a generated new value. See @table for how to customize it.
oneTableId UUID! ✨ Implicit foreign key field based on MaybeTable.oneTable. It must match the value of OneTable.id. See @ref for how to customize it.

type OneTable

Field Type Description
id UUID!
manyTables_on_oneTable [ManyTable!]! ✨ List ManyTable objects in a one-to-many relationship (where ManyTable.oneTable is this object).
maybeTables_on_oneTable [MaybeTable!]! ✨ List MaybeTable objects in a one-to-many relationship (where MaybeTable.oneTable is this object).

type RightTable

Field Type Description
id UUID!
joinTables_on_right [JoinTable!]! ✨ List JoinTable objects in a one-to-many relationship (where JoinTable.right is this object).
leftTables_via_JoinTable [LeftTable!]! ✨ List LeftTable objects using JoinTable as the join table (a JoinTable object exists where its right is this and its left is that).

Built In

type __Directive

A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

Field Type Description
name String!
description String
locations [__DirectiveLocation!]!
args [__InputValue!]!
isRepeatable Boolean!

type __EnumValue

One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.

Field Type Description
name String!
description String
isDeprecated Boolean!
deprecationReason String

type __Field

Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.

Field Type Description
name String!
description String
args [__InputValue!]!
type __Type!
isDeprecated Boolean!
deprecationReason String

type __InputValue

Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.

Field Type Description
name String!
description String
type __Type!
defaultValue String A GraphQL-formatted string representing the default value for this input value.
isDeprecated Boolean!
deprecationReason String

type __Schema

A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.

Field Type Description
description String
types [__Type!]! A list of all types supported by this server.
queryType __Type! The type that query operations will be rooted at.
mutationType __Type If this server supports mutation, the type that mutation operations will be rooted at.
subscriptionType __Type If this server support subscription, the type that subscription operations will be rooted at.
directives [__Directive!]! A list of all directives supported by this server.

type __Type

The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum.

Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name, description and optional specifiedByURL, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.

Field Type Description
kind __TypeKind!
name String
description String
fields [__Field!]
interfaces [__Type!]
possibleTypes [__Type!]
enumValues [__EnumValue!]
inputFields [__InputValue!]
ofType __Type
specifiedByURL String