End of beta phase

This is the documentation of the GraphQL Library version 7. For the long-term support (LTS) version 5, refer to GraphQL Library version 5 LTS.

The beta phase of GraphQL for Neo4j AuraDB will end on the 18th of April 2025. To prevent data loss and wrap up your beta experience we suggest you take the following steps:

Backup GraphQL Data API configuration
Remove the GraphQL Data API
Provide feedback

You are not required to take action. However, any running GraphQL Data API will be terminated after the 18th of April, resulting in the loss of its configuration information including type definitions.

Backup the GraphQL Data API configuration

Backing up your GraphQL Data API configuration makes re-use much quicker if you decide to use this feature once it is released. If you want to run your own GraphQL service instead, the backup might still be useful since it includes the type definitions which can be used for that purpose.

There are two ways to perform a backup:

Manually copy them one by one from the Aura Console
Using the Aura CLI to obtain everything in a single operation

Console

If you want to retain only parts of the configuration, this is a quick method to do so. If you are intent on backing up all of the configuration, use the Aura CLI instead.

On Aura Console, select Data API from the left side navigation.
The table shows your GraphQL Data APIs. Use the three dots on the row with the GraphQL Data API that you wish to backup and select Edit.
Expand each of the sections and then make a note of the setting or copy as necessary.

Aura CLI

This section assumes that you have configured the Aura CLI. If you have not, follow the guidance provided in aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli.

Look up the Aura instance ID that the GraphQL API is being used with.
```
aura-cli instance list --output table
```
From the displayed table, make a note of relevant Aura ID. Use this ID to obtain the ID of the GraphQL API whose configuration you want to back up.
```
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
```

Finally, obtain the configuration of the GraphQL API itself in JSON format.

aura-cli data-api graphql get  YOUR_GRAPHQL_DATA_API_ID  --instance-id YOUR_AURA_INSTANCE_ID

Save the output for future use.

Type definitions are stored using Base64 encoding. Decode them to plain text before using with other systems.

Removing the GraphQL Data API

Remove the GraphQL Data API either via Aura Console or with the Aura CLI.

Once the GraphQL Data API has been deleted, it cannot be recovered.

Console

In Aura Console, select Data API from the left side navigation.
The table contains your GraphQL Data APIs. Use the three dots on the row with the GraphQL Data API that you wish to remove and select Delete.
Type in the name of your GraphQL API and confirm with Delete.

Aura CLI

This section assumes that you have configured the Aura CLI. If you have not, follow the guidance provided in aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli.

Locate the Aura instance ID that the GraphQL API is being used with.
```
aura-cli instance list --output table
```
From the displayed table, make a note of the relevant Aura ID. Use the ID to obtain the ID of the GraphQL API whose configuration you want to back up.
```
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
```

Delete the GraphQL API.

The Aura CLI does not ask for confirmation and processes the command immediately.

aura-cli data-api graphql delete YOUR_GRAPHQL_DATA_API_ID  --instance-id YOUR_AURA_INSTANCE_ID --output table

Provide feedback

Please consider taking a few moments to provide feedback either by creating an issue in our (GitHub repository or using our #graphql channel on our [Discord Community](https://discord.gg/M8mTADEJ) or our [forums](https://community.neo4j.com/c/drivers-stacks/graphql/33).