You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,13 @@ NodeJS SDK for interacting with [Cyclic.sh](https://cyclic.sh) app AWS DynamoDB
8
8
9
9
10
10
11
-
Together with the Cyclic.sh DynamoDB indexing strategy and data model, the sdk simplifies the DynamoDB interface and enables collection organization of records, queries and data scheme discovery among other features.
11
+
Together with the Cyclic.sh DynamoDB indexing strategy and data model, the SDK simplifies the DynamoDB interface and enables collection organization of records, queries, and data scheme discovery, among other features.
12
12
13
-
> The sdk and database feature are in preview - use it with the assumption that the interface and data structures will change. We use semantic release for versioning so take note of version numbers.
13
+
> We use semantic release for versioning so take note of version numbers.
14
14
15
15
## Prerequisites
16
16
17
-
- A cyclic app with database enabled
18
-
- Databases are in preview - request access on Discord >> https://discord.gg/huhcqxXCbE
17
+
- A Cyclic.sh app with database enabled
19
18
- For use on local:
20
19
- AWS credentials set in environment (available on an app's database tab)
21
20
@@ -25,14 +24,14 @@ Together with the Cyclic.sh DynamoDB indexing strategy and data model, the sdk s
25
24
```
26
25
npm install @cyclic.sh/dynamodb
27
26
```
28
-
2. Copy the temporary credentials from the cyclic console and set them in the shell environment where your code will be running.
27
+
2. Copy the temporary credentials from the Cyclic.sh console and set them in the shell environment where your code is running.
With the cyclic.sh data model, items can have `fragments`. These can be thought of as **children or attachments** to items.
82
+
With the Cyclic.sh data model, items can have `fragments`. These can be thought of as **children or attachments** to items.
84
83
85
84
Another way to think of fragments is by thinking of an item itself as its own collection of other items that are stored closely together.
86
85
@@ -105,11 +104,11 @@ let mikes_work = await users.item('mike').fragment('work').get()
105
104
106
105
```
107
106
108
-
# TTL - time to live
107
+
# TTL - Time To Live
109
108
110
-
You optionally may set a TTL for any item. The `ttl` is the UNIX seconds timestamp when the item should expire.
109
+
You optionally may set a TTL for any item. The `TTL` is the UNIX seconds timestamp when the item should expire.
111
110
112
-
The ttl setting passes through to the [DynamoDB ttl](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) setting. The expiration is only approximate within a few minutes.
111
+
The TTL setting passes through to the [DynamoDB TTL](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) setting. The expiration is only approximate within a few minutes.
0 commit comments