diff --git a/.gitignore b/.gitignore index 0a9dd220..8b5e3395 100644 --- a/.gitignore +++ b/.gitignore @@ -36,4 +36,7 @@ target/ # node modules node_modules/ -.env \ No newline at end of file +.env + +package-lock.json +yarn.lock diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 31681d03..c61978cb 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -61,6 +61,8 @@ ** xref:aura-graphql/deploy-and-operate.adoc[] ** xref:aura-graphql/authentication-providers.adoc[] ** xref:aura-graphql/using-your-api.adoc[] +** xref:aura-graphql/end-of-beta-phase.adoc[] + * xref:introspector.adoc[Introspector] diff --git a/modules/ROOT/images/aura-graphql/console_data_api_confirm_delete_menu.png b/modules/ROOT/images/aura-graphql/console_data_api_confirm_delete_menu.png new file mode 100644 index 00000000..9529c338 Binary files /dev/null and b/modules/ROOT/images/aura-graphql/console_data_api_confirm_delete_menu.png differ diff --git a/modules/ROOT/images/aura-graphql/console_data_api_delete_menu.png b/modules/ROOT/images/aura-graphql/console_data_api_delete_menu.png new file mode 100644 index 00000000..46ad28be Binary files /dev/null and b/modules/ROOT/images/aura-graphql/console_data_api_delete_menu.png differ diff --git a/modules/ROOT/images/aura-graphql/console_data_api_edit.png b/modules/ROOT/images/aura-graphql/console_data_api_edit.png new file mode 100644 index 00000000..ad8a0c90 Binary files /dev/null and b/modules/ROOT/images/aura-graphql/console_data_api_edit.png differ diff --git a/modules/ROOT/images/aura-graphql/console_data_api_edit_menu.png b/modules/ROOT/images/aura-graphql/console_data_api_edit_menu.png new file mode 100644 index 00000000..2cc955a2 Binary files /dev/null and b/modules/ROOT/images/aura-graphql/console_data_api_edit_menu.png differ diff --git a/modules/ROOT/images/aura-graphql/console_data_api_sidebar.png b/modules/ROOT/images/aura-graphql/console_data_api_sidebar.png new file mode 100644 index 00000000..a9571585 Binary files /dev/null and b/modules/ROOT/images/aura-graphql/console_data_api_sidebar.png differ diff --git a/modules/ROOT/images/aura-graphql/three-dots.png b/modules/ROOT/images/aura-graphql/three-dots.png new file mode 100644 index 00000000..8f9f1af6 Binary files /dev/null and b/modules/ROOT/images/aura-graphql/three-dots.png differ diff --git a/modules/ROOT/pages/aura-graphql/end-of-beta-phase.adoc b/modules/ROOT/pages/aura-graphql/end-of-beta-phase.adoc new file mode 100644 index 00000000..66508fec --- /dev/null +++ b/modules/ROOT/pages/aura-graphql/end-of-beta-phase.adoc @@ -0,0 +1,140 @@ += End of beta phase + +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 xref:#_aura_cli[] instead. + +1. On Aura Console, select **Data API** from the left side navigation. ++ +image::aura-graphql/console_data_api_sidebar.png[] ++ +2. 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**. ++ +image::aura-graphql/console_data_api_edit_menu.png[] ++ +3. Expand each of the sections and then make a note of the setting or copy as necessary. ++ +image::aura-graphql/console_data_api_edit.png[] + + +=== Aura CLI + +This section assumes that you have configured the Aura CLI. +If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[]. + + +1. Look up the Aura instance ID that the GraphQL API is being used with. ++ +[source, bash, indent=0] +---- +aura-cli instance list --output table +---- ++ + +2. 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. ++ +[source, bash, indent=0] +---- +aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table +---- ++ + +3. Finally, obtain the configuration of the GraphQL API itself in JSON format. ++ +[source, bash, indent=0] +---- +aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID +---- ++ +4. Save the output for future use. + +[NOTE] +==== +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. + +[WARNING] +==== +Once the GraphQL Data API has been deleted, it cannot be recovered. +==== + + +=== Console + +1. In Aura Console, select **Data API** from the left side navigation. ++ +image::aura-graphql/console_data_api_sidebar.png[] ++ +2. 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**. ++ +image::aura-graphql/console_data_api_delete_menu.png[] ++ +3. Type in the name of your GraphQL API and confirm with **Delete**. ++ +image::aura-graphql/console_data_api_confirm_delete_menu.png[] + + +=== Aura CLI + +This section assumes that you have configured the Aura CLI. +If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[]. + +1. Locate the Aura instance ID that the GraphQL API is being used with. ++ +[source, bash, indent=0] +---- +aura-cli instance list --output table +---- ++ +2. 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. ++ +[source, bash, indent=0] +---- +aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table +---- ++ +3. Delete the GraphQL API. ++ +[WARNING] +==== +The Aura CLI does not ask for confirmation and processes the command immediately. +==== ++ +[source, bash, indent=0] +---- +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 (https://github.com/neo4j/graphql/issues/new/choose)[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).