aaronshaf/dynamodb-admin

dynamodb-admin

概述

dynamodb-admin 是一个图形用户界面（GUI）工具，用于管理本地 DynamoDB 实例，支持 DynamoDB Local、dynalite、localstack 等本地 DynamoDB 服务。它提供直观的可视化界面，简化表管理、数据操作等开发测试过程。

核心功能

• 可视化管理 DynamoDB 表，支持查看、创建、删除表结构
• 提供数据操作界面，可对表中数据进行增删改查
• 支持连接多种本地 DynamoDB 服务（DynamoDB Local、dynalite、localstack 等）
• 灵活的连接配置，支持通过命令行参数或环境变量设置连接端点
• 可配置 AWS 凭证和区域，适配需要凭证验证的本地 DynamoDB 实例

使用场景

适用于开发和测试环境，主要场景包括：

• 开发人员在本地使用 DynamoDB 进行应用开发时，通过图形界面直观管理表和数据
• 测试过程中快速验证数据写入、查询结果
• 配合 DynamoDB Local、dynalite、localstack 等工具构建本地开发环境，简化 DynamoDB 实例管理

使用方法

全局安装使用

通过 npm 全局安装 dynamodb-admin：

bash
npm install -g dynamodb-admin

启动命令格式：

bash
dynamodb-admin [选项]

命令行选项

环境变量配置

以下环境变量可用于设置对应选项：

• HOST: 对应 --host 选项
• PORT: 对应 --port 选项
• DYNAMO_ENDPOINT: 对应 --dynamo-endpoint 选项
• AWS_REGION: AWS 区域
• AWS_ACCESS_KEY_ID: AWS 访问密钥 ID
• AWS_SECRET_ACCESS_KEY: AWS 密钥

使用示例

连接默认 DynamoDB Local 实例：

bash
dynamodb-admin --dynamo-endpoint=http://localhost:8000

连接需要凭证的本地 DynamoDB（如 amazon/dynamodb-local 镜像）：

bash
AWS_REGION=eu-west-1 AWS_ACCESS_KEY_ID=local AWS_SECRET_ACCESS_KEY=local dynamodb-admin

注意：若其他应用需要访问同一 DynamoDB 实例，其使用的 AWS_ACCESS_KEY_ID 需与 dynamodb-admin 一致，以确保数据可见性。

作为项目库使用

在项目中作为依赖引入，需配合 AWS SDK v3（v4 版本支持 AWS SDK v2）。

安装依赖

bash
npm install dynamodb-admin @aws-sdk/client-dynamodb

代码示例

js
import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { createServer } from 'dynamodb-admin';

// 创建 DynamoDB 客户端实例
const dynamoDbClient = new DynamoDBClient({
  endpoint: 'http://localhost:8000', // DynamoDB 端点
  region: 'us-east-1', // 区域
  credentials: {
    accessKeyId: 'key', // 访问密钥 ID
    secretAccessKey: 'secret' // 密钥
  }
});

// 创建 dynamodb-admin 服务
const app = createServer({ dynamoDbClient });

// 启动服务
const host = 'localhost';
const port = 8001;
const server = app.listen(port, host);
server.on('listening', () => {
  const address = server.address();
  console.log(`服务运行于 http://${address.address}:${address.port}`);
});

Docker 部署

直接运行 Docker 镜像

使用 https://hub.docker.com/r/aaronshaf/dynamodb-admin/ 镜像：

bash
docker run -d \
  -p 8001:8001 \
  --name dynamodb-admin \
  -e DYNAMO_ENDPOINT=http://localhost:8000 \
  -e AWS_REGION=us-east-1 \
  -e AWS_ACCESS_KEY_ID=local \
  -e AWS_SECRET_ACCESS_KEY=local \
  aaronshaf/dynamodb-admin

Docker Compose 配置

配合 amazon/dynamodb-local 构建完整环境：

yaml
version: '3'
services:
  dynamodb:
    image: amazon/dynamodb-local
    ports:
      - "8000:8000"
    command: "-jar DynamoDBLocal.jar -inMemory -sharedDb"

  dynamodb-admin:
    image: aaronshaf/dynamodb-admin
    ports:
      - "8001:8001"
    environment:
      - DYNAMO_ENDPOINT=http://dynamodb:8000
      - AWS_REGION=us-east-1
      - AWS_ACCESS_KEY_ID=local
      - AWS_SECRET_ACCESS_KEY=local
    depends_on:
      - dynamodb

启动服务：

bash
docker-compose up -d

访问 http://localhost:8001 即可打开管理界面。

配置参数详解

命令行参数

环境变量

开发指南

构建与启动

1. 克隆代码并安装依赖：

bash
git clone https://github.com/aaronshaf/dynamodb-admin.git
cd dynamodb-admin
npm install

2. 构建代码：

bash
npm run build

3. 启动服务：

bash
DYNAMO_ENDPOINT=http://localhost:8000 npm run start

4. 开发模式（代码变更自动重启）：

bash
npm run build:watch  # 监控代码变更
# 新终端执行
DYNAMO_ENDPOINT=http://localhost:8000 npm run start

相关资源

• https://hub.docker.com/r/aaronshaf/dynamodb-admin/%EF%BC%9A%E4%BB%85%E5%8C%85%E5%90%AB dynamodb-admin 的独立镜像
• https://github.com/instructure/dynamo-local-admin-docker%EF%BC%9A%E5%8C%85%E5%90%AB dynamodb-admin 和 DynamoDB Local 的集成方案
• 快速入门指南：Camin McCluskey 编写的使用教程

功能演示

!功能演示