DynamoDB localを使ってDynamoDBをローカルでデプロイする

概要

DynamoDBはウェブサービスとして利用できるほか、別に提供されているDynamoDB Localを使えばDynamoDBを開発用ローカルDBサーバとしてデプロイすることができます。
DynamoDB Localに関する公式ドキュメントは以下の通り。

上記の記述の通り、DynamoDB Localは実行可能な.jarファイルとして提供されているほか、Dockerイメージとしても提供されており、docker-composeで簡単にデプロイすることができます。

今回は公式の記述を参考にしつつ、docker-composeでDynamoDB Localをデプロイし、Node.js上から読み書きするまでを行ってみたいと思います。

dynamodb-admin

また、dynamodb-adminというDynamoDB Local用のGUIを提供してくれるnpmモジュールがあります。
CLIよりもGUIで確認できたほうが便利だと思うので、こちらも一緒にデプロイしてみます。

環境

ソフトウェア	バージョン
OS	Windows 10
Docker	Docker version 20.10.7, build f0df350
docker-compose	docker-compose version 1.29.2, build 5becea4c
Node.js	v14.15.0
yarn	1.22.10
@aws-sdk/client-dynamodb	3.22.0

ディレクトリ構成

ディレクトリ構成は以下になります。

- docker-compose.yml
- dynamodb-admin/
  |- node_modules
  |- Dockerfile
  |- package.json
  |- yarn.lock
- dynamodb-client/
  |- node_modules
  |- index.js
  |- package.json
  |- yarn.lock

dynamodb-admin/ではdynamodb-admin用のDockerコンテナを作るために用意します。
dynamodb-client/ではDynamoDB Localへデータを読み書きするスクリプトを用意します。

docker-compose.yml

docker-compose.yml

version: '3'

services:
  dynamodb-local:
    command: "-jar DynamoDBLocal.jar -sharedDb -optimizeDbBeforeStartup -dbPath ./data"
    image: "amazon/dynamodb-local:latest"
    ports:
    - "8000:8000"
    volumes:
    - "./dynamodb:/home/dynamodblocal/data"
    working_dir: /home/dynamodblocal

  dynamodb-admin:
    build:
      context: ./dynamodb-admin
      dockerfile: Dockerfile
    working_dir: /usr/src/dynamodbadmin
    volumes:
    - dynamodbadmin-node_modules:/usr/src/dynamodbadmin/node_modules
    ports:
    - "8001:8001"

volumes:
  dynamodbadmin-node_modules:

dynamodb-admin

dynamodb-adminをインストール

cd dynamodb-admin
npm init -y
yarn add dynamodb-admin

Dockerfileを作成

dynamodb-admin/Dockerfile

FROM node:14-slim

ENV DYNAMO_ENDPOINT=http://dynamodb-local:8000

WORKDIR /usr/src/dynamodbadmin

ADD package.json package.json
ADD yarn.lock yarn.lock

RUN yarn install

EXPOSE 8001

CMD ["yarn", "start"]

package.jsonのscriptsに追加する

以下のスクリプトを追加してDockerから実行できるようにします。

dynamodb-admin/package.json

  "scripts": {
    "start": "dynamodb-admin",
  }

コンテナを起動する

docker-compose up

正常に動作していれば以下のようなログが出力されます。

dynamodb-local_1  | Initializing DynamoDB Local with the following configuration: 
dynamodb-local_1  | Port:       8000
dynamodb-local_1  | InMemory:   false
dynamodb-local_1  | DbPath:     ./data
dynamodb-local_1  | SharedDb:   true
dynamodb-local_1  | shouldDelayTransientStatuses:       false
dynamodb-local_1  | CorsParams: *
dynamodb-local_1  |
dynamodb-admin_1  | yarn run v1.22.5
dynamodb-admin_1  | $ dynamodb-admin
dynamodb-admin_1  |   database endpoint:        http://dynamodb-local:8000
dynamodb-admin_1  |   region:           us-east-1
dynamodb-admin_1  |   accessKey:                key
dynamodb-admin_1  | 
dynamodb-admin_1  |   dynamodb-admin listening on http://localhost:8001 (alternatively http://0.0.0.0:8001)

上記のログに書いてあるhttp://localhost:8001にアクセスすると以下のようなページが表示されます。
この画面から、DynamoDB Localのテーブルを作成したり、項目の追加・削除などをしたりすることができます。

AWS SDK for JavaScript v3を使って項目を読み書きする

dynamodb-adminのGUIからDynamoDB Localに対する操作はできるものの、通常の開発では普通プログラムから操作することになると思われるので、デプロイしたDynamoDB Localに対してNode.jsから読み書きを行ってみたいと思います。
以下のドキュメントを参考に、簡単なスクリプトを作成します。

AWS SDKをインストール

cd dynamodb-client
npm init -y
yarn add @aws-sdk/client-dynamodb

スクリプトを作成

このスクリプトではDynamoDB Localに対して以下の操作を行っています。

• テーブルBooksを作成
• 項目を一つ作成する
• 作成した項目を読み込む

dynamodb-client/index.js

const { DynamoDBClient, PutItemCommand, CreateTableCommand, GetItemCommand } = require("@aws-sdk/client-dynamodb");

(async () => {
  const client = new DynamoDBClient({ endpoint: 'http://localhost:8000' });
  const TableName = 'Books'

  try {
    await client.send(new CreateTableCommand({
      TableName,
      KeySchema: [
        { AttributeName: 'Writer', KeyType: 'HASH' },
        { AttributeName: 'BookTitle', KeyType: 'RANGE' },
      ],
      AttributeDefinitions: [
        { AttributeName: 'Writer', AttributeType: 'S' },
        { AttributeName: 'BookTitle', AttributeType: 'S' },
      ],
      BillingMode: 'PAY_PER_REQUEST'
    }))

    await client.send(new PutItemCommand({
      TableName,
      Item: {
        'Writer': {
          'S': '太宰治'
        },
        'BookTitle': {
          'S': '人間失格'
        }
      }
    }))

    const result = await client.send(new GetItemCommand({
      TableName,
      Key: {
        'Writer': {
          'S': '太宰治'
        },
        'BookTitle': {
          'S': '人間失格'
        }
      }
    }))

    console.log(result)
  } catch (err) {
    console.error(err)
  }
})()

ポイントは以下の一行です。

  const client = new DynamoDBClient({ endpoint: 'http://localhost:8000' });

DynamoDBClientを作成する際に、endpointにコンテナ起動したDynamoDB LocalのURLを指定します。

スクリプトを実行する

node index.js

コンソール上には以下のように出力されます。

{
  '$metadata': {
    httpStatusCode: 200,
    requestId: '53cdcec1-7c53-4a4c-a73b-89b61b5f2238',
    extendedRequestId: undefined,
    cfId: undefined,
    attempts: 1,
    totalRetryDelay: 0
  },
  ConsumedCapacity: undefined,
  Item: { BookTitle: { S: '人間失格' }, Writer: { S: '太宰治' } }
}

dynamodb-adminを表示すると、以下の画面のようにちゃんと項目が入っていることが確認できます。

参考

• DynamoDB ローカル (ダウンロード可能バージョン) のセットアップ
• dynamodb-admin - npm
• DynamoDB Client - AWS SDK for JavaScript v3