├── .cargo
└── config.toml
├── .gitignore
├── Cargo.toml
├── LICENSE
├── README.md
├── examples
├── deno
│ ├── deno.json
│ ├── index.html
│ ├── src
│ │ ├── App.jsx
│ │ ├── binding_test.js
│ │ ├── main.jsx
│ │ └── worker.js
│ └── vite.config.js
├── react
│ ├── eslint.config.js
│ ├── index.html
│ ├── index.js
│ ├── package.json
│ ├── src
│ │ ├── App.jsx
│ │ ├── binding_test.js
│ │ ├── main.jsx
│ │ └── worker.js
│ └── vite.config.js
└── wasm
│ ├── simple.html
│ └── worker.js
├── src
├── connection.rs
├── db.rs
├── executor
│ ├── mod.rs
│ ├── tokio.rs
│ └── wasm.rs
├── lib.rs
└── utils.rs
└── tests
└── sqllogictest
└── Cargo.toml
/.cargo/config.toml:
--------------------------------------------------------------------------------
1 | [target.wasm32-unknown-unknown]
2 | rustflags = ["-C", "target-feature=+atomics,+bulk-memory,+mutable-globals", "--cfg", 'getrandom_backend="wasm_js"']
3 |
4 | [unstable]
5 | build-std = ["panic_abort", "std"]
6 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /target
2 | node_modules
3 |
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "sqlite-tonbo"
3 | version = "0.1.0"
4 | edition = "2021"
5 |
6 | [lib]
7 | path = "src/lib.rs"
8 | crate-type = ["cdylib", "rlib"]
9 |
10 | [features]
11 | default = ["tokio"]
12 | tokio = ["dep:tokio", "tonbo/tokio", "tonbo/tokio-http"]
13 | wasm = [
14 | "dep:wasm_thread",
15 | "dep:wasm-bindgen",
16 | "dep:wasm-bindgen-futures",
17 | "fusio/no-send",
18 | "tonbo/wasm",
19 | "tonbo/sync"
20 | ]
21 | loadable_extension = ["rusqlite/functions", "rusqlite/loadable_extension"]
22 |
23 | [dependencies]
24 | flume = "0.11"
25 | fusio = { version = "=0.3.4", package = "fusio", features = [
26 | "dyn",
27 | "fs",
28 | "aws",
29 | ] }
30 | fusio-dispatch = { version = "=0.3.4", package = "fusio-dispatch", features = ["aws"] }
31 | fusio-parquet = { version = "=0.3.4", package = "fusio-parquet" }
32 | futures-util = "0.3"
33 | tokio = { version = "1.41", optional = true, features = ["rt-multi-thread"] }
34 | tonbo = { git = "https://github.com/tonbo-io/tonbo", rev = "8c3ad6ffe0d40c8be1332ccbcf9d230f838f73ba", package = "tonbo", default-features = false, features = ["aws"] }
35 | rusqlite = { version = "0.32.1", features = [
36 | "vtab",
37 | "bundled",
38 | ] }
39 | sqlparser = "0.52"
40 |
41 | wasm-bindgen = { version = "0.2.93", optional = true }
42 | wasm-bindgen-futures = { version = "0.4", optional = true }
43 | wasm_thread = { version = "0.3", optional = true }
44 |
45 | [target.'cfg(target_arch = "wasm32")'.dependencies]
46 | getrandom = { version = "0.3.1", features = ["wasm_js"] }
47 | log = "0.4"
48 | console_log = { version = "1.0", features = ["color"] }
49 | console_error_panic_hook = "0.1.7"
50 |
51 | [dev-dependencies]
52 | wasm-bindgen-test = "0.3"
53 |
54 | [patch.crates-io.rusqlite]
55 | git = "https://github.com/tonbo-io/rusqlite"
56 | branch = "feat/integrity"
57 |
58 | [patch.crates-io.wasm_thread]
59 | git = "https://github.com/Twey/wasm_thread"
60 | branch = "post-message"
61 |
62 | [profile.release]
63 | codegen-units = 1
64 | lto = true
65 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | # TonboLite
17 |
18 | TonboLite is a WASM compatible SQLite extension that allows users to create tables which supports analytical processing directly in SQLite. Its storage engine is powered by our open-source embedded key-value database, [Tonbo](https://github.com/tonbo-io/tonbo).
19 |
20 | ## Features
21 | - Organizing [Parquet](https://parquet.apache.org/) files using [Log-Structured Merge Tree](https://en.wikipedia.org/wiki/Log-structured_merge-tree) for fast writing
22 | - Supports OPFS, S3 as remote storage or mixed them together as storage back-end.
23 | - Compatibility with WebAssembly
24 |
25 | ## Usage
26 |
27 | ### Use in SQLite CLI
28 | Use [`.load`](https://www.sqlite.org/cli.html#loading_extensions) command to load a SQLite extension
29 | ```bash
30 | sqlite> .load target/release/libsqlite_tonbo
31 |
32 | sqlite> CREATE VIRTUAL TABLE temp.tonbo USING tonbo(
33 | create_sql = 'create table tonbo(id bigint primary key, name varchar, like int)',
34 | path = 'db_path/tonbo'
35 | );
36 | sqlite> insert into tonbo (id, name, like) values (0, 'tonbo', 100);
37 | sqlite> insert into tonbo (id, name, like) values (1, 'sqlite', 200);
38 |
39 | sqlite> select * from tonbo;
40 | 0|tonbo|100
41 | 1|sqlite|200
42 |
43 | sqlite> update tonbo set like = 123 where id = 0;
44 |
45 | sqlite> select * from tonbo;
46 | 0|tonbo|123
47 | 1|sqlite|200
48 |
49 | sqlite> delete from tonbo where id = 0;
50 |
51 | sqlite> select * from tonbo;
52 | 1|sqlite|200
53 | ```
54 |
55 | Or use SQLite extension in Python:
56 | ```python
57 | import sqlite3
58 |
59 | conn = sqlite3.connect(":memory")
60 | conn.enable_load_extension(True)
61 | # Load the tonbolite extension
62 | conn.load_extension("target/release/libsqlite_tonbo.dylib")
63 | con.enable_load_extension(False)
64 |
65 | conn.execute("CREATE VIRTUAL TABLE temp.tonbo USING tonbo("
66 | "create_sql = 'create table tonbo(id bigint primary key, name varchar, like int)', "
67 | "path = 'db_path/tonbo'"
68 | ")")
69 | conn.execute("INSERT INTO tonbo (id, name, like) VALUES (0, 'lol', 1)")
70 | conn.execute("INSERT INTO tonbo (id, name, like) VALUES (1, 'lol', 100)")
71 | rows = conn.execute("SELECT * FROM tonbo;")
72 | for row in rows:
73 | print(row)
74 | ```
75 |
76 | ### Use in Rust
77 | TonboLite is able to be used just like a regular SQLite program.
78 | > Please use our Rusqlite patch
79 | > ```toml
80 | > [patch.crates-io.rusqlite]
81 | > git = "https://github.com/tonbo-io/rusqlite"
82 | > branch = "feat/integrity"
83 | > ```
84 | ```rust
85 | #[tokio::main]
86 | async fn main() -> rusqlite::Result<()> {
87 | let db = Connection::open_in_memory()?;
88 | // load TonboLite
89 | load_module(&db)?;
90 |
91 | // use TonboLite like normal SQLite
92 | db.execute_batch(
93 | "CREATE VIRTUAL TABLE temp.tonbo USING tonbo(
94 | create_sql = 'create table tonbo(id bigint primary key, name varchar, like int)'
95 | path = 'db_path/tonbo'
96 | );",
97 | )?;
98 | db.execute("INSERT INTO tonbo (id, name, like) VALUES (0, 'lol', 1)", [])?;
99 |
100 | // query from table
101 | let mut stmt = db.prepare("SELECT * FROM tonbo;")?;
102 | let mut rows = stmt.query([])?;
103 | while let Some(row) = rows.next()? {
104 | println!("{:#?}", row);
105 | }
106 | }
107 | ```
108 |
109 |
110 | ### Use in Wasm
111 |
112 | TonboLite exposed an easy-to-use API
113 |
114 | ```js
115 | const conn = new tonbo.Connection();
116 |
117 | // create table with `CREATE VIRTUAL TABLE` statement
118 | await conn.create(
119 | `CREATE VIRTUAL TABLE temp.tonbo USING tonbo(
120 | create_sql = 'create table tonbo(id bigint primary key, name varchar, like int)',
121 | path = 'db_path/tonbo'
122 | );`
123 | );
124 |
125 | // insert/update/delete table
126 | await conn.insert(
127 | `INSERT INTO tonbo (id, name, like) VALUES (0, 'lol', 0)`
128 | );
129 | await conn.update("UPDATE tonbo SET name = 'bar' WHERE id = 0");
130 | await conn.delete("DELETE from tonbo WHERE id = 0");
131 |
132 | // query from table
133 | const rows = await conn.select("SELECT * from tonbo");
134 |
135 | // fulsh in-memory data to S3
136 | await conn.flush("tonbo");
137 | ```
138 |
139 | ## Configuration
140 | Configure tonbolite in `CREATE` statement:
141 | - `create_sql`(required): The `CREATE` SQL statement
142 | - `path`(required): Path to local storage
143 | - `fs`: `local`/`s3`
144 | - `level`: All data below the level will be stored in local storage, otherwise, it will be stored in S3.
145 | - S3 option:
146 | - `key_id`: The S3 access key
147 | - `secret_key`: The S3 secret access key
148 | - `bucket`: The S3 bucket
149 | - `endpoint`: The S3 endpoint
150 | - `region`: The S3 region
151 | - `sign_payload`: `true`/`false`. Whether to use payload
152 | - `checksum`: `true`/`false`. Whether to use checksum
153 | - `token`: security token
154 |
155 | Here is an example to configure S3 storage:
156 | ```sql
157 | CREATE VIRTUAL TABLE temp.tonbo USING tonbo(
158 | create_sql='create table tonbo(id bigint primary key, name varchar, like int)',
159 | path = 'db_path/test_s3',
160 | level = '0',
161 | fs = 's3',
162 | bucket = 'bucket',
163 | key_id = 'access_key',
164 | secret_key = 'access_secret_key',
165 | endpoint = 'https://xxx.s3.us-east.amazonaws.com'
166 | );
167 | ```
168 |
169 | ## Build
170 |
171 | ### Build as Extension
172 | ```sh
173 | cargo build --release --features loadable_extension
174 | ```
175 | Once building successfully, you will get a file named libsqlite_tonbo.dylib(`.dll` on windows, `.so` on most other unixes) in *target/release/*
176 | ### Build on Rust
177 |
178 | ```sh
179 | cargo build
180 | ```
181 |
182 | ### Build on Wasm
183 |
184 | To use TonboLite in wasm, it takes a few steps to build.
185 | 1. Add wasm32-unknown-unknown target
186 | ```sh
187 | rustup target add wasm32-unknown-unknown
188 | ```
189 | 2. Override toolchain with nightly
190 | ```sh
191 | rustup override set nightly
192 | ```
193 | 3. Build with [wasm-pack](https://github.com/rustwasm/wasm-pack)
194 | ```sh
195 | wasm-pack build --target web --no-default-features --features wasm
196 | ```
197 |
198 | Once you build successfully, you will get a *pkg* folder containing compiled js and wasm files. Copy it to your project and then you can start to use it.
199 | ```js
200 | const tonbo = await import("./pkg/sqlite_tonbo.js");
201 | await tonbo.default();
202 |
203 | // start to use TonboLite ...
204 | ```
205 |
206 | #### Limitation
207 | TonboLite should be used in a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) and [cross-origin isolated](https://developer.mozilla.org/en-US/docs/Web/API/Window/crossOriginIsolated), since it uses [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) to share memory. Please refer to [this article](https://web.dev/articles/coop-coep) for a detailed explanation.
208 |
--------------------------------------------------------------------------------
/examples/deno/deno.json:
--------------------------------------------------------------------------------
1 | {
2 | "tasks": {
3 | "dev": "cp -r ../../pkg ./src/ && deno run -A --node-modules-dir npm:vite",
4 | "build": "deno run -A --node-modules-dir npm:vite build",
5 | "preview": "deno run -A --node-modules-dir npm:vite preview",
6 | "serve": "deno run --allow-net --allow-read jsr:@std/http@1/file-server dist/"
7 | },
8 | "compilerOptions": {
9 | "lib": ["ES2020", "DOM", "DOM.Iterable"],
10 | "jsx": "react-jsx",
11 | "jsxImportSource": "react",
12 | "jsxImportSourceTypes": "@types/react"
13 | },
14 | "imports": {
15 | "@deno/vite-plugin": "npm:@deno/vite-plugin@^1.0.0",
16 | "@types/react": "npm:@types/react@^18.3.12",
17 | "@types/react-dom": "npm:@types/react-dom@^18.3.1",
18 | "@vitejs/plugin-react": "npm:@vitejs/plugin-react@^4.3.4",
19 | "react": "npm:react@^18.3.1",
20 | "react-dom": "npm:react-dom@^18.3.1",
21 | "vite": "npm:vite@^6.0.1"
22 | }
23 | }
24 |
--------------------------------------------------------------------------------
/examples/deno/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | Tonbolite react example
8 |
9 |
10 |
11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/examples/deno/src/App.jsx:
--------------------------------------------------------------------------------
1 |
2 | function App() {
3 |
4 | return (
5 | <>
6 |