@afora/dynamodb 0.0.11 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +3 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,7 @@ A repository provider for [`@afora/core`](../../README.md) on one [DynamoDB](htt
4
4
 
5
5
  ```bash
6
6
  bun add @afora/core typebox @afora/dynamodb @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb
7
+ # or: npm install @afora/core typebox @afora/dynamodb @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb
7
8
  ```
8
9
 
9
10
  `@afora/core` (with the query helpers of `@afora/core/experimental`), `@aws-sdk/client-dynamodb` and `@aws-sdk/lib-dynamodb` (`^3.1164.0`) are peer dependencies.
@@ -81,6 +82,7 @@ This suits repositories of thousands of items, not millions: every other read wi
81
82
  - `atomic`: `increment` is one `UpdateItem` (`SET data.views = if_not_exists(data.views, 0) + :d`), conditioned on the item existing, not soft-deleted and not expired. With `create`, a missing id is inserted (a concurrent insert of the same id gets the deltas added instead), an expired item is replaced, and a soft-deleted one is `RepositoryUniqueViolation` on `id`. An increment cannot change a unique key (`InvalidRepositoryQuery`).
82
83
  - `expiry`: reads leave out records whose date is at or before `query.now`, unless `withExpired`. Expired items stay in the table and keep their unique values; the `UpdateItem` of `increment` compares the dates as strings, so keep them in UTC ISO 8601 (`toISOString()`, as the entity writes them).
83
84
  - `transactions` is **not** a capability: DynamoDB writes up to 100 items at once, without reads in between, so `commandOf({ transaction: true })` cannot run on it.
85
+ - `generatedIds` is **not** a capability: DynamoDB has no auto-increment, so an entity declared with `Serial` ids cannot be created through it (`repositoryOf` with `create` throws `UnsupportedIdentity`). Use UUIDs (the default), `Uuid` or a natural `Key`.
84
86
 
85
87
  ## Limits
86
88
 
@@ -99,7 +101,7 @@ DynamoDB has no schema to change, so `migrate` is a no-op, and a change of an en
99
101
 
100
102
  `PAY_PER_REQUEST`, string `pk` and `sk`, nothing else. With the AWS CDK:
101
103
 
102
- <!-- docs:code skip: the AWS CDK is not a dependency of this repo; this is the body of a Stack constructor, and handler is your function -->
104
+ <!-- docs:code skip: needs aws-cdk-lib (about 150 MB) for this one block; the CloudFormation below declares the same table -->
103
105
  ```ts
104
106
  import { RemovalPolicy } from "aws-cdk-lib";
105
107
  import { AttributeType, Billing, TableV2 } from "aws-cdk-lib/aws-dynamodb";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@afora/dynamodb",
3
- "version": "0.0.11",
3
+ "version": "0.0.13",
4
4
  "description": "A repository provider for @afora/core on one DynamoDB table.",
5
5
  "keywords": [
6
6
  "afora",