@delali/sirannon-db 0.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/LICENSE +201 -0
- package/NOTICE +14 -0
- package/README.md +418 -0
- package/dist/chunk-VI4UP4RR.mjs +417 -0
- package/dist/client/index.d.ts +223 -0
- package/dist/client/index.mjs +479 -0
- package/dist/core/index.d.ts +295 -0
- package/dist/core/index.mjs +1346 -0
- package/dist/protocol-BX1H-_Mz.d.ts +104 -0
- package/dist/server/index.d.ts +103 -0
- package/dist/server/index.mjs +808 -0
- package/dist/sirannon-BJ8Yd1Uf.d.ts +148 -0
- package/dist/types-DArCObcu.d.ts +186 -0
- package/package.json +87 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Delali (https://sondelali.com)
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
sirannon-db
|
|
2
|
+
Copyright 2026 Delali (https://sondelali.com)
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
you may not use this file except in compliance with the License.
|
|
6
|
+
You may obtain a copy of the License at
|
|
7
|
+
|
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
See the License for the specific language governing permissions and
|
|
14
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,418 @@
|
|
|
1
|
+
# sirannon-db
|
|
2
|
+
|
|
3
|
+
Turn any SQLite database into a networked data layer with real-time subscriptions. One library gives you connection pooling, change data capture, migrations, scheduled backups, and a client SDK that talks over HTTP or WebSocket.
|
|
4
|
+
|
|
5
|
+
> *sirannon* means 'gate-stream' in Sindarin.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add @delali/sirannon-db
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Requires Node.js >= 22.
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { Sirannon } from '@delali/sirannon-db'
|
|
19
|
+
|
|
20
|
+
const sirannon = new Sirannon()
|
|
21
|
+
const db = sirannon.open('app', './data/app.db')
|
|
22
|
+
|
|
23
|
+
db.execute('CREATE TABLE IF NOT EXISTS users (id INTEGER PRIMARY KEY, name TEXT, email TEXT)')
|
|
24
|
+
db.execute('INSERT INTO users (name, email) VALUES (?, ?)', ['Ada', 'ada@example.com'])
|
|
25
|
+
|
|
26
|
+
const users = db.query<{ id: number; name: string }>('SELECT * FROM users')
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Three entry points
|
|
30
|
+
|
|
31
|
+
The package ships three independent exports so you only bundle what you need:
|
|
32
|
+
|
|
33
|
+
| Import | What you get |
|
|
34
|
+
|---|---|
|
|
35
|
+
| `@delali/sirannon-db` | Core library: queries, transactions, CDC, migrations, backups, hooks, metrics, lifecycle |
|
|
36
|
+
| `@delali/sirannon-db/server` | HTTP + WebSocket server powered by uWebSockets.js |
|
|
37
|
+
| `@delali/sirannon-db/client` | Browser/Node.js client SDK with auto-reconnect and subscription restore |
|
|
38
|
+
|
|
39
|
+
## Core features
|
|
40
|
+
|
|
41
|
+
### Queries and transactions
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
const row = db.queryOne<{ count: number }>('SELECT count(*) as count FROM users')
|
|
45
|
+
|
|
46
|
+
const result = db.execute(
|
|
47
|
+
'INSERT INTO users (name, email) VALUES (?, ?)',
|
|
48
|
+
['Grace', 'grace@example.com'],
|
|
49
|
+
)
|
|
50
|
+
// result.changes === 1, result.lastInsertRowId === 2
|
|
51
|
+
|
|
52
|
+
db.executeBatch('INSERT INTO tags (label) VALUES (?)', [
|
|
53
|
+
['typescript'],
|
|
54
|
+
['sqlite'],
|
|
55
|
+
['realtime'],
|
|
56
|
+
])
|
|
57
|
+
|
|
58
|
+
const total = db.transaction(tx => {
|
|
59
|
+
tx.execute('UPDATE accounts SET balance = balance - 100 WHERE id = ?', [1])
|
|
60
|
+
tx.execute('UPDATE accounts SET balance = balance + 100 WHERE id = ?', [2])
|
|
61
|
+
const [row] = tx.query<{ balance: number }>('SELECT balance FROM accounts WHERE id = ?', [2])
|
|
62
|
+
return row
|
|
63
|
+
})
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Statements are cached in an LRU pool (capacity 128) so repeated queries skip the prepare step.
|
|
67
|
+
|
|
68
|
+
### Connection pooling
|
|
69
|
+
|
|
70
|
+
Every database opens with 1 dedicated write connection and N read connections (default 4). WAL mode is enabled by default, allowing concurrent reads during writes.
|
|
71
|
+
|
|
72
|
+
```ts
|
|
73
|
+
const db = sirannon.open('analytics', './data/analytics.db', {
|
|
74
|
+
readPoolSize: 8,
|
|
75
|
+
walMode: true,
|
|
76
|
+
})
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Change data capture (CDC)
|
|
80
|
+
|
|
81
|
+
Watch tables for INSERT, UPDATE, and DELETE events in real time. The CDC system installs SQLite triggers that record changes into a tracking table, then polls at a configurable interval.
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
db.watch('orders')
|
|
85
|
+
|
|
86
|
+
const subscription = db
|
|
87
|
+
.on('orders')
|
|
88
|
+
.filter({ status: 'shipped' })
|
|
89
|
+
.subscribe(event => {
|
|
90
|
+
// event.type: 'insert' | 'update' | 'delete'
|
|
91
|
+
// event.row: the current row
|
|
92
|
+
// event.oldRow: previous row (updates and deletes)
|
|
93
|
+
// event.seq: monotonic sequence number
|
|
94
|
+
console.log(`Order ${event.row.id} was ${event.type}d`)
|
|
95
|
+
})
|
|
96
|
+
|
|
97
|
+
// Stop listening:
|
|
98
|
+
subscription.unsubscribe()
|
|
99
|
+
|
|
100
|
+
// Stop tracking entirely:
|
|
101
|
+
db.unwatch('orders')
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Migrations
|
|
105
|
+
|
|
106
|
+
Place numbered SQL files in a directory using the `.up.sql` / `.down.sql` convention. Each migration runs inside a transaction and is tracked in a `_sirannon_migrations` table so it only applies once. Down files are optional; rollback throws if a down file is missing for a version being rolled back.
|
|
107
|
+
|
|
108
|
+
```txt
|
|
109
|
+
migrations/
|
|
110
|
+
001_create_users.up.sql
|
|
111
|
+
001_create_users.down.sql
|
|
112
|
+
002_add_email_index.up.sql
|
|
113
|
+
003_create_orders.up.sql
|
|
114
|
+
003_create_orders.down.sql
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Timestamp-based versioning works the same way:
|
|
118
|
+
|
|
119
|
+
```txt
|
|
120
|
+
migrations/
|
|
121
|
+
1709312400_create_users.up.sql
|
|
122
|
+
1709312400_create_users.down.sql
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### File-based migrations
|
|
126
|
+
|
|
127
|
+
```ts
|
|
128
|
+
const result = db.migrate('./migrations')
|
|
129
|
+
// result.applied: entries that ran this time
|
|
130
|
+
// result.skipped: number of entries already applied
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
#### Rollback
|
|
134
|
+
|
|
135
|
+
```ts
|
|
136
|
+
db.rollback('./migrations') // undo the last applied migration
|
|
137
|
+
db.rollback('./migrations', 2) // undo all migrations after version 2
|
|
138
|
+
db.rollback('./migrations', 0) // undo everything
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
#### Programmatic migrations
|
|
142
|
+
|
|
143
|
+
Pass an array of migration objects instead of a directory path. The `up` and `down` fields accept SQL strings or functions that receive a `Transaction`.
|
|
144
|
+
|
|
145
|
+
```ts
|
|
146
|
+
const migrations = [
|
|
147
|
+
{
|
|
148
|
+
version: 1,
|
|
149
|
+
name: 'create_users',
|
|
150
|
+
up: 'CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)',
|
|
151
|
+
down: 'DROP TABLE users',
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
version: 2,
|
|
155
|
+
name: 'seed_data',
|
|
156
|
+
up: (tx) => {
|
|
157
|
+
// You can run any code here
|
|
158
|
+
tx.execute("INSERT INTO users (name) VALUES (?)", ['Alice'])
|
|
159
|
+
},
|
|
160
|
+
down: (tx) => {
|
|
161
|
+
tx.execute("DELETE FROM users WHERE name = ?", ['Alice'])
|
|
162
|
+
},
|
|
163
|
+
},
|
|
164
|
+
]
|
|
165
|
+
|
|
166
|
+
db.migrate(migrations)
|
|
167
|
+
db.rollback(migrations) // undo last migration
|
|
168
|
+
db.rollback(migrations, 0) // undo everything
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Backups
|
|
172
|
+
|
|
173
|
+
One-shot backups use `VACUUM INTO` for a consistent snapshot. Scheduled backups run on a cron expression with automatic file rotation.
|
|
174
|
+
|
|
175
|
+
```ts
|
|
176
|
+
db.backup('./backups/snapshot.db')
|
|
177
|
+
|
|
178
|
+
db.scheduleBackup({
|
|
179
|
+
cron: '0 */6 * * *', // every 6 hours
|
|
180
|
+
destDir: './backups',
|
|
181
|
+
maxFiles: 10, // keep the 10 most recent
|
|
182
|
+
onError: err => console.error('Backup failed:', err),
|
|
183
|
+
})
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Hooks
|
|
187
|
+
|
|
188
|
+
Hooks run before or after key operations. Throwing from a before-hook denies the operation.
|
|
189
|
+
|
|
190
|
+
```ts
|
|
191
|
+
sirannon.onBeforeQuery(ctx => {
|
|
192
|
+
if (ctx.sql.includes('DROP')) {
|
|
193
|
+
throw new Error('DROP statements are not allowed')
|
|
194
|
+
}
|
|
195
|
+
})
|
|
196
|
+
|
|
197
|
+
sirannon.onAfterQuery(ctx => {
|
|
198
|
+
console.log(`[${ctx.databaseId}] ${ctx.sql} took ${ctx.durationMs}ms`)
|
|
199
|
+
})
|
|
200
|
+
|
|
201
|
+
sirannon.onDatabaseOpen(ctx => {
|
|
202
|
+
console.log(`Opened ${ctx.databaseId} at ${ctx.path}`)
|
|
203
|
+
})
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
Global hooks on the `Sirannon` instance: `onBeforeQuery`, `onAfterQuery`, `onBeforeConnect`, `onDatabaseOpen`, `onDatabaseClose`. The `onBeforeSubscribe` hook is available through the `HookConfig` constructor option. Query hooks (`onBeforeQuery`, `onAfterQuery`) can also be registered locally on individual `Database` instances.
|
|
207
|
+
|
|
208
|
+
**Note:** The `ctx.sql.includes('DROP')` pattern shown above is for illustration only. Simple string matching is not a production SQL firewall because casing, comments, Unicode tricks, and concatenated SQL can bypass it. For real access control, combine `onBeforeQuery` with an allow-list of query patterns or a proper SQL parser.
|
|
209
|
+
|
|
210
|
+
### Metrics
|
|
211
|
+
|
|
212
|
+
Plug in callbacks to collect query timing, connection events, and CDC activity.
|
|
213
|
+
|
|
214
|
+
```ts
|
|
215
|
+
const sirannon = new Sirannon({
|
|
216
|
+
metrics: {
|
|
217
|
+
onQueryComplete: m => histogram.observe(m.durationMs),
|
|
218
|
+
onConnectionOpen: m => gauge.inc({ db: m.databaseId }),
|
|
219
|
+
onConnectionClose: m => gauge.dec({ db: m.databaseId }),
|
|
220
|
+
onCDCEvent: m => counter.inc({ table: m.table, op: m.operation }),
|
|
221
|
+
},
|
|
222
|
+
})
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Lifecycle management
|
|
226
|
+
|
|
227
|
+
For multi-tenant setups, the lifecycle manager handles auto-opening, idle timeouts, and LRU eviction so you don't have to manage database handles yourself.
|
|
228
|
+
|
|
229
|
+
```ts
|
|
230
|
+
const sirannon = new Sirannon({
|
|
231
|
+
lifecycle: {
|
|
232
|
+
autoOpen: {
|
|
233
|
+
resolver: id => ({ path: `/data/tenants/${id}.db` }),
|
|
234
|
+
},
|
|
235
|
+
idleTimeout: 300_000, // close after 5 minutes of inactivity
|
|
236
|
+
maxOpen: 50, // evict least-recently-used when full
|
|
237
|
+
},
|
|
238
|
+
})
|
|
239
|
+
|
|
240
|
+
// Databases resolve on first access:
|
|
241
|
+
const db = sirannon.get('tenant-42') // opens /data/tenants/tenant-42.db
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
## Server
|
|
245
|
+
|
|
246
|
+
Expose any `Sirannon` instance over HTTP and WebSocket with a single function call. The server uses uWebSockets.js for high throughput.
|
|
247
|
+
|
|
248
|
+
```ts
|
|
249
|
+
import { Sirannon } from '@delali/sirannon-db'
|
|
250
|
+
import { createServer } from '@delali/sirannon-db/server'
|
|
251
|
+
|
|
252
|
+
const sirannon = new Sirannon()
|
|
253
|
+
sirannon.open('app', './data/app.db')
|
|
254
|
+
|
|
255
|
+
const server = createServer(sirannon, {
|
|
256
|
+
port: 9876,
|
|
257
|
+
cors: true,
|
|
258
|
+
onRequest: ({ headers, path, method, remoteAddress }) => {
|
|
259
|
+
if (headers.authorization !== `Bearer ${process.env.API_TOKEN}`) {
|
|
260
|
+
return { status: 401, code: 'UNAUTHORIZED', message: 'Invalid or missing token' }
|
|
261
|
+
}
|
|
262
|
+
},
|
|
263
|
+
})
|
|
264
|
+
|
|
265
|
+
await server.listen()
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
The `onRequest` hook runs before every database route (HTTP and WebSocket upgrade). Return `void` to allow the request, or return a `{ status, code, message }` object to deny it. The hook receives a `RequestContext` with `headers`, `method`, `path`, `databaseId`, and `remoteAddress`. Health endpoints (`/health`, `/health/ready`) bypass this hook.
|
|
269
|
+
|
|
270
|
+
**Important:** The server accepts arbitrary SQL from clients. When exposed beyond localhost, always use `onRequest` to authenticate and authorize requests.
|
|
271
|
+
|
|
272
|
+
### HTTP routes
|
|
273
|
+
|
|
274
|
+
| Method | Path | Description |
|
|
275
|
+
|---|---|---|
|
|
276
|
+
| `POST` | `/db/:id/query` | Execute a SELECT, returns `{ rows }` |
|
|
277
|
+
| `POST` | `/db/:id/execute` | Execute a mutation, returns `{ changes, lastInsertRowId }` |
|
|
278
|
+
| `POST` | `/db/:id/transaction` | Execute a batch of statements atomically, returns `{ results }` |
|
|
279
|
+
| `GET` | `/health` | Liveness check |
|
|
280
|
+
| `GET` | `/health/ready` | Readiness check with per-database status |
|
|
281
|
+
|
|
282
|
+
### WebSocket protocol
|
|
283
|
+
|
|
284
|
+
Connect to `ws://host:port/db/:id` and send JSON messages for queries, executions, and CDC subscriptions. The server dispatches change events to subscribers in real time.
|
|
285
|
+
|
|
286
|
+
## Client SDK
|
|
287
|
+
|
|
288
|
+
The client SDK mirrors the core `Database` API with async methods. It supports both HTTP and WebSocket transports, with automatic reconnection and subscription restoration on the WebSocket transport.
|
|
289
|
+
|
|
290
|
+
```ts
|
|
291
|
+
import { SirannonClient } from '@delali/sirannon-db/client'
|
|
292
|
+
|
|
293
|
+
const client = new SirannonClient('http://localhost:9876', {
|
|
294
|
+
transport: 'websocket',
|
|
295
|
+
autoReconnect: true,
|
|
296
|
+
reconnectInterval: 1000,
|
|
297
|
+
})
|
|
298
|
+
|
|
299
|
+
const db = client.database('app')
|
|
300
|
+
|
|
301
|
+
const users = await db.query<{ id: number; name: string }>('SELECT * FROM users')
|
|
302
|
+
|
|
303
|
+
await db.execute('INSERT INTO users (name) VALUES (?)', ['Turing'])
|
|
304
|
+
|
|
305
|
+
const sub = await db
|
|
306
|
+
.on('users')
|
|
307
|
+
.filter({ role: 'admin' })
|
|
308
|
+
.subscribe(event => console.log('Admin changed:', event))
|
|
309
|
+
|
|
310
|
+
// Cleanup:
|
|
311
|
+
sub.unsubscribe()
|
|
312
|
+
client.close()
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
Transactions require HTTP transport:
|
|
316
|
+
|
|
317
|
+
```ts
|
|
318
|
+
const httpClient = new SirannonClient('http://localhost:9876', {
|
|
319
|
+
transport: 'http',
|
|
320
|
+
})
|
|
321
|
+
|
|
322
|
+
const httpDb = httpClient.database('app')
|
|
323
|
+
|
|
324
|
+
await httpDb.transaction([
|
|
325
|
+
{ sql: 'UPDATE accounts SET balance = balance - 50 WHERE id = ?', params: [1] },
|
|
326
|
+
{ sql: 'UPDATE accounts SET balance = balance + 50 WHERE id = ?', params: [2] },
|
|
327
|
+
])
|
|
328
|
+
|
|
329
|
+
httpClient.close()
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
## Error handling
|
|
333
|
+
|
|
334
|
+
All errors extend `SirannonError` with a machine-readable `code` property:
|
|
335
|
+
|
|
336
|
+
| Error | Code | When |
|
|
337
|
+
|---|---|---|
|
|
338
|
+
| `DatabaseNotFoundError` | `DATABASE_NOT_FOUND` | Database ID not in registry |
|
|
339
|
+
| `DatabaseAlreadyExistsError` | `DATABASE_ALREADY_EXISTS` | Duplicate database ID |
|
|
340
|
+
| `ReadOnlyError` | `READ_ONLY` | Write attempted on read-only database |
|
|
341
|
+
| `QueryError` | `QUERY_ERROR` | SQL execution failure |
|
|
342
|
+
| `TransactionError` | `TRANSACTION_ERROR` | Transaction commit/rollback failure |
|
|
343
|
+
| `MigrationError` | `MIGRATION_ERROR` | Migration step failure |
|
|
344
|
+
| `HookDeniedError` | `HOOK_DENIED` | Before-hook rejected the operation |
|
|
345
|
+
| `CDCError` | `CDC_ERROR` | Change tracking pipeline failure |
|
|
346
|
+
| `BackupError` | `BACKUP_ERROR` | Backup operation failure |
|
|
347
|
+
| `ConnectionPoolError` | `CONNECTION_POOL_ERROR` | Pool closed or misconfigured |
|
|
348
|
+
| `MaxDatabasesError` | `MAX_DATABASES` | Capacity limit reached |
|
|
349
|
+
| `ExtensionError` | `EXTENSION_ERROR` | SQLite extension load failure |
|
|
350
|
+
|
|
351
|
+
```ts
|
|
352
|
+
import { QueryError } from '@delali/sirannon-db'
|
|
353
|
+
|
|
354
|
+
try {
|
|
355
|
+
db.execute('INSERT INTO users (id) VALUES (?)', [1])
|
|
356
|
+
} catch (err) {
|
|
357
|
+
if (err instanceof QueryError) {
|
|
358
|
+
console.error(`SQL failed [${err.code}]: ${err.message}`)
|
|
359
|
+
console.error(`Statement: ${err.sql}`)
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
## Configuration reference
|
|
365
|
+
|
|
366
|
+
### `DatabaseOptions`
|
|
367
|
+
|
|
368
|
+
| Option | Type | Default | Description |
|
|
369
|
+
|---|---|---|---|
|
|
370
|
+
| `readOnly` | `boolean` | `false` | Open in read-only mode |
|
|
371
|
+
| `readPoolSize` | `number` | `4` | Number of read connections |
|
|
372
|
+
| `walMode` | `boolean` | `true` | Enable WAL mode |
|
|
373
|
+
| `cdcPollInterval` | `number` | `50` | CDC polling interval in ms |
|
|
374
|
+
| `cdcRetention` | `number` | `3_600_000` | CDC retention period in ms (1 hour) |
|
|
375
|
+
|
|
376
|
+
### `SirannonOptions`
|
|
377
|
+
|
|
378
|
+
| Option | Type | Description |
|
|
379
|
+
|---|---|---|
|
|
380
|
+
| `hooks` | `HookConfig` | Before/after hooks for queries, connections, subscriptions |
|
|
381
|
+
| `metrics` | `MetricsConfig` | Callbacks for query timing, connection events, CDC activity |
|
|
382
|
+
| `lifecycle` | `LifecycleConfig` | Auto-open resolver, idle timeout, max open databases |
|
|
383
|
+
|
|
384
|
+
### `ServerOptions`
|
|
385
|
+
|
|
386
|
+
| Option | Type | Default | Description |
|
|
387
|
+
|---|---|---|---|
|
|
388
|
+
| `host` | `string` | `'127.0.0.1'` | Bind address |
|
|
389
|
+
| `port` | `number` | `9876` | Listen port |
|
|
390
|
+
| `cors` | `boolean \| CorsOptions` | `false` | CORS configuration |
|
|
391
|
+
| `onRequest` | `OnRequestHook` | - | Middleware hook for auth, rate limiting, and request validation |
|
|
392
|
+
|
|
393
|
+
### `ClientOptions`
|
|
394
|
+
|
|
395
|
+
| Option | Type | Default | Description |
|
|
396
|
+
|---|---|---|---|
|
|
397
|
+
| `transport` | `'websocket' \| 'http'` | `'websocket'` | Transport protocol |
|
|
398
|
+
| `headers` | `Record<string, string>` | - | Custom HTTP headers |
|
|
399
|
+
| `autoReconnect` | `boolean` | `true` | Reconnect on WebSocket disconnect |
|
|
400
|
+
| `reconnectInterval` | `number` | `1000` | Reconnect delay in ms |
|
|
401
|
+
|
|
402
|
+
## Benchmarks
|
|
403
|
+
|
|
404
|
+
The benchmark suite compares Sirannon's embedded SQLite performance against Postgres 17 across micro-operations, YCSB, TPC-C, and concurrency scaling. See [`packages/ts/benchmarks/BENCHMARKS.md`](packages/ts/benchmarks/BENCHMARKS.md) for setup instructions, configuration, Docker-based fair comparisons, and statistical analysis methodology.
|
|
405
|
+
|
|
406
|
+
## Development
|
|
407
|
+
|
|
408
|
+
```bash
|
|
409
|
+
pnpm install
|
|
410
|
+
pnpm build
|
|
411
|
+
pnpm test
|
|
412
|
+
pnpm typecheck
|
|
413
|
+
pnpm lint
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
## License
|
|
417
|
+
|
|
418
|
+
Apache-2.0
|