Frequently Asked Questions

Find answers to the most common questions about GraphQL and the Graphcool platform.

How can I define relations in an IDL schema file?

#graphql#data-schema
A GraphQL Schema Definition is the easiest way to describe an entire GraphQL API. Using the relation tag, you can define GraphQL relations.

Authenticating API Calls From Functions

#platform#authentication#functions#clients
Functions can hook into GraphQL events to implement custom business logic. Learn how authentication works with GraphQL in a serverless context.

Cursor-based Pagination with GraphQL

#graphql#queries#pagination#client-apis
Cursor-based pagination is a common pattern in GraphQL to display content in equally sized pages that allow forward and backward navigation.

Changelog

#platform
Keep track of the latest features and improvements to the Graphcool platform.

How to choose the correct relation?

#platform#relations#simple-api#relay-api#mutations
Learn what relations are and how you can make the correct choice when designing relations as part of your GraphQL schema and data model.

What technology is Graphcool using?

#platform
Learn more about the technology and infrastructure used at Graphcool.

How do Insufficient Permissions affect the Query Response?

#queries#graphql
The GraphQL specification defines the interaction of optional or required fields in the query response with things like insufficient permissions.

How can I move my project away from Graphcool?

#platform
We're embracing open source and widely used technologies such as GraphQL and AWS Lambda and are dedicated to provide a good migration strategy.

How to query the currently logged-in user?

#platform#client-apis#queries#authentication
Learn how to send a GraphQL query to fetch signed in users that are registered with an authentication provider like Auth0 or Digits.

Using GraphQL Fragments

#graphql#queries
GraphQL fragments allow you to construct groups of fields that can be included in queries where you need them.

GraphQL IDL - Schema Definition Language

#graphql#data-schema
A GraphQL Schema Definition is the easiest way to describe an entire GraphQL API. You can use them to create a new Graphcool project.

How to use GraphQL Introspection Queries?

#tooling#queries#graphql
GraphQL servers expose a type safe GraphQL schema. You can query information about the schema using GraphQL introspection queries.

How to Store Meta Information for Relations

#relations#data-schema#queries#graphql
Relations describe the interaction between two models. To store additional information for connected nodes, you can introduce a meta model.

Combining multiple GraphQL queries or mutations in one request

#mutations#queries#graphql
In GraphQL you can run multiple queries or mutations in one request using GraphQL aliases.

How Does Aggregation Work In GraphQL?

#queries#client-apis#platform
Aggregation functions can be used to compile information across your dataset. Learn how aggregation works in GraphQL.

How to migrate my data after schema changes?

#platform#data-management#data-schema#fields#relations#migrations
When working with fields in your GraphQL schema, you might have to migrate existing data. More complex scenarios can be handled by a script.

Simple API Cheatsheet

#platform#simple-api#clients
All the capabilities of the Simple API collected in a compact cheatsheet.

Connecting to a GraphQL Server in Two Simple Steps

#platform#client-apis#clients
Connecting to a GraphQL server can be done in two simple steps with GraphQL clients like Apollo, Relay or Lokka.

How to model Locations in GraphQL?

#platform#locations#data-schema
In many applications, working with locations is of particular interest. Learn about best practices for the location type in GraphQL.

How to Use the GraphQL Directives Skip and Include?

#graphql#queries#mutations
GraphQL directives encode additional functionalities. Using the skip and include directives you can control the shape of queries and mutations.

Tips And Tricks: The GraphQL Playground

#graphql#variable#queries#mutations
The GraphQL Playground GraphiQL is a super handy tool. Use these simple tricks for a great developer experience when working with GraphQL.

Flexibility And Control With GraphQL Variables

#graphql#variable#queries#mutations
GraphQL variables extend queries and mutations to be more flexible and can be used for simple scalar values, enums or input object types.

The Mutation Payload In GraphQL

#graphql#mutations
Mutations can be used to execute different data changes. The mutation payload in GraphQL is the data that is returned as a result of the mutation.

Configuring Permissions For User Signup With GraphQL

#platform#permissions#authentication
The advanced permission system can be used to control user authentication for different types of applications.

Deleting all nodes of a specific model

#scripts#lokka#node#open-source
Using node and Lokka you can quickly delete all nodes of a specific model with a small script.

Uploading Remote Files with Node

#files#node#open-source
Using node and request you can upload remote files as form data.