Skip to content

Commit eed5d47

Browse files
authored
Merge pull request #257 from LackOfMorals/6.x
Added page for ending the beta
2 parents a431e08 + 34835b8 commit eed5d47

9 files changed

+146
-1
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,7 @@ target/
3636

3737
# node modules
3838
node_modules/
39-
.env
39+
.env
40+
41+
package-lock.json
42+
yarn.lock

modules/ROOT/content-nav.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@
6161
** xref:aura-graphql/deploy-and-operate.adoc[]
6262
** xref:aura-graphql/authentication-providers.adoc[]
6363
** xref:aura-graphql/using-your-api.adoc[]
64+
** xref:aura-graphql/end-of-beta-phase.adoc[]
65+
6466
6567
* xref:introspector.adoc[Introspector]
6668
Loading
Loading
Loading
Loading
Loading
2.13 KB
Loading
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
= End of beta phase
2+
3+
The beta phase of GraphQL for Neo4j AuraDB will end on the 18th of April 2025.
4+
To prevent data loss and wrap up your beta experience we suggest you take the following steps:
5+
6+
* Backup GraphQL Data API configuration
7+
* Remove the GraphQL Data API
8+
* Provide feedback
9+
10+
You are not required to take action.
11+
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.
12+
13+
14+
== Backup the GraphQL Data API configuration
15+
16+
Backing up your GraphQL Data API configuration makes re-use much quicker if you decide to use this feature once it is released.
17+
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.
18+
19+
There are two ways to perform a backup:
20+
21+
* Manually copy them one by one from the Aura Console
22+
* Using the Aura CLI to obtain everything in a single operation
23+
24+
25+
=== Console
26+
27+
If you want to retain only parts of the configuration, this is a quick method to do so.
28+
If you are intent on backing up all of the configuration, use the xref:#_aura_cli[] instead.
29+
30+
1. On Aura Console, select **Data API** from the left side navigation.
31+
+
32+
image::aura-graphql/console_data_api_sidebar.png[]
33+
+
34+
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**.
35+
+
36+
image::aura-graphql/console_data_api_edit_menu.png[]
37+
+
38+
3. Expand each of the sections and then make a note of the setting or copy as necessary.
39+
+
40+
image::aura-graphql/console_data_api_edit.png[]
41+
42+
43+
=== Aura CLI
44+
45+
This section assumes that you have configured the Aura CLI.
46+
If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[].
47+
48+
49+
1. Look up the Aura instance ID that the GraphQL API is being used with.
50+
+
51+
[source, bash, indent=0]
52+
----
53+
aura-cli instance list --output table
54+
----
55+
+
56+
57+
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.
58+
+
59+
[source, bash, indent=0]
60+
----
61+
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
62+
----
63+
+
64+
65+
3. Finally, obtain the configuration of the GraphQL API itself in JSON format.
66+
+
67+
[source, bash, indent=0]
68+
----
69+
aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID
70+
----
71+
+
72+
4. Save the output for future use.
73+
74+
[NOTE]
75+
====
76+
Type definitions are stored using Base64 encoding.
77+
Decode them to plain text before using with other systems.
78+
====
79+
80+
81+
== Removing the GraphQL Data API
82+
83+
Remove the GraphQL Data API either via Aura Console or with the Aura CLI.
84+
85+
[WARNING]
86+
====
87+
Once the GraphQL Data API has been deleted, it cannot be recovered.
88+
====
89+
90+
91+
=== Console
92+
93+
1. In Aura Console, select **Data API** from the left side navigation.
94+
+
95+
image::aura-graphql/console_data_api_sidebar.png[]
96+
+
97+
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**.
98+
+
99+
image::aura-graphql/console_data_api_delete_menu.png[]
100+
+
101+
3. Type in the name of your GraphQL API and confirm with **Delete**.
102+
+
103+
image::aura-graphql/console_data_api_confirm_delete_menu.png[]
104+
105+
106+
=== Aura CLI
107+
108+
This section assumes that you have configured the Aura CLI.
109+
If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[].
110+
111+
1. Locate the Aura instance ID that the GraphQL API is being used with.
112+
+
113+
[source, bash, indent=0]
114+
----
115+
aura-cli instance list --output table
116+
----
117+
+
118+
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.
119+
+
120+
[source, bash, indent=0]
121+
----
122+
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
123+
----
124+
+
125+
3. Delete the GraphQL API.
126+
+
127+
[WARNING]
128+
====
129+
The Aura CLI does not ask for confirmation and processes the command immediately.
130+
====
131+
+
132+
[source, bash, indent=0]
133+
----
134+
aura-cli data-api graphql delete YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID --output table
135+
----
136+
137+
138+
== Provide feedback
139+
140+
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).

0 commit comments

Comments
 (0)