@cocreate/dqlite 1.0.0 → 1.1.1
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/.github/workflows/automated.yml +1 -1
- package/CHANGELOG.md +15 -0
- package/README.md +139 -51
- package/package.json +4 -2
- package/release.config.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
## [1.1.1](https://github.com/CoCreate-app/CoCreate-dqlite/compare/v1.1.0...v1.1.1) (2026-07-19)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* set default branch to main ([581567f](https://github.com/CoCreate-app/CoCreate-dqlite/commit/581567fa7e2aca7a113d9dd3a28294fe8b4f032d))
|
|
7
|
+
|
|
8
|
+
# [1.1.0](https://github.com/CoCreate-app/CoCreate-dqlite/compare/v1.0.0...v1.1.0) (2026-07-19)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Features
|
|
12
|
+
|
|
13
|
+
* add additional keywords to package.json for improved discoverability ([409845f](https://github.com/CoCreate-app/CoCreate-dqlite/commit/409845fbd76bf67b91382d4e95a4663df24ce928))
|
|
14
|
+
* update README.md to reflect dqlite integration and enhance documentation ([285d59a](https://github.com/CoCreate-app/CoCreate-dqlite/commit/285d59a8acf6244d48f7d5e1abd3fc72a8420b99))
|
|
15
|
+
|
|
1
16
|
# 1.0.0 (2026-07-18)
|
|
2
17
|
|
|
3
18
|
|
package/README.md
CHANGED
|
@@ -1,88 +1,176 @@
|
|
|
1
|
-
#
|
|
1
|
+
# dqlite
|
|
2
2
|
|
|
3
|
-
A
|
|
3
|
+
A highly efficient, enterprise-grade dqlite (distributed SQLite) CRUD wrapper and state-routing backend client for the collaborative CoCreate ecosystem. This wrapper maps dqlite's fast, embedded, and replicated SQL 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 dqlite Documentation](https://cocreatejs.com/docs/dqlite).
|
|
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 dqlite?](#why-dqlite)
|
|
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 dqlite 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 manually coordinate custom multi-node consensus connections. CoCreate translates standard NoSQL JSON CRUD operations (such as `object.create` or `object.read`) transparently into optimized dqlite transactional 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 persist it in dqlite (for lightweight, highly available edge replication) 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{dqlite} & \text{(Distributed Edge Relational)} \end{cases}$$
|
|
31
|
+
|
|
32
|
+
* **Dynamic State-Routing:** Isolate multi-tenant environments effortlessly. The routing mesh automatically injects tenant metadata and organization boundaries, ensuring isolated database processing within your shared dqlite cluster infrastructure.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Why dqlite?
|
|
37
|
+
|
|
38
|
+
dqlite is a fast, embedded, and globally replicated SQL database engine written in C. It extends SQLite by integrating a customized Raft consensus implementation, offering transaction replication with low latency and high availability without sacrificing SQLite's footprint efficiency.
|
|
30
39
|
|
|
31
|
-
|
|
40
|
+
By routing real-time edge computing configurations, decentralized workflows, and fast local transactional states straight to dqlite via this wrapper, you unlock fault-tolerant relational storage directly inside minimal infrastructure footprints.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## Installation
|
|
45
|
+
|
|
46
|
+
### NPM Installation
|
|
47
|
+
```bash
|
|
48
|
+
npm i @cocreate/dqlite
|
|
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/dqlite
|
|
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. By declaring an array in the `storage` key, CoCreate fires the write operations to all specified backends simultaneously in parallel.
|
|
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 warehouses it across all listed parallel storage platforms.
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"method": "object.create",
|
|
72
|
+
"storage": ["dqlite", "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 targets a single database engine via a string filter syntax. The query below retrieves high-value orders handled by a specific shipping carrier from dqlite, sorting them by total sale volume.
|
|
123
|
+
|
|
124
|
+
```json
|
|
125
|
+
{
|
|
126
|
+
"method": "object.read",
|
|
127
|
+
"storage": "dqlite",
|
|
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-dqlite` 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-dqlite` is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cocreate/dqlite",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "Lightweight dqlite CRUD wrapper and multi-tenant state routing client for the CoCreate ecosystem.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"dqlite",
|
|
@@ -13,7 +13,9 @@
|
|
|
13
13
|
"multi-tenant",
|
|
14
14
|
"multi-tenant-routing",
|
|
15
15
|
"realtime-sync",
|
|
16
|
-
"state-synchronization"
|
|
16
|
+
"state-synchronization",
|
|
17
|
+
"state-routing",
|
|
18
|
+
"embedded-replicas"
|
|
17
19
|
],
|
|
18
20
|
"publishConfig": {
|
|
19
21
|
"access": "public"
|