We’re overhauling Dgraph’s docs to make them clearer and more approachable. If
you notice any issues during this transition or have suggestions, please
let us know.
Step 1: Run Dgraph
The recommended way to get started with Dgraph is by using the official Dgraph Docker image.Step 2: Deploy a GraphQL Schema
-
In the Schema tab of the console, paste
the following schema:
-
Click
deploy
You now have a GraphQL API up and running and a graph database as a backend.
Step 3: Test your GraphQL API
You can access theGraphQL endpoint
with any GraphQL clients such as
GraphQL Playground,
Insomnia,
GraphiQL,
Altair or Postman.
If you want to use those clients, copy the GraphQL endpoint
from the
Cloud dashboard.
You may want to use the introspection capability of the client to explore the
schema, queries, and mutations that were generated by Dgraph.
A first GraphQL mutation
To populate the database,- Open the API Explorer tab
-
Paste the following code into the text area:
-
Click Execute Query .
The GraphQL server returns a JSON response similar to this:
A second GraphQL mutation
Because the schema defined Customer with the fieldusername: String! @id
, the
username
field acts like an ID, so we can identify customers just with their
names.
Products, on the other hand, had productID: ID!
, so they’ll get an
auto-generated ID which are returned by the mutation.
- Paste the following mutation in the text area of the API Explorer tab.
-
Your ID for the product might be different than
0x2
. Make sure to replace the product ID with the ID from the response of the previous mutation. -
Execute the mutation
This time, the mutation result queries for the author making the review and the product being reviewed, so it’s gone deeper into the graph to get the result than just the mutation data.
GraphQL queries
With Dgraph, you get powerful graph search built into your GraphQL API. The schema for search is generated from the schema document that we started with and automatically added to the GraphQL API for you. Remember the definition of a review.@search(by: [fulltext])
tells Dgraph we want to be able to
search for comments with full-text search.
Dgraph took that directive and the other information in the schema, and built
queries and search into the API.
Let’s find all the products that were easy to install.
- Paste the following query in the text area of the API Explorer tab.
-
Execute the mutation