@cocreate/auroradb 1.0.0 → 1.1.0
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/CHANGELOG.md +7 -0
- package/README.md +139 -51
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
# [1.1.0](https://github.com/CoCreate-app/CoCreate-auroradb/compare/v1.0.0...v1.1.0) (2026-07-19)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* Update README.md to reflect CoCreate Aurora DB details and structure ([366d9f6](https://github.com/CoCreate-app/CoCreate-auroradb/commit/366d9f691c6bbf59b04dc817452a3d143723b402))
|
|
7
|
+
|
|
1
8
|
# 1.0.0 (2026-07-18)
|
|
2
9
|
|
|
3
10
|
|
package/README.md
CHANGED
|
@@ -1,88 +1,176 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Cocreate Aurora DB
|
|
2
2
|
|
|
3
|
-
A
|
|
3
|
+
A highly efficient, enterprise-grade Amazon Aurora DB cluster database CRUD wrapper and state-routing backend client for the collaborative CoCreate ecosystem. This wrapper maps Aurora's powerful relational database capabilities into CoCreate's unified JSON interface.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
## Documentation
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
For a complete guide and working integration examples, refer to the [CoCreate Aurora DB Documentation](https://cocreatejs.com/docs/amazon-auroradb).
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
---
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
## Table of Contents
|
|
12
|
+
* [The Power of the CoCreate Unified Ecosystem](#the-power-of-the-cocreate-unified-ecosystem)
|
|
13
|
+
* [Why Amazon Aurora?](#why-amazon-aurora)
|
|
14
|
+
* [Installation](#installation)
|
|
15
|
+
* [Unified JSON Payload Examples](#unified-json-payload-examples)
|
|
16
|
+
* [Announcements](#announcements)
|
|
17
|
+
* [Roadmap](#roadmap)
|
|
18
|
+
* [How to Contribute](#how-to-contribute)
|
|
19
|
+
* [About](#about)
|
|
14
20
|
|
|
15
|
-
|
|
21
|
+
---
|
|
16
22
|
|
|
17
|
-
|
|
18
|
-
<script src="https://cdn.cocreate.app/mongodb/latest/CoCreate-mongodb.min.js"></script>
|
|
19
|
-
```
|
|
23
|
+
## The Power of the CoCreate Unified Ecosystem
|
|
20
24
|
|
|
21
|
-
|
|
22
|
-
<script src="https://cdn.cocreate.app/mongodb/latest/CoCreate-mongodb.min.css"></script>
|
|
23
|
-
```
|
|
25
|
+
This is not just another database driver. By wrapping Amazon Aurora into the CoCreate state-routing pipeline, you unlock the full power of a multi-cloud, multi-model data orchestration mesh:
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
* **Unified JSON Interface (MongoDB-like Syntax):** You don't need to write raw SQL dialect queries or manage database-specific connection wrappers. CoCreate translates standard NoSQL JSON CRUD operations (such as `object.create` or `object.read`) transparently into optimized Aurora relational SQL under the hood.
|
|
28
|
+
* **Parallel Multi-Database Writing:** Write to many target databases simultaneously with a single API call. You can stream transactional data to MongoDB (for instant operational state), vectorize it into Qdrant (for real-time semantic search), and store it in Amazon Aurora (for enterprise relational query processing) in perfect parallel harmony:
|
|
26
29
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
+
$$\text{Write Command} \xrightarrow{\text{Parallel Mesh}} \begin{cases} \text{MongoDB} & \text{(ACID Transaction Store)} \\ \text{Qdrant} & \text{(Semantic Vector Search)} \\ \text{Amazon Aurora} & \text{(Relational Cluster Engine)} \end{cases}$$
|
|
31
|
+
|
|
32
|
+
* **Dynamic State-Routing:** Isolate multi-tenant environments effortlessly. The routing mesh automatically injects tenant metadata and organization boundaries, ensuring isolated transactional processing within your shared Aurora infrastructure.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Why Amazon Aurora?
|
|
37
|
+
|
|
38
|
+
Amazon Aurora is a fully managed relational database engine that combines the speed and availability of high-end commercial databases with the simplicity and cost-effectiveness of open-source databases. It is up to five times faster than standard MySQL databases and three times faster than standard PostgreSQL databases.
|
|
30
39
|
|
|
31
|
-
|
|
40
|
+
By routing critical business logic, high-throughput transactions, and complex relational entities straight to Aurora via this wrapper, you leverage its distributed, fault-tolerant, and self-healing storage system while maintaining a zero-friction JSON pipeline.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Installation
|
|
45
|
+
|
|
46
|
+
### NPM Installation
|
|
47
|
+
```bash
|
|
48
|
+
npm i @cocreate/auroradb
|
|
32
49
|
|
|
33
|
-
```shell
|
|
34
|
-
$ yarn install @cocreate/mongodb
|
|
35
50
|
```
|
|
36
51
|
|
|
37
|
-
|
|
52
|
+
### Yarn Installation
|
|
38
53
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
- [Roadmap](#roadmap)
|
|
42
|
-
- [How to Contribute](#how-to-contribute)
|
|
43
|
-
- [About](#about)
|
|
44
|
-
- [License](#license)
|
|
54
|
+
```bash
|
|
55
|
+
yarn add @cocreate/auroradb
|
|
45
56
|
|
|
46
|
-
|
|
57
|
+
```
|
|
47
58
|
|
|
48
|
-
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Unified JSON Payload Examples
|
|
62
|
+
|
|
63
|
+
Here are the complete, real-world JSON objects representing raw payloads routed through the CoCreate system to Amazon Aurora.
|
|
64
|
+
|
|
65
|
+
### 1. Writing a Full Transaction Object (`object.create`)
|
|
66
|
+
|
|
67
|
+
When this operational payload is sent, CoCreate registers it, processes the nested JSON fields, and automatically routes it as structured relational records in Aurora.
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"method": "object.create",
|
|
72
|
+
"storage": ["auroradb", "mongodb", "qdrant"], // Array of storages to store in parallel!
|
|
73
|
+
"database": "sales_analytics",
|
|
74
|
+
"array": "order_events",
|
|
75
|
+
"object": {
|
|
76
|
+
"_id": "order_77c8f2a9_3b01",
|
|
77
|
+
"customer": {
|
|
78
|
+
"id": "cust_88301",
|
|
79
|
+
"email": "customer@example.com",
|
|
80
|
+
"region": "North America",
|
|
81
|
+
"acquisition_channel": "Google Search"
|
|
82
|
+
},
|
|
83
|
+
"transaction": {
|
|
84
|
+
"payment_method": "Credit Card",
|
|
85
|
+
"currency": "USD",
|
|
86
|
+
"subtotal": 249.99,
|
|
87
|
+
"discount": 15.00,
|
|
88
|
+
"tax": 18.80,
|
|
89
|
+
"total": 253.79
|
|
90
|
+
},
|
|
91
|
+
"items": [
|
|
92
|
+
{
|
|
93
|
+
"product_id": "prod_head_009",
|
|
94
|
+
"name": "Wireless Noise-Cancelling Headphones",
|
|
95
|
+
"category": "Electronics",
|
|
96
|
+
"quantity": 1,
|
|
97
|
+
"unit_price": 199.99
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
"product_id": "prod_stand_012",
|
|
101
|
+
"name": "Aluminum Headphone Stand",
|
|
102
|
+
"category": "Accessories",
|
|
103
|
+
"quantity": 2,
|
|
104
|
+
"unit_price": 25.00
|
|
105
|
+
}
|
|
106
|
+
],
|
|
107
|
+
"shipping": {
|
|
108
|
+
"carrier": "FedEx",
|
|
109
|
+
"service": "2-Day Air",
|
|
110
|
+
"estimated_delivery": "2026-07-20T12:00:00.000Z"
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
"organization_id": "org_enterprise_99x",
|
|
114
|
+
"user_id": "usr_sales_runner_402",
|
|
115
|
+
"timeStamp": "2026-07-18T18:40:43.000Z"
|
|
116
|
+
}
|
|
49
117
|
|
|
50
|
-
|
|
118
|
+
```
|
|
51
119
|
|
|
52
|
-
|
|
120
|
+
### 2. Reading and Filtering Warehoused Data (`object.read`)
|
|
121
|
+
|
|
122
|
+
Querying Aurora uses the exact same MongoDB-style filter syntax. The query below retrieves high-value orders handled by a specific shipping carrier, sorting them by total sale volume.
|
|
123
|
+
|
|
124
|
+
```json
|
|
125
|
+
{
|
|
126
|
+
"method": "object.read",
|
|
127
|
+
"storage": "auroradb",
|
|
128
|
+
"database": "sales_analytics",
|
|
129
|
+
"array": "order_events",
|
|
130
|
+
"$filter": {
|
|
131
|
+
"query": {
|
|
132
|
+
"transaction.total": { "$gte": 100.00 },
|
|
133
|
+
"shipping.carrier": "FedEx"
|
|
134
|
+
},
|
|
135
|
+
"sort": [
|
|
136
|
+
{ "key": "transaction.total", "direction": "desc" }
|
|
137
|
+
],
|
|
138
|
+
"limit": 50,
|
|
139
|
+
"index": 0
|
|
140
|
+
},
|
|
141
|
+
"organization_id": "org_enterprise_99x"
|
|
142
|
+
}
|
|
53
143
|
|
|
54
|
-
|
|
144
|
+
```
|
|
55
145
|
|
|
56
|
-
|
|
146
|
+
---
|
|
57
147
|
|
|
58
|
-
|
|
148
|
+
## Announcements
|
|
59
149
|
|
|
60
|
-
|
|
150
|
+
All updates to this library are documented in our `CHANGELOG` and releases. You may also subscribe to email for releases and breaking changes.
|
|
61
151
|
|
|
62
|
-
|
|
152
|
+
---
|
|
63
153
|
|
|
64
|
-
|
|
154
|
+
## Roadmap
|
|
65
155
|
|
|
66
|
-
|
|
156
|
+
If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.
|
|
67
157
|
|
|
68
|
-
|
|
158
|
+
---
|
|
69
159
|
|
|
70
|
-
|
|
160
|
+
## How to Contribute
|
|
71
161
|
|
|
72
|
-
We encourage contribution to our libraries (you might even score some nifty swag), please see our
|
|
162
|
+
We encourage contribution to our libraries (you might even score some nifty swag), please see our `CONTRIBUTING` guide for details.
|
|
73
163
|
|
|
74
|
-
We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create
|
|
164
|
+
We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or merely upvote or comment on existing issues or pull requests.
|
|
75
165
|
|
|
76
166
|
We appreciate your continued support, thank you!
|
|
77
167
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
# License
|
|
168
|
+
---
|
|
81
169
|
|
|
82
|
-
|
|
170
|
+
## About
|
|
83
171
|
|
|
84
|
-
-
|
|
172
|
+
`CoCreate-auroradb` is guided and supported by the **CoCreate Developer Experience Team**.
|
|
85
173
|
|
|
86
|
-
|
|
174
|
+
> Please Email the Developer Experience Team here in case of any queries.
|
|
87
175
|
|
|
88
|
-
|
|
176
|
+
`CoCreate-auroradb` is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
|
package/package.json
CHANGED