@rocicorp/zero-sqlite3 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joshua Wise
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# better-sqlite3 [![Build Status](https://github.com/JoshuaWise/better-sqlite3/actions/workflows/build.yml/badge.svg)](https://github.com/JoshuaWise/better-sqlite3/actions/workflows/build.yml?query=branch%3Amaster)
+
+The fastest and simplest library for SQLite3 in Node.js.
+
+- Full transaction support
+- High performance, efficiency, and safety
+- Easy-to-use synchronous API *(better concurrency than an asynchronous API... yes, you read that correctly)*
+- Support for user-defined functions, aggregates, virtual tables, and extensions
+- 64-bit integers *(invisible until you need them)*
+- Worker thread support *(for large/slow queries)*
+
+## Help this project stay strong! 💪
+
+`better-sqlite3` is used by thousands of developers and engineers on a daily basis. Long nights and weekends were spent keeping this project strong and dependable, with no ask for compensation or funding, until now. If your company uses `better-sqlite3`, ask your manager to consider supporting the project:
+
+- [Become a GitHub sponsor](https://github.com/sponsors/JoshuaWise)
+- [Become a backer on Patreon](https://www.patreon.com/joshuawise)
+- [Make a one-time donation on PayPal](https://www.paypal.me/joshuathomaswise)
+
+## How other libraries compare
+
+|   |select 1 row  `get()` |select 100 rows   `all()`  |select 100 rows `iterate()` 1-by-1|insert 1 row `run()`|insert 100 rows in a transaction|
+|---|---|---|---|---|---|
+|better-sqlite3|1x|1x|1x|1x|1x|
+|[sqlite](https://www.npmjs.com/package/sqlite) and [sqlite3](https://www.npmjs.com/package/sqlite3)|11.7x slower|2.9x slower|24.4x slower|2.8x slower|15.6x slower|
+
+> You can verify these results by [running the benchmark yourself](./docs/benchmark.md).
+
+## Installation
+
+```bash
+npm install better-sqlite3
+```
+
+> You must be using Node.js v14.21.1 or above. Prebuilt binaries are available for [LTS versions](https://nodejs.org/en/about/releases/). If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
+
+## Usage
+
+```js
+const db = require('better-sqlite3')('foobar.db', options);
+
+const row = db.prepare('SELECT * FROM users WHERE id = ?').get(userId);
+console.log(row.firstName, row.lastName, row.email);
+```
+
+Though not required, [it is generally important to set the WAL pragma for performance reasons](https://github.com/WiseLibs/better-sqlite3/blob/master/docs/performance.md).
+
+```js
+db.pragma('journal_mode = WAL');
+```
+
+##### In ES6 module notation:
+
+```js
+import Database from 'better-sqlite3';
+const db = new Database('foobar.db', options);
+db.pragma('journal_mode = WAL');
+```
+
+## Why should I use this instead of [node-sqlite3](https://github.com/mapbox/node-sqlite3)?
+
+- `node-sqlite3` uses asynchronous APIs for tasks that are either CPU-bound or serialized. That's not only bad design, but it wastes tons of resources. It also causes [mutex thrashing](https://en.wikipedia.org/wiki/Resource_contention) which has devastating effects on performance.
+- `node-sqlite3` exposes low-level (C language) memory management functions. `better-sqlite3` does it the JavaScript way, allowing the garbage collector to worry about memory management.
+- `better-sqlite3` is simpler to use, and it provides nice utilities for some operations that are very difficult or impossible in `node-sqlite3`.
+- `better-sqlite3` is much faster than `node-sqlite3` in most cases, and just as fast in all other cases.
+
+#### When is this library not appropriate?
+
+In most cases, if you're attempting something that cannot be reasonably accomplished with `better-sqlite3`, it probably cannot be reasonably accomplished with SQLite3 in general. For example, if you're executing queries that take one second to complete, and you expect to have many concurrent users executing those queries, no amount of asynchronicity will save you from SQLite3's serialized nature. Fortunately, SQLite3 is very *very* fast. With proper indexing, we've been able to achieve upward of 2000 queries per second with 5-way-joins in a 60 GB database, where each query was handling 5–50 kilobytes of real data.
+
+If you have a performance problem, the most likely causes are inefficient queries, improper indexing, or a lack of [WAL mode](./docs/performance.md)—not `better-sqlite3` itself. However, there are some cases where `better-sqlite3` could be inappropriate:
+
+- If you expect a high volume of concurrent reads each returning many megabytes of data (i.e., videos)
+- If you expect a high volume of concurrent writes (i.e., a social media site)
+- If your database's size is near the terabyte range
+
+For these situations, you should probably use a full-fledged RDBMS such as [PostgreSQL](https://www.postgresql.org/).
+
+# Documentation
+
+- [API documentation](./docs/api.md)
+- [Performance](./docs/performance.md) (also see [benchmark results](./docs/benchmark.md))
+- [64-bit integer support](./docs/integer.md)
+- [Worker thread support](./docs/threads.md)
+- [Unsafe mode (advanced)](./docs/unsafe.md)
+- [SQLite3 compilation (advanced)](./docs/compilation.md)
+- [Contribution rules](./docs/contribution.md)
+- [Code of conduct](./docs/conduct.md)
+
+# License
+
+[MIT](./LICENSE)

package/binding.gyp

@@ -0,0 +1,71 @@
+# ===
+# This is the main GYP file, which builds better-sqlite3 with SQLite3 itself.
+# ===
+
+{
+  'includes': ['deps/common.gypi'],
+  'targets': [
+    {
+      'target_name': 'better_sqlite3',
+      'dependencies': ['deps/sqlite3.gyp:sqlite3'],
+      'sources': ['src/better_sqlite3.cpp'],
+      'cflags_cc': ['-std=c++20'],
+      'xcode_settings': {
+        'OTHER_CPLUSPLUSFLAGS': ['-std=c++20', '-stdlib=libc++'],
+      },
+      'msvs_settings': {
+        'VCCLCompilerTool': {
+          'AdditionalOptions': [
+            '/std:c++20',
+          ],
+        },
+      },
+      'conditions': [
+        ['OS=="linux"', {
+          'ldflags': [
+            '-Wl,-Bsymbolic',
+            '-Wl,--exclude-libs,ALL',
+          ],
+        }],
+      ],
+    },
+    {
+      'target_name': 'shell',
+      'type': 'executable',
+      'dependencies': ['deps/sqlite3.gyp:locate_sqlite3'],
+      'sources': ['<(SHARED_INTERMEDIATE_DIR)/sqlite3/sqlite3.c', '<(SHARED_INTERMEDIATE_DIR)/sqlite3/shell.c'],
+      'include_dirs': ['<(SHARED_INTERMEDIATE_DIR)/sqlite3/'],
+      'direct_dependent_settings': {
+        'include_dirs': ['<(SHARED_INTERMEDIATE_DIR)/sqlite3/'],
+      },
+      'cflags': ['-std=c99', '-w'],
+      'xcode_settings': {
+        'OTHER_CFLAGS': ['-std=c99'],
+        'WARNING_CFLAGS': ['-w'],
+      },
+      'conditions': [
+        ['sqlite3 == ""', {
+          'includes': ['deps/defines.gypi'],
+        }, {
+          'defines': [
+            # This is currently required by better-sqlite3.
+            'SQLITE_ENABLE_COLUMN_METADATA',
+          ],
+        }]
+      ],
+      'configurations': {
+        'Debug': {
+          'msvs_settings': { 'VCCLCompilerTool': { 'RuntimeLibrary': 1 } }, # static debug
+        },
+        'Release': {
+          'msvs_settings': { 'VCCLCompilerTool': { 'RuntimeLibrary': 0 } }, # static release
+        },
+      },
+    },
+    {
+      'target_name': 'test_extension',
+      'dependencies': ['deps/sqlite3.gyp:sqlite3'],
+      'conditions': [['sqlite3 == ""', { 'sources': ['deps/test_extension.c'] }]],
+    },
+  ],
+}

package/deps/common.gypi

@@ -0,0 +1,68 @@
+# ===
+# This configuration defines the differences between Release and Debug builds.
+# Some miscellaneous Windows settings are also defined here.
+# ===
+
+{
+  'variables': { 'sqlite3%': '' },
+  'target_defaults': {
+    'default_configuration': 'Release',
+    'msvs_settings': {
+      'VCCLCompilerTool': {
+        'ExceptionHandling': 1,
+      },
+    },
+    'conditions': [
+      ['OS == "win"', {
+        'defines': ['WIN32'],
+      }],
+    ],
+    'configurations': {
+      'Debug': {
+        'defines!': [
+          'NDEBUG',
+        ],
+        'defines': [
+          'DEBUG',
+          '_DEBUG',
+          'SQLITE_DEBUG',
+          'SQLITE_MEMDEBUG',
+          'SQLITE_ENABLE_API_ARMOR',
+          'SQLITE_WIN32_MALLOC_VALIDATE',
+        ],
+        'cflags': [
+          '-O0',
+        ],
+        'xcode_settings': {
+          'MACOSX_DEPLOYMENT_TARGET': '10.7',
+          'GCC_OPTIMIZATION_LEVEL': '0',
+          'GCC_GENERATE_DEBUGGING_SYMBOLS': 'YES',
+        },
+        'msvs_settings': {
+          'VCLinkerTool': {
+            'GenerateDebugInformation': 'true',
+          },
+        },
+      },
+      'Release': {
+        'defines!': [
+          'DEBUG',
+          '_DEBUG',
+        ],
+        'defines': [
+          'NDEBUG',
+        ],
+        'cflags': [
+          '-O3',
+        ],
+        'xcode_settings': {
+          'MACOSX_DEPLOYMENT_TARGET': '10.7',
+          'GCC_OPTIMIZATION_LEVEL': '3',
+          'GCC_GENERATE_DEBUGGING_SYMBOLS': 'NO',
+          'DEAD_CODE_STRIPPING': 'YES',
+          'GCC_INLINES_ARE_PRIVATE_EXTERN': 'YES',
+        },
+      },
+    },
+  },
+}

package/deps/copy.js

@@ -0,0 +1,32 @@
+'use strict';
+const path = require('path');
+const fs = require('fs');
+
+const dest = process.argv[2];
+const source = path.resolve(path.sep, process.argv[3] || path.join(__dirname, 'sqlite3'));
+const files = [
+  { filename: 'shell.c', optional: false },
+	{ filename: 'sqlite3.c', optional: false },
+	{ filename: 'sqlite3.h', optional: false },
+];
+
+if (process.argv[3]) {
+	// Support "_HAVE_SQLITE_CONFIG_H" in custom builds.
+	files.push({ filename: 'config.h', optional: true });
+} else {
+	// Required for some tests.
+	files.push({ filename: 'sqlite3ext.h', optional: false });
+}
+
+for (const { filename, optional } of files) {
+	const sourceFilepath = path.join(source, filename);
+	const destFilepath = path.join(dest, filename);
+
+	if (optional && !fs.existsSync(sourceFilepath)) {
+		continue;
+	}
+
+	fs.accessSync(sourceFilepath);
+	fs.mkdirSync(path.dirname(destFilepath), { recursive: true });
+	fs.copyFileSync(sourceFilepath, destFilepath);
+}

package/deps/defines.gypi

@@ -0,0 +1,42 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY deps/download.sh (DO NOT EDIT)
+
+{
+  'defines': [
+    'HAVE_INT16_T=1',
+    'HAVE_INT32_T=1',
+    'HAVE_INT8_T=1',
+    'HAVE_STDINT_H=1',
+    'HAVE_UINT16_T=1',
+    'HAVE_UINT32_T=1',
+    'HAVE_UINT8_T=1',
+    'HAVE_USLEEP=1',
+    'SQLITE_DEFAULT_CACHE_SIZE=-16000',
+    'SQLITE_DEFAULT_FOREIGN_KEYS=1',
+    'SQLITE_DEFAULT_MEMSTATUS=0',
+    'SQLITE_DEFAULT_WAL_SYNCHRONOUS=1',
+    'SQLITE_DQS=0',
+    'SQLITE_ENABLE_COLUMN_METADATA',
+    'SQLITE_ENABLE_DBSTAT_VTAB',
+    'SQLITE_ENABLE_DESERIALIZE',
+    'SQLITE_ENABLE_FTS3',
+    'SQLITE_ENABLE_FTS3_PARENTHESIS',
+    'SQLITE_ENABLE_FTS4',
+    'SQLITE_ENABLE_FTS5',
+    'SQLITE_ENABLE_GEOPOLY',
+    'SQLITE_ENABLE_JSON1',
+    'SQLITE_ENABLE_MATH_FUNCTIONS',
+    'SQLITE_ENABLE_RTREE',
+    'SQLITE_ENABLE_STAT4',
+    'SQLITE_ENABLE_UPDATE_DELETE_LIMIT',
+    'SQLITE_LIKE_DOESNT_MATCH_BLOBS',
+    'SQLITE_OMIT_DEPRECATED',
+    'SQLITE_OMIT_PROGRESS_CALLBACK',
+    'SQLITE_OMIT_SHARED_CACHE',
+    'SQLITE_OMIT_TCL_VARIABLE',
+    'SQLITE_SOUNDEX',
+    'SQLITE_THREADSAFE=2',
+    'SQLITE_TRACE_SIZE_LIMIT=32',
+    'SQLITE_USE_URI=0',
+    'SQLITE_OMIT_LOAD_EXTENSION',
+  ],
+}

package/deps/download.sh

@@ -0,0 +1,122 @@
+#!/usr/bin/env bash
+
+# ===
+# This script defines and generates the bundled SQLite3 unit (sqlite3.c).
+#
+# The following steps are taken:
+# 1. populate the shell environment with the defined compile-time options.
+# 2. download and extract the SQLite3 source code into a temporary directory.
+# 3. run "sh configure" and "make sqlite3.c" within the source directory.
+# 4. copy the generated amalgamation into the output directory (./sqlite3).
+# 5. export the defined compile-time options to a gyp file (./defines.gypi).
+# 6. update the docs (../docs/compilation.md) with details of this distribution.
+#
+# When a user builds better-sqlite3, the following steps are taken:
+# 1. node-gyp loads the previously exported compile-time options (defines.gypi).
+# 2. the copy.js script copies the bundled amalgamation into the build folder.
+# 3. node-gyp compiles the copied sqlite3.c along with better_sqlite3.cpp.
+# 4. node-gyp links the two resulting binaries to generate better_sqlite3.node.
+# ===
+
+CHECKIN="d2d954d4"
+
+# Defines below are sorted alphabetically
+DEFINES="
+HAVE_INT16_T=1
+HAVE_INT32_T=1
+HAVE_INT8_T=1
+HAVE_STDINT_H=1
+HAVE_UINT16_T=1
+HAVE_UINT32_T=1
+HAVE_UINT8_T=1
+HAVE_USLEEP=1
+SQLITE_DEFAULT_CACHE_SIZE=-16000
+SQLITE_DEFAULT_FOREIGN_KEYS=1
+SQLITE_DEFAULT_MEMSTATUS=0
+SQLITE_DEFAULT_WAL_SYNCHRONOUS=1
+SQLITE_DQS=0
+SQLITE_ENABLE_COLUMN_METADATA
+SQLITE_ENABLE_DBSTAT_VTAB
+SQLITE_ENABLE_DESERIALIZE
+SQLITE_ENABLE_FTS3
+SQLITE_ENABLE_FTS3_PARENTHESIS
+SQLITE_ENABLE_FTS4
+SQLITE_ENABLE_FTS5
+SQLITE_ENABLE_GEOPOLY
+SQLITE_ENABLE_JSON1
+SQLITE_ENABLE_MATH_FUNCTIONS
+SQLITE_ENABLE_RTREE
+SQLITE_ENABLE_STAT4
+SQLITE_ENABLE_UPDATE_DELETE_LIMIT
+SQLITE_LIKE_DOESNT_MATCH_BLOBS
+SQLITE_OMIT_DEPRECATED
+SQLITE_OMIT_PROGRESS_CALLBACK
+SQLITE_OMIT_SHARED_CACHE
+SQLITE_OMIT_TCL_VARIABLE
+SQLITE_SOUNDEX
+SQLITE_THREADSAFE=2
+SQLITE_TRACE_SIZE_LIMIT=32
+SQLITE_USE_URI=0
+SQLITE_OMIT_LOAD_EXTENSION
+"
+
+# ========== START SCRIPT ========== #
+
+echo "setting up environment..."
+DEPS="$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)"
+TEMP="$DEPS/temp"
+OUTPUT="$DEPS/sqlite3"
+rm -rf "$TEMP"
+rm -rf "$OUTPUT"
+mkdir -p "$TEMP"
+mkdir -p "$OUTPUT"
+export CFLAGS=`echo $(echo "$DEFINES" | sed -e "/^\s*$/d" -e "s/^/-D/")`
+
+echo "downloading source..."
+curl -#f "https://sqlite.org/src/zip/$CHECKIN/SQLite-$CHECKIN.zip" > "$TEMP/source.zip" || exit 1
+
+echo "extracting source..."
+unzip "$TEMP/source.zip" -d "$TEMP" > /dev/null || exit 1
+cd "$TEMP/SQLite-$CHECKIN" || exit 1
+
+echo "configuring amalgamation..."
+sh configure > /dev/null || exit 1
+
+echo "building amalgamation..."
+make sqlite3.c > /dev/null || exit 1
+
+echo "copying amalgamation..."
+cp sqlite3.c sqlite3.h sqlite3ext.h shell.c "$OUTPUT/" || exit 1
+
+echo "applying patches..."
+cd "$DEPS" || exit 1
+for patch in patches/*.patch; do
+  # If a patch fails, just skip it an move on.
+  # By default `patch` tries to be clever and reverse the patch, so we have to specify `--forward`.
+  # If the patch fails, we # don't write .orig and .rej files, so we have to specify `--no-backup-if-mismatch` and `--reject-file=-`.
+  patch --batch --forward --no-backup-if-mismatch --reject-file=- -p2 < "$patch"
+done
+
+echo "updating gyp configs..."
+GYP="$DEPS/defines.gypi"
+printf "# THIS FILE IS AUTOMATICALLY GENERATED BY deps/download.sh (DO NOT EDIT)\n\n{\n  'defines': [\n" > "$GYP"
+printf "$DEFINES" | sed -e "/^\s*$/d" -e "s/\(.*\)/    '\1',/" >> "$GYP"
+printf "  ],\n}\n" >> "$GYP"
+
+echo "updating docs..."
+DOCS="$DEPS/../docs/compilation.md"
+MAJOR=`expr "${VERSION:0:1}" + 0`
+MINOR=`expr "${VERSION:1:2}" + 0`
+PATCH=`expr "${VERSION:3:2}" + 0`
+sed -Ei.bak -e "s/version [0-9]+\.[0-9]+\.[0-9]+/version $MAJOR.$MINOR.$PATCH/g" "$DOCS"
+sed -i.bak -e "/^SQLITE_/,\$d" "$DOCS"
+sed -i.bak -e "/^HAVE_/,\$d" "$DOCS"
+rm "$DOCS".bak
+printf "$DEFINES" | sed -e "/^\s*$/d" >> "$DOCS"
+printf "\`\`\`\n" >> "$DOCS"
+
+echo "cleaning up..."
+cd - > /dev/null || exit 1
+rm -rf "$TEMP"
+
+echo "done!"

package/deps/patches/1208.patch

@@ -0,0 +1,15 @@
+diff --git a/deps/sqlite3/sqlite3.c b/deps/sqlite3/sqlite3.c
+index b1a807f..38bd1e6 100644
+--- a/deps/sqlite3/sqlite3.c
++++ b/deps/sqlite3/sqlite3.c
+@@ -24887,8 +24887,8 @@ static const struct {
+   /* 1 */ { 6, "minute",   7.7379e+12,        60.0  },
+   /* 2 */ { 4, "hour",     1.2897e+11,      3600.0  },
+   /* 3 */ { 3, "day",      5373485.0,      86400.0  },
+-  /* 4 */ { 5, "month",    176546.0,  30.0*86400.0  },
+-  /* 5 */ { 4, "year",     14713.0,  365.0*86400.0  },
++  /* 4 */ { 5, "month",    176546.0,     2592000.0  },
++  /* 5 */ { 4, "year",     14713.0,     31536000.0  },
+ };
+ 
+ /*