ddb-table

ddb-table

为DynamoDB文档提供查询和建模的TypeScript强类型库

DDB-Table是一个为DynamoDB文档处理而设计的TypeScript强类型库。它提供端到端的类型验证,简化查询表达式,实现智能投影,并支持全局和本地索引。通过集成AWS DocumentClient,开发者可以方便地操作JSON文档,同时确保静态和运行时的结构验证。该库还支持复杂的更新操作和二级索引查询,增强了开发过程中的类型安全性。

DDB-TableTypeScriptDynamoDB数据查询类型验证Github开源项目
<h1 align="center" style="text-align:center">🔒 DDB-Table</h1> <h4 align="center">用于在TypeScript中查询和建模DynamoDB文档的强类型库。</h4> <p align="center"> <a href="https://www.npmjs.org/package/ddb-table"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/5641ea1d-b2a7-49f8-a9c1-75910074db83.svg" alt="在NPM上查看"> </a> <a href="https://github.com/neuledge/ddb-table/actions/workflows/build.yml"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/912237b7-2b62-4ef7-931d-aacf5040fa62.svg" alt="构建状态"> </a> <a href="https://depfu.com/github/neuledge/ddb-table?project_id=13055"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/610e6ee7-bfb9-42b9-ac52-9eb8bf32cb9f.svg" alt="依赖状态"> </a> <a href="https://codecov.io/gh/neuledge/ddb-table"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/27f154f1-6e1b-46da-8ad9-0b2b3d307301.svg?token=JQG7E9QJ3B" alt="覆盖率状态" /> </a> <a href="LICENSE"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/02a2f652-be9f-488a-be90-f3809a803517.svg" alt="许可证"> </a> </p> <br>

DDB-Table旨在为DynamoDB表提供强类型的数据结构。使用AWS DocumentClientTypeScript,您可以轻松获取和存储任何JSON文档,并静态验证其结构。查询二级索引并运行复杂的更新表达式,无需在运行时出现任何错误。

await table .update('demo@example.com') .set('FullName', 'John Doe') // 🚨 TypeScript错误:'fullName'不能赋值给'Email' | 'FullName' .condition((cond) => cond.eq('fullName', 'Johnny Doe')) .exec();

主要特性

  • 强类型 - 为您的数据提供端到端的TypeScript验证。
  • 简易查询表达式 - 自动转义名称属性和值。
  • 智能投影 - 确保您只访问您投影的字段。
  • 查询和扫描索引 - 完全支持全局或本地索引。
  • 纯JavaScript - 也可以在不使用TypeScript的情况下工作。

由❤️赞助

如果您喜欢这个项目,请考虑赞助我们,以帮助我们继续维护和改进这个项目。

<br>

安装

npm i ddb-table
<br>

使用方法

import Table from 'ddb-table'; import { DynamoDBClient } from '@aws-sdk/client-dynamodb'; import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb'; interface MessageSchema { threadId: string; timestamp: number; senderId: string; message: string; status: 'sent' | 'received'; tags?: Set<string>; attachments: { name: string; URL: string; }[]; } const client = new DynamoDBClient({ // 设置... }); // 创建基本表定义 const messages = new Table<MessageSchema, 'threadId', 'timestamp'>({ tableName: 'Messages', primaryKey: 'threadId', sortKey: 'timestamp', documentClient: DynamoDBDocument.from(client); }); const updateRes = await messages .update('john@gmail.com', 1588191225322) .set('message', 'Hello World!') .add('tags', new Set(['unread', 'important'])) .set('attachments', (exp) => exp.listAppend([{ name: 'Test', URL: 'demo.com' }]), ) .return('ALL_NEW') .exec(); console.log(updateRes.Attributes);

同时使用索引:

// 创建二级索引定义 type SenderTimestampIndex = Pick< MessageSchema, 'threadId' | 'timestamp' | 'senderId' >; const outboxIndex = messages.index< SenderTimestampIndex, 'senderId', 'timestamp' >('senderId-timestamp-index', 'senderId', 'timestamp'); const it = outboxIndex .query() .keyCondition((cond) => cond.eq('senderId', 'john@gmail.com')) .keyCondition((cond) => cond.between('timestamp', Date.now() - 3600e3, Date.now()), ) .project({ threadId: 1, message: 1 }) .reverseIndex() .entries(); for await (const item of it) { console.log(item); }

错误处理

import { DynamoDBExceptionName } from 'ddb-table'; try { await table.put(...).exec(); } catch (err) { if ((err as DynamoDBServiceException)?.name === DynamoDBExceptionName.ConditionalCheckFailedException) { // 处理异常 } }
<br>

许可证

MIT许可证 © 2022 Neuledge

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞��绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多