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

Release DynamoDB v0.1.1 #397

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
75 changes: 75 additions & 0 deletions registry/hasura/dynamodb/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# DynamoDB for NoSQL Connector

[![Docs](https://img.shields.io/badge/docs-v3.x-brightgreen.svg?style=flat)](https://hasura.io/docs/3.0/latest/connectors/dynamodb/)
[![ndc-hub](https://img.shields.io/badge/ndc--hub-dynamodb-blue.svg?style=flat)](https://hasura.io/connectors/dynamodb)
[![License](https://img.shields.io/badge/license-Apache--2.0-purple.svg?style=flat)](LICENSE.txt)
[![Status](https://img.shields.io/badge/status-alpha-yellow.svg?style=flat)](./readme.md)

With this connector, Hasura allows you to instantly create a real-time GraphQL API on top of your data models in DynamoDB for NoSQL Database containers. This connector supports DynamoDB for NoSQL's functionalities listed in
the table below, allowing for efficient and scalable data operations.

This connector is built using the [Rust Data Connector SDK](https://github.com/hasura/ndc-hub#rusk-sdk) and implements
the [Data Connector Spec](https://github.com/hasura/ndc-spec).

- [Connector information in the Hasura Hub](https://hasura.io/connectors/dynamodb)
- [Hasura V3 Documentation](https://hasura.io/docs/3.0)

## Features

Below, you'll find a matrix of all supported features for the DynamoDB for NoSQL connector:

| Feature | Supported | Notes |
|---------------------------------|-----------|-------|
| Native Queries + Logical Models | ❌ | |
| Simple Object Query | ✅ | |
| Filter / Search | ✅ | |
| Simple Aggregation | ❌ | |
| Sort | ✅ | |
| Paginate | ✅ | |
| Nested Objects | ❌ | |
| Nested Arrays | ❌ | |
| Nested Filtering | ❌ | |
| Nested Sorting | ❌ | |
| Nested Relationships | ❌ | |

## Prerequisites

1. Create a [Hasura Cloud account](https://console.hasura.io)
2. Please ensure you have the [DDN CLI](https://hasura.io/docs/3.0/cli/installation) and
[Docker](https://docs.docker.com/engine/install/) installed
3. [Create a supergraph](https://hasura.io/docs/3.0/getting-started/init-supergraph)
4. [Create a subgraph](https://hasura.io/docs/3.0/getting-started/init-subgraph)

The steps below explain how to initialize and configure a connector on your local machine (typically for development
purposes).You can learn how to deploy a connector to Hasura DDN — after it's been configured —
[here](https://hasura.io/docs/3.0/getting-started/deployment/deploy-a-connector).

## Using the DynamoDB for NoSQL connector

With the [context set](https://hasura.io/docs/3.0/cli/commands/ddn_context_set/) for an existing subgraph, initialize
the connector by choosing `hasura/dynamodb`. When the wizard runs, you'll also be prompted to enter the following
env vars necessary for your connector to function:

| Name | Description | Required |
| ----------------------------------------- | --------------------------------------------------------------------------- | -------- |
| HASURA_DYNAMODB_AWS_ACCESS_KEY_ID | The AWS DynamoDB access key ID | Yes |
| HASURA_DYNAMODB_AWS_SECRET_ACCESS_KEY | The AWS DynamoDB secret access key | Yes |
| HASURA_DYNAMODB_AWS_REGION | The region of the AWS DynamoDB database | Yes |

After the CLI initializes the connector, you'll need to:

- [Introspect](https://hasura.io/docs/3.0/cli/commands/ddn_connector_introspect) the source.
- Add your [models](https://hasura.io/docs/3.0/cli/commands/ddn_model_add),
[commands](https://hasura.io/docs/3.0/cli/commands/ddn_command_add),
- Create a [new build](https://hasura.io/docs/3.0/cli/commands/ddn_supergraph_build_local).
- Test it by [running your project along with the connector](https://hasura.io/docs/3.0/cli/commands/ddn_run#examples).

## Contributing

We're happy to receive any contributions from the community. Please refer to our
[development guide](https://github.com/hasura/ndc-dynamodb/blob/main/docs/development.md).

## License

The Hasura DynamoDB for NoSQL connector is available under the
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
Binary file added registry/hasura/dynamodb/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions registry/hasura/dynamodb/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"overview": {
"namespace": "hasura",
"description": "Connect to a DynamoDB database and expose it to Hasura v3 Project",
"title": "DynamoDB Connector",
"logo": "logo.png",
"tags": ["database"],
"latest_version": "v0.1.1"
},
"author": {
"support_email": "[email protected]",
"homepage": "https://hasura.io",
"name": "Hasura"
},
"is_verified": true,
"is_hosted_by_hasura": true,
"packages": [
{
"version": "0.1.1",
"uri": "https://github.com/hasura/ndc-dynamodb/releases/download/v0.1.1/package.tar.gz",
"checksum": {
"type": "sha256",
"value": "17dc787eb150d85ea3e8c0aef977d4930b24c11f09673ed3138ea65565001803"
},
"source": {
"hash": "ce61f5f562a2c34180becc74d4d5f28ba0840a1f"
}
}
],
"source_code": {
"is_open_source": true,
"repository": "https://github.com/hasura/ndc-dynamodb/",
"version": [
{
"tag": "v0.1.1",
"hash": "ce61f5f562a2c34180becc74d4d5f28ba0840a1f",
"is_verified": true
}
]
}
}

12 changes: 12 additions & 0 deletions registry/hasura/dynamodb/releases/connector-packaging.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": "0.1.1",
"uri": "https://github.com/hasura/ndc-dynamodb/releases/download/v0.1.1/package.tar.gz",
"checksum": {
"type": "sha256",
"value": "17dc787eb150d85ea3e8c0aef977d4930b24c11f09673ed3138ea65565001803"
},
"source": {
"hash": "ce61f5f562a2c34180becc74d4d5f28ba0840a1f"
}
}

Loading