jsql-neo 6.4.8 → 6.5.0

package/README.md

@@ -3,7 +3,7 @@
 > **One engine to rule them all** — a Rust-powered embedded database that speaks your language:
 > MySQL, PostgreSQL, MongoDB, Redis, SQL, TypeScript, **and the browser**.
 
-> **v6.4.8** — official release build · [github.com/vexify-org/JSQL-neo](https://github.com/vexify-org/JSQL-neo) · [jsql.vexify.top](https://jsql.vexify.top)
+> **v6.5.0** — official release build · [github.com/vexify-org/JSQL-neo](https://github.com/vexify-org/JSQL-neo) · [jsql.vexify.top](https://jsql.vexify.top)
 
 ![Engines](https://img.shields.io/badge/engines-Native%20%7C%20WASM%20%7C%20Pure%20JS-7ee787)
 ![MySQL](https://img.shields.io/badge/protocol-MySQL%20compatible-1f6feb)
@@ -36,12 +36,18 @@ irm jsql.vexify.top/setup | iex
 npm install jsql-neo
 ```
 
-**JSQL-NEO** is a Rust-powered embedded database with **zero runtime dependencies** that speaks MySQL, PostgreSQL, MongoDB, and Redis wire protocols — all on the same engine, same data, one port. It runs in Node.js, CLI, Web UI, and the browser (WASM).
+**JSQL-NEO** is a Rust-powered embedded database with **zero runtime dependencies**. It runs in Node.js, CLI, Web UI, and the browser (WASM).
 
-- **Any client, same data** — MySQL, PostgreSQL, MongoDB, Redis tools connect simultaneously on **one port**
+- **MySQL wire protocol, ready to use** — `jsql serve` starts it; `mysql2` / most MySQL clients connect directly
 - **Zero dependencies** — no native libs to compile, no system deps to install
-- **Runs everywhere** — Node.js native addon, pure JS fallback, WASM for the browser
-- **~2× faster than better-sqlite3** — Rust core via N-API
+- **Three engines, same API** — `native` (Rust N-API), `wasm` (same Rust core), `js` (pure JS)
+- **~2× faster than better-sqlite3** on indexed point lookups
+
+> **About the other wire protocols** — PostgreSQL, MongoDB and Redis protocol stacks
+> ship as libraries (`lib/pg_server`, `lib/mongo_server`, `lib/redis_server`) and each
+> listens on its own port; there is **no single-port multi-protocol mode**, and the CLI
+> exposes no entry point for them. MongoDB additionally does not yet complete a
+> handshake with the modern official `mongodb` driver. Treat them as experimental.
 
 ---
 
@@ -88,36 +94,35 @@ console.log(rows); // [[1, 'Alice']]
 db.stop();
 ```
 
-### One port, four protocols
+### Wire protocol server
 
 ```bash
-npx jsql-neo serve --port 3306
+jsql serve --port 3306 --data-dir ./data
 ```
 
 ```bash
-# MySQL    mysql -h 127.0.0.1 -P 3306
-# PostgreSQL psql -h 127.0.0.1 -p 3306
-# MongoDB  mongosh mongodb://127.0.0.1:3306
-# Redis    redis-cli -p 3306
+# MySQL clients (mysql CLI, mysql2, DBeaver, DataGrip …) connect here
+mysql -h 127.0.0.1 -P 3306
 ```
 
-All four clients connect to the **same database** on the same port.
+Only MySQL is served by the CLI today. The PostgreSQL / Redis / MongoDB stacks are
+available as libraries — see the note near the top of this file.
 
 ### Browser / WASM
 
 ```js
-import init, { Database } from 'jsql-neo/wasm';
+import init, { JSQL } from 'jsql-neo/wasm/browser.mjs';
 await init();
-const db = new Database(':memory:');
-// same API as Node.js
+const db = new JSQL();
+// same API as the Node.js native client
 ```
 
 ### 🦀 NativeJSQL
 
 Pure Rust native bindings — the highest-performance way to run JSQL-NEO:
 
-- **Zero abstraction overhead** — direct calls into the Rust core
-- **Batch operations** — up to **1.54M rows/sec** peak throughput
+- **Low abstraction overhead** — direct calls into the Rust core
+- **Batch operations** — ~700k rows/sec measured on 200k rows (`INSERT` in 5k batches)
 - **Automatic memory management** with smart caching
 
 **Install:**
@@ -129,8 +134,9 @@ npm install jsql-neo
 **Usage:**
 
 ```javascript
-import { Database } from 'jsql-neo';
-const db = new Database('mydb.jsql');
+const { NativeJSQL } = require('jsql-neo');
+const db = new NativeJSQL();          // :memory: — persist by passing a path
+await db.start();
 ```
 
 ### Storage modes

package/bin/jsql

@@ -5,6 +5,10 @@ const yaggs = require('@vexify-org/yaggs');
 const { ModuleManager } = require('../lib/mod');
 const Database = require('../lib/database');
 const migrate = require('../lib/migrate');
+const { nag, setStarred, readConfig } = require('../lib/star-nag');
+
+// star 提示：任何异常都不该挡住命令本身
+if (!process.env.JSQL_NO_STAR_NAG) { try { nag(); } catch (e) { /* 提示失败与命令无关 */ } }
 
 function printModules(list) {
   if (list.length === 0) {
@@ -168,6 +172,13 @@ const cli = yaggs({ pkg: require('../package.json') })
     console.log(`jsql-neo MySQL server on ${options.host}:${options.port}${options.dataDir ? ' (data: ' + options.dataDir + ')' : ' (in-memory)'}`);
     setInterval(() => {}, 1 << 30);
   })
+  .command('star', 'Show or confirm this repo\'s star status', () => {},
+    async () => {
+      const c = readConfig();
+      console.log('config: ' + require('../lib/star-nag').configPath());
+      console.log('marked starred: ' + (c.starred ? 'yes' : 'no'));
+      console.log('' + require('../lib/star-nag').URL);
+    })
   .command('bench', 'Insert + query benchmark against a data directory', (sub) => {
     sub.option('n', { type: 'number', description: 'Number of rows (default 10000)' });
     sub.option('data-dir', { type: 'string', description: 'Data directory (default :memory:)' });

package/index.js

@@ -1,5 +1,5 @@
 /**
- * JSQL-NEO v6.4.8 — Rust-Powered Embedded Database (WASM + HTTP)
+ * JSQL-NEO v6.5.0 — Rust-Powered Embedded Database (WASM + HTTP)
  *
  * @example
  * const jsql = require('jsql-neo');

package/lib/star-nag.js

@@ -0,0 +1,117 @@
+'use strict';
+/**
+ * CLI 启动时的 star 提示。
+ *
+ * 行为：
+ *   1. 已确认 star 过 → 什么都不说
+ *   2. 距上次提示不足 N 天 → 什么都不说
+ *   3. 否则打印一行提示，并在配置里记下时间
+ *
+ * star 检测：若环境里有 GitHub token（GITHUB_TOKEN / GH_TOKEN），
+ * 就问 GitHub「这个用户 star 过没有」。查到了就记住，以后彻底闭嘴 ——
+ * 用户已经 star 过了，再提就是噪音。
+ *
+ * 配置文件：~/.jsqlmr（JSON）。可用 JSQL_MR_PATH 覆盖。
+ *
+ * 全程不影响命令本身：任何异常都吞掉，绝不因为提示语让 CLI 起不来。
+ */
+
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+const REPO = 'vexify-org/JSQL-neo';
+const URL = `https://github.com/${REPO}`;
+const NAG_INTERVAL_DAYS = 30;
+
+function configPath() {
+  return process.env.JSQL_MR_PATH || path.join(os.homedir(), '.jsqlmr');
+}
+
+function readConfig() {
+  try {
+    const raw = fs.readFileSync(configPath(), 'utf8');
+    const c = JSON.parse(raw);
+    return (c && typeof c === 'object') ? c : {};
+  } catch (e) {
+    return {};                      // 不存在 / 坏了 / 没权限，都当新用户
+  }
+}
+
+function writeConfig(cfg) {
+  try {
+    fs.writeFileSync(configPath(), JSON.stringify(cfg, null, 2) + '\n');
+  } catch (e) {
+    /* 写不了就算了，不该因此报错 */
+  }
+}
+
+/** 同步问一下 GitHub：这个身份 star 过没有。查不到就返回 null（三态）。 */
+function checkStarred() {
+  const token = process.env.GITHUB_TOKEN || process.env.GH_TOKEN;
+  if (!token) return null;          // 没 token，无法确认
+  // 用同步 API：CLI 启动阶段还没有 event loop 可用
+  try {
+    const { execFileSync } = require('child_process');
+    const out = execFileSync('curl', [
+      '-sS', '-m', '3',
+      '-H', `Authorization: Bearer ${token}`,
+      '-H', 'Accept: application/vnd.github+json',
+      '-H', 'X-GitHub-Api-Version: 2022-11-28',
+      `https://api.github.com/user/starred/${REPO}`,
+    ], { stdio: ['ignore', 'pipe', 'ignore'] }).toString();
+    if (out.trim() === '') return true;     // 200 + 空数组 = 列了但没有这个仓库
+    const j = JSON.parse(out);
+    return Array.isArray(j) && j.length > 0;
+  } catch (e) {
+    return null;                  // 网络不通 / 401 / 没装 curl → 不确定
+  }
+}
+
+/**
+ * @param {object} [opts]
+ * @param {NodeJS.WritableStream} [opts.out] 输出流（默认 stdout）
+ * @param {boolean} [opts.force] 忽略节流，强制提示一次
+ * @returns {boolean} 是否真的打印了
+ */
+function nag(opts = {}) {
+  const out = opts.out || process.stdout;
+  const cfg = readConfig();
+
+  if (!opts.force && cfg.starred) return false;
+
+  const last = Number(cfg.lastNagAt) || 0;
+  if (!opts.force && last && Date.now() - last < NAG_INTERVAL_DAYS * 86400000) {
+    // 顺便有机会补记 star 状态（不打印）
+    const s = checkStarred();
+    if (s) { cfg.starred = true; writeConfig(cfg); }
+    return false;
+  }
+
+  // 有 token 就先查，省得对已经 star 的人重复啰嗦
+  const starred = checkStarred();
+  if (starred) {
+    cfg.starred = true;
+    cfg.starredAt = Date.now();
+    writeConfig(cfg);
+    return false;                 // 已 star，闭嘴
+  }
+
+  out.write(`\n  If JSQL-NEO saved you time, a star helps others find it: ${URL}\n`);
+  out.write(`  (set JSQL_NO_STAR_NAG=1 to hide, or star it and it'll stop asking)\n\n`);
+
+  cfg.lastNagAt = Date.now();
+  writeConfig(cfg);
+  return true;
+}
+
+/** 供 `jsql star` 之类的命令用：手动确认 / 取消 */
+function setStarred(v) {
+  const cfg = readConfig();
+  cfg.starred = !!v;
+  if (v) cfg.starredAt = Date.now();
+  writeConfig(cfg);
+  return cfg.starred;
+}
+
+module.exports = { nag, checkStarred, readConfig, setStarred, configPath, REPO, URL };

package/lib/table.js

@@ -146,6 +146,20 @@ class Table {
         this._dateFields = {};       // { fieldName: 'date'|'datetime'|'timestamp' }
 
         for (const [field, def] of Object.entries(schema)) {
+            // schema 字段名归一化：驼峰 primaryKey/autoIncrement 与下划线
+            // primary_key/auto_increment 两种写法都要认。
+            //
+            // 此前这里只认驼峰，而 native_client 在交给 Rust 之前会归一化
+            // （lib/native_client.js 里 primary_key → primaryKey）。结果：
+            // README 与官方示例用的下划线写法，在 native 下正常，在纯 JS 下
+            // **静默失效** —— 自增 id 不生成，find({id:1}) 永远返回空，
+            // 而且不报任何错。这是纯 JS 与 native 的行为分歧。
+            if (def && typeof def === 'object' && !Array.isArray(def)) {
+                if (def.primary_key !== undefined && def.primaryKey === undefined) def.primaryKey = def.primary_key;
+                if (def.auto_increment !== undefined && def.autoIncrement === undefined) def.autoIncrement = def.auto_increment;
+                if (def.primary_key !== undefined) delete def.primary_key;
+                if (def.auto_increment !== undefined) delete def.auto_increment;
+            }
             const isPk = !!(def.primaryKey || def.primary === true);
             if (isPk) this._primaryKey = field;
             if (def.autoIncrement) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsql-neo",
-  "version": "6.4.8",
+  "version": "6.5.0",
   "description": "JSQL-NEO — Rust-powered embedded database with WASM, REST API, B-Tree indexes, WAL, crash recovery",
   "main": "index.js",
   "types": "index.d.ts",

package/test/native.test.js

@@ -151,6 +151,43 @@ function ok(name, cond, extra) {
     await db.stop();
   }
 
+/* ---- schema 字段名下划线写法：两引擎必须一致（静默正确性 bug）---- */
+/*
+ * README 与官方示例用下划线写法（primary_key / auto_increment）。
+ * native_client 交给 Rust 前会归一化，纯 JS 的 table.js 此前不认 ——
+ * 结果纯 JS 下自增 id 根本不生成、find({id:1}) 永远空，且**不报任何错**。
+ */
+{
+  const SNAKE = { id: { type: 'integer', primary_key: true, auto_increment: true }, name: { type: 'string' } };
+
+  // native
+  {
+    const d = new JSQL();
+    await d.start();
+    await d.createTable('snk', SNAKE);
+    await d.insert('snk', [{ name: 'a' }, { name: 'b' }]);
+    await new Promise(r => setTimeout(r, 200));
+    const rows = await d.find('snk', {});
+    const first = rows.find(r => r.name === 'a');
+    ok('schema 下划线写法 · native：自增 id 生成', !!(first && first.id !== undefined), rows);
+    const got = await d.findById('snk', first && first.id);
+    ok('schema 下划线写法 · native：findById 命中', !!(got && got.name === 'a'), got);
+    await d.stop();
+  }
+
+  // pure JS
+  {
+    const Database = require(path.join(ROOT, 'lib', 'database'));
+    const d = new Database(':memory:');
+    await d.createTable('snk', SNAKE);
+    await d.insert('snk', [{ name: 'a' }, { name: 'b' }]);
+    const rows = await d.find('snk', {});
+    const first = rows.find(r => r.name === 'a');
+    ok('schema 下划线写法 · pure-js：自增 id 生成', !!(first && first.id !== undefined), rows);
+    const got = await d.findById('snk', first && first.id);
+    ok('schema 下划线写法 · pure-js：findById 命中', !!(got && got.name === 'a'), got);
+  }
+}
   console.log(`\n${passed} passed, ${failed} failed`);
   process.exit(failed ? 1 : 0);
 })().catch(e => {