@the-neon/dynamodb
v0.0.8
Published
DynamoDB client for Neon using AWS SDK v3
Downloads
300
Readme
@the-neon/dynamodb
DynamoDB client for Neon using AWS SDK v3.
Install
npm install @the-neon/dynamodbRequires @the-neon/core as a peer dependency.
Usage
import DynamoDb from "@the-neon/dynamodb";
const db = new DynamoDb();
// CRUD
await db.insert("users", { id: "1", name: "Alice", email: "[email protected]" });
await db.update("users", { id: "1", name: "Alice Updated" });
await db.delete("users", "1");
// Fetch
await db.getById("users", "1");
await db.query("users", { tenantId: "abc" }, "tenant-index");
await db.scan("users", { status: "active" });API
Fetch
getById(table, id)— Get item by primary keyquery(table, attrs, index?)— Query with attribute filters on an indexscan(table, attrs?, filterExpression?, expressionAttributeNames?, expressionAttributeValues?)— Scan table
CRUD
insert(table, input)— Put new item (generates UUID if id not provided)update(table, data)— Update item by iddelete(table, id)— Delete item by id
Utilities
mapAttrToParams(attrs)— Map attributes to DynamoDB expression params for scan filtering
