Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated docs to reference support for neptune analytics and clarified CDK documentation #45

Merged
merged 1 commit into from
Nov 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# **Amazon Neptune utility for GraphQL™ schemas and resolvers**

The Amazon Neptune utility for GraphQL™ is a Node.js command-line utility to help with the creation and maintenance of a GraphQL API for the Amazon Neptune database. It is a no-code solution for a GraphQL resolver when GraphQL queries have a variable number of input parameters and return a variable number of nested fields.
The Amazon Neptune utility for GraphQL™ is a Node.js command-line utility to help with the creation and maintenance of a GraphQL API for the Amazon Neptune Database or Neptune Analytics graph. It is a no-code solution for a GraphQL resolver when GraphQL queries have a variable number of input parameters and return a variable number of nested fields.

If you **start from a Neptune database with data**, the utility discover the graph database schema including nodes, edges, properties and edges cardinality, generate the GraphQL schema with the directives required to map the GraphQL types to the graph databases nodes and edges, and auto-generate the resolver code. We optimized the resolver code to reduce the latency of querying Amazon Neptune by returning only the data requested by the GraphQL query. *(Note: the utility works only for Property Graph databases, not RDF yet)*

Expand Down
16 changes: 14 additions & 2 deletions doc/cdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Copy from the utility CDK output files from the *output* directory in the CDK ap

Update the CDK test project, editing the file `bin/`*your-CDK-dir*`.js`
<br>
The file looks like this:
The original file looks like this:
```js
#!/usr/bin/env node

Expand All @@ -69,7 +69,19 @@ new CdkStack(app, 'CdkStack', {
});
```

Update the require and integrated the CDK class the utility created. Like this:
Update the require statement to reference the `AppSyncNeptuneStack` class from the `-cdk.js` file that was copied to the `lib` directory:

```js
const { AppSyncNeptuneStack } = require('../lib/your-new-GraphQL-API-name-cdk');
```

Update the stack instantiation to reference `AppSyncNeptuneStack` and change the stack name if desired:

```js
new AppSyncNeptuneStack(app, 'your-CdkStack-name', {
```

The end result should look something like this:
```js
#!/usr/bin/env node

Expand Down