dyna-record 0.0.16 → 0.0.18
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.
- package/README.md +3 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[API Documentation](https://dyna-record.com/)
|
|
4
4
|
|
|
5
|
-
Dyna-Record is a strongly typed ORM (Object-Relational Mapping) tool designed for modeling and interacting with data stored in DynamoDB in a structured and type-safe manner. It simplifies the process of defining data models (entities), performing CRUD operations, and handling complex queries. To support relational data, dyna-record implements a flavor of [single-table design
|
|
5
|
+
Dyna-Record is a strongly typed ORM (Object-Relational Mapping) tool designed for modeling and interacting with data stored in DynamoDB in a structured and type-safe manner. It simplifies the process of defining data models (entities), performing CRUD operations, and handling complex queries. To support relational data, dyna-record implements a flavor of the [single-table design pattern](https://aws.amazon.com/blogs/compute/creating-a-single-table-design-with-amazon-dynamodb/) and the [adjacency list design pattern](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-adjacency-graphs.html). All operations are [ACID compliant transactions\*](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html)\.
|
|
6
6
|
|
|
7
7
|
Note: ACID compliant according to DynamoDB [limitations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html)
|
|
8
8
|
|
|
@@ -42,7 +42,7 @@ yarn add dyna-record
|
|
|
42
42
|
|
|
43
43
|
## Defining Entities
|
|
44
44
|
|
|
45
|
-
Entities in Dyna-Record represent your DynamoDB table
|
|
45
|
+
Entities in Dyna-Record represent your DynamoDB table structure and relationships. Think of each entity as a table in a relational database, even though they will be represented on a single table.
|
|
46
46
|
|
|
47
47
|
### Table
|
|
48
48
|
|
|
@@ -128,9 +128,8 @@ class Student extends MyTable {
|
|
|
128
128
|
|
|
129
129
|
@Entity
|
|
130
130
|
class Course extends MyTable {
|
|
131
|
-
...
|
|
131
|
+
/// ...
|
|
132
132
|
}
|
|
133
|
-
|
|
134
133
|
```
|
|
135
134
|
|
|
136
135
|
### Attributes
|