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
-[here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/todoExample.md) an example using a TODO GraphQL schema, showing the outputs of the utility.
92
+
-[Here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/todoExample.md) is an example using a TODO GraphQL schema, showing the outputs of the utility.
93
93
- If you are wondering which AWS resources the utility is creating, look at the section below.
94
94
- To customize the GraphQL schema, look at the section below.
95
95
@@ -113,7 +113,7 @@ In case you don't want your Graph API having the option of updating your databas
113
113
114
114
115
115
### @alias
116
-
This directive can be applied to GraphQL schema types or fields. It maps different names between the graph database and the GraphQL schema. The syntax is *@alias(property: your-name)*. In the example below *airport* is the graph database node label mapped to the *Airport* GraphQL type, and *desc* is the property of the graph database node mapped to the field *description*. See the [Air Routes Example](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/routesExample.md). The GraphQL guidence is pascal case for types and camel case for fields.
116
+
This directive can be applied to GraphQL schema types or fields. It maps different names between the graph database and the GraphQL schema. The syntax is *@alias(property: your-name)*. In the example below *airport* is the graph database node label mapped to the *Airport* GraphQL type, and *desc* is the property of the graph database node mapped to the field *description*. See the [Air Routes Example](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/routesExample.md). The GraphQL guidance is pascal case for types and camel case for fields.
117
117
118
118
```graphql
119
119
typeAirport@alias(property: "airport") {
@@ -160,7 +160,7 @@ type Mutation {
160
160
}
161
161
```
162
162
163
-
YoucanaddqueryormututationusingaGremlinquery. AtthistimeGremlinqueriesarelimitedtoreturn *scalar* values, or *elementMap()* forasinglenode, or *elementMap().fold()* foralistofnodes.
163
+
YoucanaddaqueryormutationusingaGremlinquery. AtthistimeGremlinqueriesarelimitedtoreturn *scalar* values, or *elementMap()* forasinglenode, or *elementMap().fold()* foralistofnodes.
164
164
```graphql
165
165
typeQuery {
166
166
getAirportWithGremlin(code:String): Airport@graphQuery(statement: "g.V().has('airport', 'code', '$code').elementMap()") # single node
@@ -215,7 +215,7 @@ type Mutation {
215
215
```
216
216
217
217
### Re-apply your changes with --input-schema-changes-file
218
-
YoumightwanttomodifytheGraphQLsourceschema and run the utility again getting the latest schema from your Neptune database. Every time the utility discover the a new graphdb schema it generates a new GraphQL schema. To inject your changes, you can manually edit the GraphQL source schema, and run the utility again using it as input instead of the Neptune database endpoint, or write your changes the file format below. As you run the utility with the option `--input-schema-changes-file <value>`, your changes will be applied at once.
218
+
YoumightwanttomodifytheGraphQLsourceschema and run the utility again to get the latest schema from your Neptune database. Every time the utility discovers a new graphdb schema, it generates a new GraphQL schema. To inject your changes, you can manually edit the GraphQL source schema and run the utility again, using it as input instead of the Neptune database endpoint, or write your changes in the format below. As you run the utility with the added option `--input-schema-changes-file <your-changes-file>`, your changes will be applied at once.
219
219
```json
220
220
[
221
221
{ "type": "graphQLTypeName",
@@ -260,15 +260,15 @@ Independently of the method you or the utility will need to create the following
260
260
With the CLI option `--create-update-aws-pipeline`, and its accesory options ([see the commands reference](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/cliReference.md)), the utility automatically creates the resources.<br>
261
261
You need to run the utility from a shell in which you installed the AWS CLI, and it is configured for a user with the permission of creating AWS resources. <br>
262
262
The utility creates a file with the list of resources named *pipeline-name.resources.json*. Then it uses the file to modify the existing resources when the user runs the command again, or when the user wants to delete the AWS resources with the command option `--remove-aws-pipeline-name <value>`.
263
-
The code of the utiliy uses the JavaScript AWS sdk v3, if you'd like to review the code is only in [this file](https://github.com/aws/amazon-neptune-for-graphql/blob/main/src/pipelineResources.js).
263
+
The code of the utility uses the JavaScript AWS sdk v3, if you'd like to review the code is only in [this file](https://github.com/aws/amazon-neptune-for-graphql/blob/main/src/pipelineResources.js).
264
264
265
265
### I prefer a CDK file
266
266
To option to trigger the creation of the CDK file starts with `--output-aws-pipeline-cdk`, and its accessory options ([see the commands reference](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/cliReference.md)). <br>
267
267
After you ran it, you will find in the *output* folder the file *CDK-pipeline-name-cdk.js* and *CDK-pipeline-name.zip*. The ZIP file is the code for the Lambda function.
268
268
See CDK end to end example [here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/cdk.md).
269
269
270
270
### Let me setup the resources manually or with my favorite DevOps toolchain
271
-
[Here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/resources.md) the detailed list of resorces needed to configure the GraphQL API pipeline.
271
+
[Here](https://github.com/aws/amazon-neptune-for-graphql/blob/main/doc/resources.md) the detailed list of resources needed to configure the GraphQL API pipeline.
272
272
<br>
273
273
274
274
# Known limitations
@@ -290,7 +290,7 @@ A copy of the License is located at http://www.apache.org/licenses/LICENSE-2.0
290
290
or in the "license" file accompanying this file. This file is distributed
291
291
on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
292
292
express or implied. See the License for the specific language governing
293
-
permissions and limitations under the License. [Full licence page](/LICENSE.txt).
293
+
permissions and limitations under the License. [Full license page](/LICENSE.txt).
The file that contains your GraphQL schema changes to be applied when you run the utility multiple time. When you run the utility poiniting to a database multiple times, and you manually changed the GraphQL source schema, maybe adding a custom query, your chnages will be lost. To avoid it, add your changes to the a json file and pass it to this option. See section [*Re-apply your changes*](#re-apply-your-changes-with---input-schema-changes-file) for the file format.
23
+
The file that contains your GraphQL schema changes to be applied when you run the utility multiple time. When you run the utility pointing to a database multiple times, and you manually changed the GraphQL source schema, maybe adding a custom query, your changes will be lost. To avoid it, add your changes to the a json file and pass it to this option. See section [*Re-apply your changes*](#re-apply-your-changes-with---input-schema-changes-file) for the file format.
24
24
25
25
```json
26
26
[
@@ -64,7 +64,7 @@ The graphdb schema as data or file name. Instead of pointing to a Neptune databa
@@ -135,7 +135,7 @@ It removes the pipeline created with `--create-update-aws-pipeline`. The resourc
135
135
<br>
136
136
This trigger the creation of a CDK file to be use to create the AWS resources for the GraphQL API, including the AppSync GraphQL API and the Lambda that run the resolver.
This set the Neptune database endpoint used by the Lambda function to query the Neptune database. If not set it used the endpoint set with `--input-graphdb-schema-neptune-endpoint`.
0 commit comments