Type alias Table

Type declaration

• batch: {
      read(keys: {
          partition: string;
          sort?: string;
      }[]): Promise<undefined | Item[]>;
      write(operations: BatchWriteOperation[]): Promise<void>;
  }

  • read:function

    • read(keys: {
          partition: string;
          sort?: string;
      }[]): Promise<undefined | Item[]>

    • Parameters

      • keys: {
            partition: string;
            sort?: string;
        }[]

      Returns Promise<undefined | Item[]>

  • write:function

    • write(operations: BatchWriteOperation[]): Promise<void>

    • Parameters

      • operations: BatchWriteOperation[]

      Returns Promise<void>

• delete:function

  • delete(partition: string, sort?: string): Promise<void>

  • Parameters

    • partition: string

    • Optional sort: string

    Returns Promise<void>

• get:function

  • get(partition: string, sort?: string): Promise<undefined | Item>

  • Parameters

    • partition: string

    • Optional sort: string

    Returns Promise<undefined | Item>

• getByPrefix:function

  • getByPrefix(partition: string, sort: string): Promise<undefined | Item[]>

  • Parameters

    • partition: string

    • sort: string

    Returns Promise<undefined | Item[]>

• getPartitionPage:function

  • getPartitionPage(partition: string, limit: number, cursor?: string, sort?: SortOrder, filterKey?: string, filterValue?: string, filterExclude?: boolean): Promise<PagedQueryResult>

  • Parameters

    • partition: string

    • limit: number

    • Optional cursor: string

    • Optional sort: SortOrder

    • Optional filterKey: string

    • Optional filterValue: string

    • Optional filterExclude: boolean

    Returns Promise<PagedQueryResult>

• getPartitions:function

  • getPartitions(partition: string): Promise<Item>

  • Parameters

    • partition: string

    Returns Promise<Item>

• index:function

  • index(name: string, partitionKey: string, sortKey?: string): Index

  • Parameters

    • name: string

    • partitionKey: string

    • Optional sortKey: string

    Returns Index

• put:function

  • put(item: Item): Promise<void>

  • Parameters

    • item: Item

    Returns Promise<void>

• queryByExpression:function

  • queryByExpression(keyCondition: string, ExpressionAttributeValues: Record<string, unknown>, ExpressionAttributeNames: Record<string, string>): Promise<Item[]>

  • Parameters

    • keyCondition: string

    • ExpressionAttributeValues: Record<string, unknown>

    • ExpressionAttributeNames: Record<string, string>

    Returns Promise<Item[]>