Skip to content

Commit

Permalink
doc: Adding a note on backend modes
Browse files Browse the repository at this point in the history
  • Loading branch information
gja committed Sep 3, 2020
1 parent c3cafdc commit 95d7c54
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
26 changes: 26 additions & 0 deletions wiki/content/slash-graphql/admin/backend-modes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
+++
title = "Switching Backend Modes"
[menu.main]
parent = "slash-graphql-admin"
weight = 6
+++

Slash GraphQL supports different 3 different backend modes, which controls how the underlying Dgraph instance is configured

### Readonly Mode

In readonly mode, only queries are allowed. All mutations and attempts to alter schema will be disallowed.

### GraphQL Mode

GraphQL mode is the default setting on Slash GraphQL, and is suitable for backends where the primary mode of interaction is via the GraphQL APIs. You can use of DQL/GraphQL+- queries and mutations, as described in the [advanced queries](/slash-graphql/advanced-queries/) section. However, all queries and mutations must be valid as per the applied GraphQL schema.

### Flexible Mode

Flexible mode is suitable for users who are already familiar with Dgraph, and intent to interact with their backend with DQL/GraphQL+-. Flexible mode removes any restrictions on queries and mutations, and also provides users access to advanced Dgraph features like directly altering the schema with the `/alter` http and GRPC endpoints.

Running your backend in flexible mode is also a requirement for upcoming features such as support for Dgraph's ACL.

## Changing your Backend Mode

You can change the backend mode on the [settings page](https://slash.dgraph.io/_/settings), under the "Advanced" tab.
4 changes: 4 additions & 0 deletions wiki/content/slash-graphql/advanced-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,7 @@ In order to configure Ratel, please do the following:
You may now queries and mutation via Ratel, and see visualizations of your data.

However, please note that certain functionality will not work, such as running Backups, modifying ACL or attempting to remove nodes from the cluster.

### Switching Backend Modes

For those who are interested in using DQL/GraphQL+- as their primary mode of interaction with the backend, it is possible to switch your backend to flexible mode. Please see [Backend Modes](/slash-graphql/admin/backend-modes)

0 comments on commit 95d7c54

Please sign in to comment.