Dynamodb Provider

Appearance

Schema System ​

The schema system provides entity definitions, partition management, and collection joins for single-table designs.

Overview ​

Access the schema system via table.schema:

typescript
const table = new SingleTable({
  dynamodbProvider: provider,
  table: 'AppData',
  partitionKey: 'pk',
  rangeKey: 'sk'
});

// Access schema system
const User = table.schema.createEntity<UserType>().as({
  type: 'USER',
  getPartitionKey: ({ id }) => ['USER', id],
  getRangeKey: () => '#DATA'
});

What It Provides ​

1. Entities ​

Define data types with automatic key generation:

typescript
const User = table.schema.createEntity<UserType>().as({
  type: 'USER',
  getPartitionKey: ({ id }) => ['USER', id],
  getRangeKey: () => '#DATA',
  autoGen: {
    onCreate: {
      id: 'UUID',
      createdAt: 'timestamp'
    }
  }
});

// Type-safe operations
await table.schema.from(User).create({
  name: 'John Doe',
  email: 'john@example.com'
  // id and createdAt auto-generated
});

Learn more about Entities →

2. Partitions ​

Group related entities sharing the same partition key:

typescript
const userPartition = table.schema.createPartition({
  name: 'USER_PARTITION',
  getPartitionKey: ({ userId }) => ['USER', userId],
  entries: {
    mainData: () => '#DATA',
    orders: ({ orderId }) => ['ORDER', orderId],
    settings: () => 'SETTINGS'
  }
});

const User = userPartition.use('mainData').create<User>().entity({
  type: 'USER',
  paramMatch: { userId: 'id' }
});

Learn more about Partitions →

3. Collections ​

Define joined entity structures for complex queries:

typescript
const userWithOrders = userPartition.collection({
  ref: User,
  type: 'SINGLE',
  join: {
    orders: {
      entity: Order,
      type: 'MULTIPLE',
      joinBy: 'TYPE'
    }
  }
});

const result = await table.schema.from(userWithOrders).get({
  userId: '123'
});
// Returns: { id: '123', name: 'John', orders: [...] }

Learn more about Collections →

Quick Example ​

typescript
// Define entity
const User = table.schema.createEntity<User>().as({
  type: 'USER',
  getPartitionKey: ({ id }) => ['USER', id],
  getRangeKey: () => '#DATA',
  autoGen: {
    onCreate: {
      id: 'UUID',
      createdAt: 'timestamp'
    }
  }
});

// Create user
const user = await table.schema.from(User).create({
  name: 'John Doe',
  email: 'john@example.com'
});

// Get user
const retrieved = await table.schema.from(User).get({
  id: user.id
});

// Update user
await table.schema.from(User).update({
  id: user.id,
  values: { email: 'newemail@example.com' }
});

// Query all users
const users = await table.schema.from(User).listAll();

Components ​

  1. Entities - Define entity types with key generators and auto-generation
  2. Partitions - Group entities by shared partition keys
  3. Collections - Model entity relationships and joins

Next Steps ​