dynamodb-single-table-design
Advanced Amazon DynamoDB Single-Table Design patterns, access pattern modeling, Partition Key (PK) and Sort Key (SK) strategies, Global Secondary Indexes (GSIs), sparse indexes, and transactions. Use when designing high-scale DynamoDB data layers.
- License 许可
- MIT
- 最近更新
- 2026-10-17
- Stars
- ★ 8
- Forks
- 1
01 前言 Front Matter
- name
- dynamodb-single-table-design
- description
- Advanced Amazon DynamoDB Single-Table Design patterns, access pattern modeling, Partition Key (PK) and Sort Key (SK) strategies, Global Secondary Indexes (GSIs), sparse indexes, and transactions. Use when designing high-scale DynamoDB data layers.
03 SKILL.md 正文
DynamoDB Single-Table Design Architecture Guide
Comprehensive reference for mastering Amazon DynamoDB Single-Table Design, access pattern modeling, secondary index overloading, sparse indexes, and high-concurrency transactional operations.
1. Principles of Single-Table Design
Why Single-Table Design?
In DynamoDB, microsecond-latency scale is achieved by avoiding runtime joins. Instead of creating separate tables for each entity type, a Single-Table Design pre-joins heterogenous entities into a single physical table using generic Partition Keys (PK) and Sort Keys (SK).
+-------------------+--------------------+------------------------+------------------+
| PK | SK | Type | Data Payload |
+-------------------+--------------------+------------------------+------------------+
| USER#usr_1001 | METADATA | UserProfile | { name, email } |
| USER#usr_1001 | ORDER#2026-07-01 | Order | { total: 49.99 } |
| USER#usr_1001 | ORDER#2026-07-18 | Order | { total: 89.00 } |
| ORDER#ord_9901 | METADATA | Order | { status: SHIPPED|
+-------------------+--------------------+------------------------+------------------+
Access Pattern Driven Design Workflow
- List all access patterns (Reads, Writes, Aggregations) before defining keys.
- Design Primary Partition Keys (
PK) to group related items into logical item collections. - Design Primary Sort Keys (
SK) to enable range filtering (begins_with,BETWEEN). - Add Global Secondary Indexes (GSIs) for alternate access vectors.
2. Primary Key & Composite Sort Key Conventions
Common Key Formatting Conventions
- User Entity:
PK: USER#<userId>,SK: METADATA - User Orders:
PK: USER#<userId>,SK: ORDER#<timestamp>#<orderId> - Order Details:
PK: ORDER#<orderId>,SK: METADATA - Order Line Items:
PK: ORDER#<orderId>,SK: ITEM#<lineItemId>
Hierarchical Querying via Composite Keys
Sort keys can store hierarchical values separated by delimiters (# or #STATUS#):
// Sort Key pattern: STATUS#<status>#DATE#<date>
// Example SK value: STATUS#PENDING#DATE#2026-07-18
// Access Pattern: Fetch all PENDING orders for a store created today
QueryInput = {
KeyConditionExpression: "PK = :pk AND begins_with(SK, :skPrefix)",
ExpressionAttributeValues: {
":pk": "STORE#store_880",
":skPrefix": "STATUS#PENDING#DATE#2026-07-18"
}
}
3. Modeling Relationships & Secondary Indexes
3.1 1:N Relationships (Item Collections)
Fetch both parent metadata and child items in a single $O(1)$ Query operation:
// Query PK = "USER#usr_1001" returns:
// 1. User Profile item (SK = "METADATA")
// 2. All user orders (SK starts with "ORDER#")
3.2 N:M Relationships (Adjacency List Pattern)
Model many-to-many associations (e.g., Users and Groups) using primary keys for forward lookup and an inverted GSI for reverse lookup.
| Index | PK | SK | Target Entity |
|---|---|---|---|
| Base Table | USER#usr_1 |
GROUP#grp_100 |
User Membership |
| GSI1 (Inverted) | GROUP#grp_100 |
USER#usr_1 |
Reverse Group Roster |
3.3 Sparse Indexes for State Filtering
GSIs only index items containing the index attributes. Omitting GSI key fields for items in non-target states creates a low-cost, ultra-efficient Sparse Index.
// Only items with GSI1PK set (e.g. orders requiring review) appear in GSI1
const orderNeedingReview = {
PK: "ORDER#ord_505",
SK: "METADATA",
GSI1PK: "ORDERS_PENDING_REVIEW",
GSI1SK: "2026-07-18T14:30:00Z",
status: "FLAGGED"
};
4. Concurrency Control, Transactions & TTL
Optimistic Locking via Condition Expressions
Prevent race conditions during concurrent write operations without table locking:
import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
import { DynamoDBDocumentClient, UpdateCommand } from '@aws-sdk/lib-dynamodb';
const ddocClient = DynamoDBDocumentClient.from(new DynamoDBClient({}));
async function updateAccountBalance(accountId: string, amount: number, currentVersion: number) {
const command = new UpdateCommand({
TableName: 'SingleTableApp',
Key: {
PK: `ACCOUNT#${accountId}`,
SK: 'METADATA'
},
UpdateExpression: 'SET balance = balance + :val, version = version + :inc',
ConditionExpression: 'version = :expectedVersion AND balance >= :minBalance',
ExpressionAttributeValues: {
':val': amount,
':inc': 1,
':expectedVersion': currentVersion,
':minBalance': Math.abs(amount)
}
});
return await ddocClient.send(command);
}
5. Anti-Patterns & Common Pitfalls
- ❌ Relational Mindset (Multi-Table Sprawl): Creating a table for every entity type. Increases latency and operational overhead.
- ❌ Using
Scanin Production API Endpoints: Reads every partition sequentially. Causes extreme cost and request throttling. Always useQueryorGetItem. - ❌ Hot Partitions: Structuring
PKusing low-cardinality values (e.g.,PK: GENDER#MALE). Reaches partition IOPS limits ($1,000$ write units/sec or $3,000$ read units/sec per partition). - ❌ Unbounded Item Sizes: Storing growing arrays inside a single item until reaching the $400\text{ KB}$ DynamoDB item hard limit. Split array items across sort keys instead.
- ❌ Unnecessary
ProjectionExpression: ALLon GSIs: Duplicates all attribute data into secondary index storage, driving up AWS billable write units. UseKEYS_ONLYorINCLUDEwhere possible.
04 同仓库更多 Skills
security-audit
Comprehensive security guidance, source code audit, vulnerability assessment, and penetration test review for codebases, APIs, microservices, CLI tools, libraries, and LLM-backed applications. Triggers on requests to audit a codebase, conduct security reviews, find vulnerabilities or flaws, pen-test source code, or when the user asks in Arabic (فحص أمني، تدقيق الكود أمنياً، مراجعة الثغرات، فحص أمان المشروع). Supports Guidance mode (focused review) and Full Audit mode (deterministic 6-phase harness).
malware-analysis-reversing
Production malware analysis workflows, reverse engineering methodologies, isolated sandbox triage, static/dynamic binary analysis, memory forensics, and YARA detection rule authoring.
application-security-pentesting
Production Application Security (AppSec) standards, OWASP Top 10 vulnerability remediation, SAST/DAST pipeline integration, secure code review, threat modeling, and defensive security posture.
oauth2-oidc-security-flows
Implement enterprise OAuth 2.1 and OpenID Connect (OIDC) authorization code flow with Proof Key for Code Exchange (PKCE), state and nonce verification, refresh token rotation, token revocation, and centralized IdP federation (Keycloak, Auth0, Okta). Trigger when building secure authentication, single sign-on (SSO), or third-party delegated authorization.
jwt-session-management-hardening
Harden JWT-based authentication and session lifecycles using asymmetric signing (RS256/EdDSA), JWKS rotation, strict claims validation, Redis-backed sliding window sessions, revocation lists, and secure HttpOnly cookie storage. Trigger when implementing token validation, session revocation, or hardening API authentication.
soc2-compliance-automation
Best practices for implementing SOC 2 Type II compliance controls, continuous evidence collection, infrastructure policy-as-code, and automated security monitoring. Use when automating Trust Services Criteria (Security, Availability, Confidentiality, Processing Integrity, Privacy), audit logging, IAM least privilege, or CI/CD security gates.