@bullet./paraql 0.1.0

package/CMakeLists.txt

@@ -0,0 +1,103 @@
+cmake_minimum_required(VERSION 4.0)
+
+find_package(cmake-bare REQUIRED PATHS node_modules/cmake-bare)
+find_package(cmake-fetch REQUIRED PATHS node_modules/cmake-fetch)
+find_package(cmake-napi REQUIRED PATHS node_modules/cmake-napi)
+find_package(cmake-npm REQUIRED PATHS node_modules/cmake-npm)
+
+project(paraql C)
+
+fetch_package(
+  "github:tursodatabase/libsql@libsql-0.9.30"
+  SOURCE_DIR libsql_src
+  PATCHES "patches/libsql/makefile.patch"
+)
+
+set(sqlite3_src "${libsql_src}/libsql-sqlite3")
+set(sqlite3_c "${sqlite3_src}/sqlite3.c")
+set(sqlite3_h "${sqlite3_src}/sqlite3.h")
+
+if(CMAKE_HOST_WIN32)
+  find_program(
+    make
+    NAMES nmake
+    REQUIRED
+  )
+
+  add_custom_command(
+    OUTPUT ${sqlite3_c} ${sqlite3_h}
+    COMMAND ${make} /f ${sqlite3_src}/makefile.msc sqlite3.c
+    WORKING_DIRECTORY ${sqlite3_src}
+    VERBATIM
+  )
+else()
+  find_program(
+    sh
+    NAMES sh
+    REQUIRED
+  )
+  
+  find_program(
+    make
+    NAMES gmake make
+    REQUIRED
+  )
+  
+  add_custom_command(
+    OUTPUT ${sqlite3_src}/Makefile
+    COMMAND ${sh} ${sqlite3_src}/configure --enable-all
+    WORKING_DIRECTORY ${sqlite3_src}
+    VERBATIM
+  )
+  
+  add_custom_command(
+    OUTPUT ${sqlite3_c} ${sqlite3_h}
+    COMMAND ${make} sqlite3.c
+    WORKING_DIRECTORY ${sqlite3_src}
+    DEPENDS ${sqlite3_src}/Makefile
+    VERBATIM
+  )
+endif()
+
+add_library(libsql "${sqlite3_c}")
+
+target_include_directories(
+  libsql
+  INTERFACE "${sqlite3_src}"
+)
+
+add_bare_module(paraql_bare)
+
+target_sources(
+  ${paraql_bare}
+  PRIVATE
+    binding.c
+)
+
+target_link_libraries(
+  ${paraql_bare}
+  PRIVATE
+    libsql
+)
+
+add_napi_module(paraql_node)
+
+target_sources(
+  ${paraql_node}
+  PRIVATE
+    binding.c
+)
+
+target_link_libraries(
+  ${paraql_node}
+  PUBLIC
+    libsql
+)
+
+resolve_node_module(bare-compat-napi compat)
+
+target_include_directories(
+  ${paraql_node}
+  PRIVATE
+    "${compat}/include"
+)

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2026 Tomas Ravinskas
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,213 @@
+# ParaQL
+
+ParaQL is a mad-science experiment combining [libSQL](https://github.com/tursodatabase/libsql) (an open-contribution [SQLite](https://github.com/sqlite/sqlite) fork with native vector support) with [Autobase](https://github.com/holepunchto/autobase) (or to be more precise, it's next-gen iteration [Autobee](https://github.com/holepunchto/autobee)) for massively-parallel multi-writer access.
+
+It logs every write in a per-instance append-only log (oplog) and applies them in deterministic order to a shared view (the database) ensuring no corruption can occur. This is not very fast, however existing writers typically have limited activity and newcomers can simply fast-forward to the latest view (the database), making overall performance acceptable.
+
+For a better idea of how ParaQL performs and compares to other solutions see [the benchmark](./BENCHMARK.md).
+
+ParaQL is developed on [Bare](https://github.com/holepunchto/bare) but it should also run on Node. Because Bare is multi-platform, ParaQL should run on recent versions of Android, iOS, macOS, Linux, and Windows.
+
+ParaQL supports encrypting the database with a 256-bit key, both on disk and in transport (meaning remote peers need to know the key to read or write into the database). The local-only temporary files are currently encrypted with unique but not random nonces. This is something we're still working on.
+
+ParaQL also supports compression with zlib's deflate algorithm. While this slows down writing considerably, it reduces disk space used by ~3x or more, so depending on your environment it might be worth considering. Do note that compression affects every instance of the same database.
+
+ParaQL has native support for vector data types and vector search functions with optional indexing. This is courtesy of libSQL and one of the primary reasons ParaQL was made: to support vector similarity search in P2P context.
+
+## Install
+
+```shell
+npm i paraql
+```
+
+## Usage
+
+```javascript
+const Corestore = require("corestore")
+const ParaQL = require("paraql")
+
+const store = new Corestore("./paraql")
+const db = new ParaQL(store)
+
+await db.ready()
+
+await db.exec(`
+  CREATE TABLE people (id INTEGER PRIMARY KEY, name TEXT);
+  INSERT INTO people (name) VALUES ('Alice'), ('Bob');
+`)
+
+const select = await db.prepare("SELECT id, name FROM people ORDER BY id")
+
+for await (const row of select.iterate()) {
+  console.log(row)
+}
+
+await db.close()
+```
+
+Prints:
+
+```json
+{ id: 1, name: "Alice" }
+{ id: 2, name: "Bob" }
+```
+
+## API
+
+### `const db = new ParaQL(store[, key][, options])`
+
+Creates a new database or an instance of an existing database if key is provided. `store` is an instance of [Corestore](https://github.com/holepunchto/corestore) used for storage. `key` is either null or 32-byte key of the database.
+
+`options` include:
+
+```javascript
+options = {
+  cacheSize: 1024,
+  name: "paraql.db",
+  keyPair: null,
+  encrypted: false,
+  encryptionKey: null,
+  compressed: false,
+  compressionLevel: 6,
+}
+```
+
+`cacheSize` controls how many prepared statements are cached in memory.
+
+The following options should only be used at database creation and set for every instance of the database. Option mismatch will lead to database corruption.
+
+`name` is the name of the database file, also used as a prefix for temporary files.
+
+`keyPair`, if provided, is the signing key pair for the local writer in the form `{ publicKey: <32-byte Buffer>, secretKey: <32-byte Buffer> }` .
+
+If `encrypted` is true and `encryptionKey` is provided as 32-byte buffer, it is used to encrypt the database.
+
+`compressed` enables database compression and `compressionLevel` controls how many resources are used for the compression. It should be between 0 and 9 (inclusive).
+
+### `db.name`
+
+The name of the database file.
+
+### `db.key`
+
+The database key used for replication. `null` before `db.ready()` is called.
+
+### `db.local`
+
+The key of the local writer. Pass this to `db.addWriter()` to grant write access. `null` before `db.ready()` is called.
+
+### `db.discoveryKey`
+
+The discovery key of the database, can be used e.g. as the topic for replicating over [Hyperswarm](https://github.com/holepunchto/hyperswarm). `null` before `db.ready()` is called.
+
+### `encryptionKey`
+
+The key used to encrypt the database or `null`. `null` before `db.ready()` is called.
+
+### `writable`
+
+Whether this instance has write access to the database. `false` if `db.addWriter()` hasn't been called with this instances local key or if `db.ready()` hasn't been called.
+
+### `encrypted`
+
+Whether this database is encrypted.
+
+### `await db.ready()`
+
+Initialized the database. All methods call this implicitly, so unless you need to access some instance property early, there's no need to call this yourself.
+
+### `await db.close()`
+
+Closes the database and cleans up all used resources. Does not close the Corestore instance.
+
+### `await db.addWriter(key)`
+
+Grant another instance of the database write access. `key` should be the local key of the remote instance. `db` needs to be writable.
+
+### `await db.removeWriter(key)`
+
+Revoke write access from another instance of the database. `key` should be the local key of the remote instance. `db` needs to be writable.
+
+### `db.replicate(isInitiatorOrStream)`
+
+Creates a replication stream that can be piped over any streamable transport. `isInitiatorOrStream` can be a boolean indicating whether this instance initiated Noise handshake or another replication stream.
+
+### `await db.compact()`
+
+Compacts database and removes stale data. This operation is local only and can reduce disk space usage by +3x. You should run this periodically when idle.
+
+### `const info = await db.info()`
+
+Get information about disk space usage. Returned object has all properties in bytes and looks like this:
+
+```javascript
+{
+    database: number,
+    temporary: number,
+    total: number,
+}
+```
+
+### `await db.exec(sql)`
+
+Execute given SQL statement(s) without checking return values.
+
+This is a convenience method. Unless you need to load a large SQL dump or similar, this method should be avoided as it bloats the disk space requirements.
+
+### `const stmt = await db.prepare(sql)`
+
+Prepare SQL statement `stmt` from the first statement in `sql`. If `sql` contains more than one statement tailing statements are discarded.
+
+Prepared statements are cached to improve performance, so calling `db.prepare()` twice with the same `sql` will return previously cached `stmt`.
+
+All prepared statements are finalized when calling `db.close()`.
+
+### `stmt.sourceSQL`
+
+The SQL string used to initialize this prepared statement.
+
+### `stmt.batching`
+
+Whether this statement is in batching mode.
+
+### `stmt.batch(on)`
+
+Toggle batching mode, `on` is a boolean.
+
+When in batching mode `stmt.run()` queries are queued up in memory and only executed when calling `stmt.flush()`. This can greatly speed up both write and sync performance. However since they aren't executed immediately, you can't query the data until you flush it.
+
+### `const result = await stmt.flush()`
+
+Flush queued up queries writing them to disk.
+
+Returns an object in the form `{ changes: number, lastInsertRowid: number, errors: number }`.
+
+### `await stmt.finalize()`
+
+Finalize a statement freeing up resources used and clearing batching queue without flushing it.
+
+You should generally not need to call this method in normal usage.
+
+### `const rows = await stmt.all(...params)`
+
+Execute a statement with given positional params. First param may optionally be an object containing named params.
+
+Returns an array of row objects keyed by column name.
+
+### `const row = await stmt.get(...params)`
+
+Same as `stmt.all()` except it only returns the first row.
+
+### `const result = stmt.run(...params)`
+
+Execute a statement with given params and return an object in the form `{ changes: number, lastInsertRowid: number }`.
+
+In batching mode returns `null`.
+
+### `for await (const row of stmt.iterate(...params))`
+
+Execute a statement with given params and return rows one by one.
+
+## License
+
+Apache-2.0