modli/dynamodb

Modli - DynamoDB适配器镜像

镜像概述

此镜像为Modli框架的DynamoDB适配器实例，用于与AWS DynamoDB数据源集成，提供便捷的数据库操作接口，支持表管理、数据增删改查等功能，适用于基于Modli开发的应用。

核心功能

• 表管理：创建表（从模型自动创建或自定义参数）、删除表、列出所有表
• 数据操作：插入、读取（单条/批量/分页）、更新、部分更新、删除数据
• 高级查询：全表扫描（带过滤条件）、按索引查询、分页查询
• 扩展能力：支持自定义方法扩展适配器功能

使用场景

• 基于Modli框架开发需要与DynamoDB交互的应用
• 快速搭建DynamoDB本地测试环境（结合Docker使用）
• 实现DynamoDB数据的CRUD操作及复杂查询

配置说明

安装依赖

bash
npm install modli-dynamodb --save

配置适配器与模型

javascript
import { model, adapter, use } from 'modli';
import dynamodb from 'modli-dynamodb';

// 配置AWS DynamoDB连接信息
const dynamoConfig = {
  region: 'us-east-1', // AWS区域
  endpoint: 'http://localhost:8000', // 可选：本地DynamoDB端点
  accessKeyId: process.env.AWS_ACCESS_KEY_ID || '123456789',
  secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY || '123456789'
};

// 添加模型（含表结构定义）
model.add({
  name: 'roles',
  version: 1,
  autoCreate: true, // 是否自动创建表
  indexes: [
    { keytype: 'hash', value: 'id', type: 'N' }, // 哈希键
    { keytype: 'secondary', value: 'login', type: 'S', projectionType: 'INCLUDE', nonKeyAttributes: ['age'] } // 二级索引
  ],
  schema: {
    id: { type: 'string' },
    name: { type: 'string' },
    age: { type: 'number' }
  }
});

// 添加适配器
adapter.add({
  name: 'dynamoAdapter',
  source: dynamodb,
  config: dynamoConfig
});

// 使用适配器与模型
const testDynamo = use('roles', 'dynamoAdapter');

常用方法示例

列出所有表

javascript
testDynamo.list().then(result => console.log(result)).catch(err => console.error(err));

创建数据

javascript
testDynamo.create({ id: '1', name: 'Admin', age: 30 }).then(res => console.log(res)).catch(err => console.error(err));

读取数据

javascript
testDynamo.read({ id: '1' }).then(res => console.log(res)).catch(err => console.error(err));

更新数据

javascript
testDynamo.update({ id: '1' }, { name: 'Super Admin' }).then(res => console.log(res)).catch(err => console.error(err));

删除数据

javascript
testDynamo.delete({ id: '1' }).then(res => console.log(res)).catch(err => console.error(err));

本地测试

需安装Docker和DevLab工具，执行以下命令运行测试：

bash
lab mocha

许可证

此镜像基于MIT许可证，详情见LICENSE.txt。