https://github.com/guilospanck/dynamodb-and-nodejs
POC for using DynamoDB with Node.js
https://github.com/guilospanck/dynamodb-and-nodejs
aws aws-sdk-javascript dynamodb dynamodb-local nodejs
Last synced: 3 months ago
JSON representation
POC for using DynamoDB with Node.js
- Host: GitHub
- URL: https://github.com/guilospanck/dynamodb-and-nodejs
- Owner: Guilospanck
- Created: 2021-08-24T13:41:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-23T20:27:23.000Z (almost 4 years ago)
- Last Synced: 2025-02-12T12:55:46.153Z (4 months ago)
- Topics: aws, aws-sdk-javascript, dynamodb, dynamodb-local, nodejs
- Language: JavaScript
- Homepage:
- Size: 28.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DynamoDBAndNodejs
Simple POC to use DynamoDB with Node.js
## Step-By-Step
- First install AWS CLI
```bash
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
unzip awscliv2.zip
sudo ./aws/install
```
> Note that you must have unzip installed. If you don't, install it by running ``` sudo apt-get install unzip ```
- Now you must have DynamoDB on the run (AWS) or locally. To install locally, you will need Docker. The image used to run DynamoDB locally is ```amazon/dynamodb-local```. You can run it on your computer by typing on a terminal:
```bash
docker run --rm -p 8000:8000 -d amazon/dynamodb-local
```
- You`ll need AWS SDK For Javascript in order to run this examples. There are two versions: v2 and v3. The primary changes between them is that v3 is modularized (so you won't need to download every single package out there just to run one service from AWS) and have a middleware stack to control the lifecycle of an operation call. To install v2, do:
```bash
yarn add aws-sdk
```
To install v3 for DynamoDB, do:
```bash
yarn add @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb @aws-sdk/util-dynamodb
```
> You may reference to the commits in order to see the differences between v2 and v3 SDKs.
- To run locally, you need to AWS configure. To do that, follow this:
```bash
$ aws configure
AWS Access Key ID []: local
AWS Secret Access Key []: local
Default region name []: us-east-1
Default output format [None]:
```
## Running this POC
- Git clone this repository:
```bash
git clone https://github.com/Guilospanck/DynamoDBAndNodejs.git
```
- Run yarn install to install depedencies.
- Be sure to have the image in Docker up and running (see Step-By-Step for more information).
- And then run:
```bash
node src/table/createTable.js // to create a new DynamoDB table
node src/item/insertItem.js // to insert a new item in the table
node src/item/getItem.js // to get the new item inserted
```
# Referencies
- [AWS Docs - Class DocumentClient](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html)
- [AWS Docs - Using DocumentClient AWS SDK v2](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/dynamodb-example-document-client.html)
- [AWS Docs - Using DocumentClient AWS SDK v3](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-example-dynamodb-utilities.html)
- [AWS Docs - Getting Started With DynamoDB](https://docs.amazonaws.cn/en_us/amazondynamodb/latest/developerguide/GettingStartedDynamoDB.html)
- [AWS Docs - AWS SDK v3 DynamoDB Client](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-dynamodb/globals.html)