API Reference: Common syntax definitions¶

TableName¶

String | QualifiedTable

QualifiedTable¶

{
    "name": String,
    "schema": String
}

SourceName¶

String

FunctionName¶

String | QualifiedFunction

QualifiedFunction¶

{
    "name": String,
    "schema": String
}

RoleName¶

String

ComputedFieldName¶

String

PGConfiguration¶

MsSQLConfiguration¶

BigQueryConfiguration¶

PGSourceConnectionInfo¶

MsSQLSourceConnectionInfo¶

FromEnv¶

PGPoolSettings¶

PGCertSettings¶

MsSQLPoolSettings¶

PGColumnType¶

String

1. Numeric types

   Type	Alias	Description
   serial		autoincrementing integer
   bigserial		autoincrementing bigint
   integer		4 bytes, typical choice for integer
   smallint		2 bytes
   bigint		8 bytes
   real	float4	6 decimal digits precision, inexact
   double precision	float8	15 decimal digits precision, inexact
   numeric	decimal	arbitrary precision, exact

2. Character types

   Type	Alias	Description
   varchar	text	typical choice for storing string types

3. Date/Time types

   Type	Alias	Description
   timestamp with time zone	timestamptz	both date and time, with time zone. Allowed values should be of ISO8601 format. E.g. 2016-07-20T17:30:15Z, 2016-07-20T17:30:15+05:30, 2016-07-20T17:30:15.234890+05:30
   time with time zone	timetz	time of day only, with time zone. Allowed values should be of ISO8601 format. E.g. 17:30:15Z, 17:30:15+05:30, 17:30:15.234890+05:30
   date		date (no time of day). Allowed values are yyyy-mm-dd

4. Boolean type

   Type	Alias	Description
   boolean		state of true or false

5. JSON types

   Type	Alias	Description
   json		Stored as plain text
   jsonb		Stored in a binary format and can be indexed

PGColumn¶

String

RelationshipName¶

String

Table Config¶

Custom Root Fields¶

InsertPermission¶

SelectPermission¶

UpdatePermission¶

DeletePermission¶

ObjRelUsing¶

ObjRelUsingChoice¶

SameTable | RemoteTable

SameTable¶

PGColumn

RemoteTable¶

{
    "table"  : TableName,
    "column" : PGColumn
}

ObjRelUsingManualMapping¶

InsertOrder¶

Describes when should the referenced table row be inserted in relation to the current table row in case of a nested insert. Defaults to “before_parent”.

"before_parent" | "after_parent"

ArrRelUsing¶

ArrRelUsingFKeyOn¶

ArrRelUsingManualMapping¶

BoolExp¶

AndExp | OrExp | NotExp | ExistsExp | TrueExp | ColumnExp

AndExp¶

{
    "$and" : [BoolExp],
}

OrExp¶

{
    "$or"  : [BoolExp],
}

NotExp¶

{
    "$not" : BoolExp
}

ExistsExp¶

{
    "$exists" : {
         "_table": TableName,
         "_where": BoolExp
    }
}

TrueExp¶

 {}

ColumnExp¶

{
    PGColumn | scalar ComputedFieldName : { Operator : Value }
}

Operator¶

Generic operators (all column types except json, jsonb) :

(For more details, refer to the Postgres docs for comparison operators and list based search operators.)

Text related operators :

(For more details on text related operators, refer to the Postgres docs.)

Operators for comparing columns (all column types except json, jsonb):

Column Comparison Operator

{
  PGColumn: {
    Operator: {
      PGColumn | ["$", PGColumn]
    }
  }
}

Column comparison operators can be used to compare columns of the same table or a related table. To compare a column of a table with another column of :

1. The same table -

{
  PGColumn: {
    Operator: {
      PGColumn
    }
  }
}

2. The table on which the permission is being defined on -

{
  PGColumn: {
    Operator: {
      [$, PGColumn]
    }
  }
}

(For more details on comparison operators, refer to the Postgres docs.)

Checking for NULL values :

(For more details on the IS NULL expression, refer to the Postgres docs.)

JSONB operators :

(For more details on JSONB operators, refer to the Postgres docs.)

PostGIS related operators on GEOMETRY columns:

(For more details on spatial relationship operators, refer to the PostGIS docs.)

Object¶

A JSONObject

{
   "k1" : v1,
   "k2" : v2,
   ..
}

Empty Object¶

An empty JSONObject

{}

ColumnPresetsExp¶

A JSONObject of a Postgres column name to value mapping, where the value can be static or derived from a session variable.

{
   "column1" : colVal1,
   "column2" : colVal2,
   ..
}

E.g. where id is derived from a session variable and city is a static value.

{
   "id" : "x-hasura-User-Id",
   "city" : "San Francisco"
}

RemoteSchemaName¶

String

RemoteSchemaDef¶

{
   "url" : url-string,
   "url_from_env" : env-var-string,
   "headers": [
        { "name": header-name-string,
          "value": header-value-string,
          "value_from_env": env-var-string
        }
   ],
   "forward_client_headers": boolean,
   "timeout_seconds": integer,
   "customization": RemoteSchemaCustomization
}

RemoteSchemaCustomization¶

{
   "root_fields_namespace": String,
   "type_names": {
     "prefix": String,
     "suffix": String,
     "mapping": {
       String: String
     }
   },
   "field_names": [
     { "parent_type": String,
       "prefix": String,
       "suffix": String,
       "mapping": {
         String: String
       }
     }
   ]
}

RemoteTypeCustomization¶

• Type name prefix and suffix will be applied to all types in the schema except the root types (for query, mutation and subscription), types starting with __, standard scalar types (Int, Float, String, Boolean, and ID), and types with an explicit mapping.
• Root types, types starting with __, and standard scalar types may only be customized with an explicit mapping.

RemoteFieldCustomization¶

• Fields that are part of an interface must be renamed consistently across all object types that implement that interface.

CollectionName¶

String

QueryName¶

String

CollectionQuery¶

{
    "name": String,
    "query": String
}

EndpointUrl¶

String

EndpointMethods¶

[String]

EndpointDefinition¶

{
    "query": {
      "query_name : String,
      "collection_name" : CollectionName
    }
}

CustomColumnNames¶

A JSONObject of Postgres column name to GraphQL name mapping

{
   "column1" : String,
   "column2" : String,
   ..
}

ActionName¶

String

WebhookURL¶

A String value which supports templating environment variables enclosed in {{ and }}.

String

Template example: https://{{ACTION_API_DOMAIN}}/create-user

HeaderFromValue¶

HeaderFromEnv¶

GraphQLType¶

A GraphQL Type Reference string.

String

Example: String! for non-nullable String type and [String] for array of String types

GraphQLName¶

A string literal that conform to GraphQL spec.

String

ActionDefinition¶

InputArgument¶

ComputedFieldDefinition¶

Function Configuration¶

InputObjectType¶

A simple JSON object to define GraphQL Input Object

ObjectType¶

A simple JSON object to define GraphQL Object

ScalarType¶

A simple JSON object to define GraphQL Scalar

EnumType¶

A simple JSON object to define GraphQL Enum

TriggerName¶

String

OperationSpec¶

EventTriggerColumns¶

"*" | [PGColumn]

RetryConf¶

RemoteRelationshipName¶

String

RemoteField¶

{
   FieldName: {
     "arguments": InputArguments
     "field": RemoteField  # optional
   }
}

RemoteField is a recursive tree structure that points to the field in the remote schema that needs to be joined with. It is recursive because the remote field maybe nested deeply in the remote schema.

Examples:

POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
   "message": {
      "arguments":{
         "message_id":"$id"
       }
   }
}

POST /v1/query HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin

{
   "messages": {
      "arguments": {
         "limit": 100
      },
      "field": {
        "private": {
          "arguments": {
             "id" : "$id"
          }
        }
      }
   }
}

InputArguments¶

{
  InputField : $PGColumn | Scalar
}

Table columns can be referred by prefixing $ e.g $id.

RemoteSchemaPermission¶

UrlFromEnv¶

RetryConfST¶