You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/aura-graphql/ending-with-the-beta.adoc
+35-41Lines changed: 35 additions & 41 deletions
Original file line number
Diff line number
Diff line change
@@ -1,83 +1,86 @@
1
-
= Ending with the Beta
1
+
= End of beta phase
2
2
3
-
On the 18th April the Beta will end. If you have already achieved what you set out to do or will be wrapping up before that date, there are three steps that we suggest you take
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:
4
5
5
6
* Backup GraphQL Data API configuration
6
7
* Remove the GraphQL Data API
7
8
* Provide feedback
8
9
9
-
Doing nothing is an option although you need to be aware that any running GraphQL Data API after the 18th April will be terminated resulting in the loss of it configuration information including Type Definitions. You strongly advised to take action before that time.
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.
10
12
11
13
12
14
== Backup the GraphQL Data API configuration
13
15
14
-
Saving your GraphQL Data API configuration makes re-use much quicker if you decide to use this feature once it is released fully. If you don't want to do that and want to run your own GraphQL service, part of the retreived information includes the Type Definitions that can be used for that purpose
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.
15
18
16
-
There are two ways to perform a backup
19
+
There are two ways to perform a backup:
17
20
18
-
* Manually copy them one by one from the Console
19
-
* Using the Aura CLI to obtain everything in one operation
21
+
* Manually copy them one by one from the Aura Console
22
+
* Using the Aura CLI to obtain everything in a single operation
20
23
21
24
22
25
=== Console
23
-
If you want to retain only parts of the configuration, this is a fairly quick method to do so. If you are intent on backing up all of the configuration is it recommended to use the Aura CLI
24
26
25
-
1. After entering the Console, select *Data API* from the left hand navigation bar
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.
2. A table will be shown that contains your GraphQL Data APIs. On the row with the GraphQL Data API that you wish to backup, click image:aura-graphql/three-dots.png[] and, from the menu, choose *Edit*
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**.
3. Expand each of the sections and then make a note of the setting or copy as necessary
38
+
3. Expand each of the sections and then make a note of the setting or copy as necessary.
36
39
+
37
40
image::aura-graphql/console_data_api_edit.png[]
38
-
+
39
-
4. When you are finished, select *Back*
40
41
41
42
42
43
=== Aura CLI
43
44
44
-
It is assumed that you have already configured the Aura CLI. If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[`Install and configure the Aura CLI`]
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[].
45
47
46
48
47
-
1. Lookup the Aura instance ID that the GraphQL API is being used with
49
+
1. Look up the Aura instance ID that the GraphQL API is being used with.
48
50
+
49
51
[source, bash, indent=0]
50
52
----
51
53
aura-cli instance list --output table
52
54
----
53
55
+
54
56
55
-
2. From the displayed table, make a note of relevant Aura ID. This ID will then be used to obtain the ID of the GraphQL API whose configuration will be backed up.
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.
56
58
+
57
59
[source, bash, indent=0]
58
60
----
59
61
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
60
62
----
61
63
+
62
64
63
-
3. Finally, obtain the configuration of the GraphQL API itself that will be shown to you in the form of a JSON document.
65
+
3. Finally, obtain the configuration of the GraphQL API itself in JSON format.
64
66
+
65
67
[source, bash, indent=0]
66
68
----
67
69
aura-cli data-api graphql get YOUR_GRAPHQL_DATA_API_ID --instance-id YOUR_AURA_INSTANCE_ID
68
70
----
69
71
+
70
-
71
-
4. Save the output to safe location for any future use.
72
+
4. Save the output for future use.
72
73
73
74
[NOTE]
74
75
====
75
-
Type Definitions are stored using Base64 encoding. You will need to decode them back to plain text before using with other systems.
76
+
Type definitions are stored using Base64 encoding.
77
+
Decode them to plain text before using with other systems.
76
78
====
77
79
78
80
79
81
== Removing the GraphQL Data API
80
-
This can be performed using the Console or with the Aura CLI. Both methods are described below
82
+
83
+
Remove the GraphQL Data API either via Aura Console or with the Aura CLI.
81
84
82
85
[WARNING]
83
86
====
@@ -86,28 +89,24 @@ Once the GraphQL Data API has been deleted, it cannot be recovered.
86
89
87
90
88
91
=== Console
89
-
1. After entering the Console, select *Data API* from the left hand navigation bar
92
+
93
+
1. In Aura Console, select **Data API** from the left side navigation.
2. A table will be shown that contains your GraphQL Data APIs. On the row with the GraphQL Data API that you wish to remove, click image:aura-graphql/three-dots.png[] and, from the menu, choose *Delete*
95
-
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**.
It is assumed that you have already configured the Aura CLI. If you have not, follow the guidance provided in xref:aura-graphql/prerequisites.adoc#_install_and_configure_the_aura_cli[`Install and configure the 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[].
111
110
112
111
1. Locate the Aura instance ID that the GraphQL API is being used with.
113
112
+
@@ -116,29 +115,24 @@ It is assumed that you have already configured the Aura CLI. If you have not, f
116
115
aura-cli instance list --output table
117
116
----
118
117
+
119
-
120
-
2. From the displayed table, make a note of relevant Aura ID. This ID will then be used to obtain the ID of the GraphQL API whose configuration will be backed up.
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.
121
119
+
122
120
[source, bash, indent=0]
123
121
----
124
122
aura-cli data-api graphql list --instance-id YOUR_AURA_INSTANCE_ID --output table
125
123
----
126
124
+
127
-
128
125
3. Delete the GraphQL API.
129
126
+
130
127
[WARNING]
131
128
====
132
-
The Aura CLI does not ask for confirmation and processes the commmand immediately.
129
+
The Aura CLI does not ask for confirmation and processes the command immediately.
0 commit comments