This reference doc is generated based on thisexample schema.

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

Developer defines@table types and Data Connect generates queries and mutationsbased on them.

Developer Defined Plus Data Connect Generated

type MainTable

🔨 MainTable is an example of developer defined table type to demonstratevarious supported column types in a Postgres table.

typeMainTable@table{uuidField:UUIDstringField:String@searchableintField:Intint64Field:Int64floatField:FloatbooleanField:BooleandateField:DatetimestampField:TimestampanyField:AnyvectorField:Vector@col(size:768)}

@table(key) defines the primary key. If not configured otherwise, uses theprimary key fieldid. If theid field isn't present already, Data Connectimplicitly adds an auto-generated UUID primary key field:id: UUID! @default(expr: "uuidV4()")

type ManyToManyJoinTable

🔨 ManyToManyJoinTable is an example of developer defined join table thatestablishes a many-to-many relationship betweenMainTable and itself.

typeMainTable@table{someField:Any}typeManyToManyJoinTable@table(key:["left","right"]){left:MainTable!right:MainTable!}

NOTE: it's primary key are two columns with foreign key constraints to bothsides of the many-to-many relationship. The primary key constraint ensures thatfor any given pair ofMainTable rows, there is only one matching row inManyToManyJoinTable.

type ManyToOneExample

🔨 ManyToOneExample is an example of developer defined table type to demonstratesan one-to-many relationship betweenMainTable andManyToOneExample.

typeMainTable@table{someField:Any}typeManyToOneExample@table{main:MainTable!someField:Any}

type OneToOneExample

🔨 OneToOneExample is an example of developer defined table type to demonstratean one-to-maybe relationship betweenMainTable andOneToOneExample.

typeMainTable@table{someField:Any}typeOneToOneExample@table{main:MainTable!@uniquesomeField:Any}

type StringTable

🔨 StringTable is an example of developer defined table type to demonstratearray and non-null columns in a Postgres table.

typeStringTable@table{stringField:StringnonNullStringField:String!stringArray:[String]nonNullStringArray:[String!]stringNonnullArray:[String]!nonNullStringNonnullArray:[String!]!}

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.

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.

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.

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.

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.

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