@atscript/db-mysql 0.1.140 → 0.1.142

package/dist/index.cjs

@@ -94,9 +94,17 @@ function mysqlIndexPrefix(mappedType, bytesPerChar) {
 *    required default-less column on `add`;
 * 5. COLLATE (native `@db.mysql.collate` or portable `@db.column.collate`);
 * 6. ON UPDATE.
+*
+* A `@db.column.derived` field (since 0.1.141) renders as a VIRTUAL generated
+* column — `type [COLLATE …] GENERATED ALWAYS AS (<json extraction>) VIRTUAL`
+* — with no nullability, DEFAULT, AUTO_INCREMENT or ON UPDATE, on every purpose.
 */
 function buildColumnDefinition(field, ctx) {
 	const sqlType = ctx.typeMapper?.(field) ?? mysqlTypeFromField(field);
+	if (field.derived) return {
+		def: `${qi(field.physicalName)} ${sqlType}${mysqlCollateClause(field)} GENERATED ALWAYS AS (${(0, _atscript_db_sql_tools.derivedColumnExpr)(mysqlDialect, field)}) VIRTUAL`,
+		inventedDefault: false
+	};
 	const increment = ctx.purpose !== "add" && (ctx.incrementFields?.has(field.physicalName) ?? false);
 	let def = `${qi(field.physicalName)} ${sqlType}`;
 	if (increment) def += " AUTO_INCREMENT";
@@ -112,9 +120,7 @@ function buildColumnDefinition(field, ctx) {
 		def += ` DEFAULT ${mysqlTypeDefault(sqlType, field)}`;
 		inventedDefault = true;
 	}
-	const nativeCollate = field.type?.metadata?.get("db.mysql.collate");
-	if (nativeCollate) def += ` COLLATE ${nativeCollate}`;
-	else if (field.collate) def += ` COLLATE ${collationToMysql(field.collate)}`;
+	def += mysqlCollateClause(field);
 	const onUpdate = ctx.onUpdateFields?.get(field.physicalName);
 	if (onUpdate) def += ` ON UPDATE ${onUpdate}`;
 	return {
@@ -340,6 +346,15 @@ function buildAggregateCount(table, where, controls) {
 /**
 * Maps portable collation values to MySQL collation names.
 */
+/**
+* The `COLLATE` clause of a column (native `@db.mysql.collate`, else the
+* portable `@db.column.collate` mapping) — `""` when none applies.
+*/
+function mysqlCollateClause(field) {
+	const nativeCollate = field.type?.metadata?.get("db.mysql.collate");
+	if (nativeCollate) return ` COLLATE ${nativeCollate}`;
+	return field.collate ? ` COLLATE ${collationToMysql(field.collate)}` : "";
+}
 function collationToMysql(collation) {
 	switch (collation) {
 		case "binary": return "utf8mb4_bin";
@@ -395,7 +410,7 @@ function mysqlTypeFromField(field) {
 			const maxLen = (metadata?.get("expect.maxLength"))?.length;
 			if (maxLen !== void 0 && maxLen <= 65535) return `VARCHAR(${maxLen})`;
 			if (maxLen !== void 0 && maxLen > 65535) return "LONGTEXT";
-			if (field.isPrimaryKey || field.defaultValue) return "VARCHAR(255)";
+			if (field.isPrimaryKey || field.defaultValue || field.derived) return "VARCHAR(255)";
 			return "TEXT";
 		}
 		case "json":
@@ -858,7 +873,7 @@ var MysqlAdapter = class MysqlAdapter extends _atscript_db.BaseDbAdapter {
 	}
 	async updateOne(filter, data, ops, expectedVersion) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const { sql, params } = buildUpdate(this.resolveTableName(), data, where, 1, ops, versionColumn, expectedVersion);
 		this._log(sql, params);
 		const result = await this._wrapConstraintError(() => this._exec().run(sql, params));
@@ -869,7 +884,7 @@ var MysqlAdapter = class MysqlAdapter extends _atscript_db.BaseDbAdapter {
 	}
 	async updateMany(filter, data, ops) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const { sql, params } = buildUpdate(this.resolveTableName(), data, where, void 0, ops, versionColumn);
 		this._log(sql, params);
 		const result = await this._wrapConstraintError(() => this._exec().run(sql, params));
@@ -880,7 +895,7 @@ var MysqlAdapter = class MysqlAdapter extends _atscript_db.BaseDbAdapter {
 	}
 	async replaceOne(filter, data, expectedVersion) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const full = (0, _atscript_db_sql_tools.fillReplacePayload)(data, (0, _atscript_db_sql_tools.replaceColumnsFor)(this._table.fieldDescriptors, this.nativeDefaultFns()), versionColumn);
 		const { sql, params } = buildUpdate(this.resolveTableName(), full, where, 1, void 0, versionColumn, expectedVersion);
 		this._log(sql, params);
@@ -892,7 +907,7 @@ var MysqlAdapter = class MysqlAdapter extends _atscript_db.BaseDbAdapter {
 	}
 	async replaceMany(filter, data) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const { sql, params } = buildUpdate(this.resolveTableName(), data, where, void 0, void 0, versionColumn);
 		this._log(sql, params);
 		const result = await this._wrapConstraintError(() => this._exec().run(sql, params));
@@ -1036,20 +1051,24 @@ var MysqlAdapter = class MysqlAdapter extends _atscript_db.BaseDbAdapter {
 	}
 	/** Live columns of `tableName`, read through `exec` (a held connection, or the pool). */
 	async _readColumns(exec, tableName) {
-		return (await exec.all(`SELECT c.COLUMN_NAME, c.COLUMN_TYPE, c.IS_NULLABLE, c.COLUMN_DEFAULT, c.SRS_ID,
+		return (await exec.all(`SELECT c.COLUMN_NAME, c.COLUMN_TYPE, c.IS_NULLABLE, c.COLUMN_DEFAULT, c.SRS_ID, c.EXTRA,
               (k.COLUMN_NAME IS NOT NULL) AS IS_PK
        FROM INFORMATION_SCHEMA.COLUMNS c
        LEFT JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE k
          ON k.TABLE_SCHEMA = c.TABLE_SCHEMA AND k.TABLE_NAME = c.TABLE_NAME
         AND k.COLUMN_NAME = c.COLUMN_NAME AND k.CONSTRAINT_NAME = 'PRIMARY'
        WHERE c.TABLE_NAME = ? AND c.TABLE_SCHEMA = COALESCE(?, DATABASE())
-       ORDER BY c.ORDINAL_POSITION`, [tableName, this._schema])).map((r) => ({
-			name: r.COLUMN_NAME,
-			type: r.SRS_ID == null ? r.COLUMN_TYPE.toUpperCase() : `${r.COLUMN_TYPE.toUpperCase()} SRID ${r.SRS_ID}`,
-			notnull: r.IS_NULLABLE === "NO",
-			pk: Boolean(Number(r.IS_PK ?? 0)),
-			dflt_value: normalizeMysqlDefault(r.COLUMN_DEFAULT)
-		}));
+       ORDER BY c.ORDINAL_POSITION`, [tableName, this._schema])).map((r) => {
+			const column = {
+				name: r.COLUMN_NAME,
+				type: r.SRS_ID == null ? r.COLUMN_TYPE.toUpperCase() : `${r.COLUMN_TYPE.toUpperCase()} SRID ${r.SRS_ID}`,
+				notnull: r.IS_NULLABLE === "NO",
+				pk: Boolean(Number(r.IS_PK ?? 0)),
+				dflt_value: normalizeMysqlDefault(r.COLUMN_DEFAULT)
+			};
+			if (/\b(VIRTUAL|STORED) GENERATED\b/i.test(r.EXTRA ?? "")) column.generated = true;
+			return column;
+		});
 	}
 	async syncColumns(diff) {
 		return this._withStrictSession(async (conn) => {
@@ -1120,7 +1139,7 @@ var MysqlAdapter = class MysqlAdapter extends _atscript_db.BaseDbAdapter {
 				this._log(createSql);
 				await conn.exec(createSql);
 				const oldCols = (await this._readColumns(conn, this._table.tableName)).map((c) => c.name);
-				const newCols = this._table.fieldDescriptors.filter((f) => !f.ignored).map((f) => f.physicalName);
+				const newCols = this._table.storedDescriptors.map((f) => f.physicalName);
 				const oldColSet = new Set(oldCols);
 				const commonCols = newCols.filter((c) => oldColSet.has(c));
 				if (commonCols.length > 0) {

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { ALL_AGGREGATE_FNS, ALL_BUCKET_UNITS, BaseDbAdapter, DbError, DbSpace, bucketTimeZoneUnavailable } from "@atscript/db";
 import { resolveAggregateSearch } from "@atscript/db/agg";
-import { buildAggregateCount, buildAggregateSelect, buildCreateView, buildDelete, buildGeoSearchCount, buildGeoSearchSelect, buildInsert, buildInsertMany, buildSelect, buildUpdate, buildWhere as buildWhere$1, defaultValueForType, defaultValueToSqlLiteral, fillReplacePayload, geoWindowFromControls, insertManyColumns, jsonDollarPath, normalizeGeoPointValue, parseRegexString, refActionToSql, renameGeoDistance, replaceColumnsFor, sqlTimeZoneLiteral, toSqlValue } from "@atscript/db-sql-tools";
+import { buildAggregateCount, buildAggregateSelect, buildCreateView, buildDelete, buildGeoSearchCount, buildGeoSearchSelect, buildInsert, buildInsertMany, buildSelect, buildUpdate, buildWhere as buildWhere$1, defaultValueForType, defaultValueToSqlLiteral, derivedColumnExpr, fillReplacePayload, geoWindowFromControls, insertManyColumns, jsonDollarPath, normalizeGeoPointValue, parseRegexString, refActionToSql, renameGeoDistance, replaceColumnsFor, sqlTimeZoneLiteral, toSqlValue } from "@atscript/db-sql-tools";
 import { BUCKET_MAX_INSTANT, BUCKET_MIN_INSTANT } from "@uniqu/core";
 //#region src/sql-builder.ts
 /** TEXT / BLOB families (`TINYTEXT` … `LONGBLOB`). */
@@ -93,9 +93,17 @@ function mysqlIndexPrefix(mappedType, bytesPerChar) {
 *    required default-less column on `add`;
 * 5. COLLATE (native `@db.mysql.collate` or portable `@db.column.collate`);
 * 6. ON UPDATE.
+*
+* A `@db.column.derived` field (since 0.1.141) renders as a VIRTUAL generated
+* column — `type [COLLATE …] GENERATED ALWAYS AS (<json extraction>) VIRTUAL`
+* — with no nullability, DEFAULT, AUTO_INCREMENT or ON UPDATE, on every purpose.
 */
 function buildColumnDefinition(field, ctx) {
 	const sqlType = ctx.typeMapper?.(field) ?? mysqlTypeFromField(field);
+	if (field.derived) return {
+		def: `${qi(field.physicalName)} ${sqlType}${mysqlCollateClause(field)} GENERATED ALWAYS AS (${derivedColumnExpr(mysqlDialect, field)}) VIRTUAL`,
+		inventedDefault: false
+	};
 	const increment = ctx.purpose !== "add" && (ctx.incrementFields?.has(field.physicalName) ?? false);
 	let def = `${qi(field.physicalName)} ${sqlType}`;
 	if (increment) def += " AUTO_INCREMENT";
@@ -111,9 +119,7 @@ function buildColumnDefinition(field, ctx) {
 		def += ` DEFAULT ${mysqlTypeDefault(sqlType, field)}`;
 		inventedDefault = true;
 	}
-	const nativeCollate = field.type?.metadata?.get("db.mysql.collate");
-	if (nativeCollate) def += ` COLLATE ${nativeCollate}`;
-	else if (field.collate) def += ` COLLATE ${collationToMysql(field.collate)}`;
+	def += mysqlCollateClause(field);
 	const onUpdate = ctx.onUpdateFields?.get(field.physicalName);
 	if (onUpdate) def += ` ON UPDATE ${onUpdate}`;
 	return {
@@ -339,6 +345,15 @@ function buildAggregateCount$1(table, where, controls) {
 /**
 * Maps portable collation values to MySQL collation names.
 */
+/**
+* The `COLLATE` clause of a column (native `@db.mysql.collate`, else the
+* portable `@db.column.collate` mapping) — `""` when none applies.
+*/
+function mysqlCollateClause(field) {
+	const nativeCollate = field.type?.metadata?.get("db.mysql.collate");
+	if (nativeCollate) return ` COLLATE ${nativeCollate}`;
+	return field.collate ? ` COLLATE ${collationToMysql(field.collate)}` : "";
+}
 function collationToMysql(collation) {
 	switch (collation) {
 		case "binary": return "utf8mb4_bin";
@@ -394,7 +409,7 @@ function mysqlTypeFromField(field) {
 			const maxLen = (metadata?.get("expect.maxLength"))?.length;
 			if (maxLen !== void 0 && maxLen <= 65535) return `VARCHAR(${maxLen})`;
 			if (maxLen !== void 0 && maxLen > 65535) return "LONGTEXT";
-			if (field.isPrimaryKey || field.defaultValue) return "VARCHAR(255)";
+			if (field.isPrimaryKey || field.defaultValue || field.derived) return "VARCHAR(255)";
 			return "TEXT";
 		}
 		case "json":
@@ -857,7 +872,7 @@ var MysqlAdapter = class MysqlAdapter extends BaseDbAdapter {
 	}
 	async updateOne(filter, data, ops, expectedVersion) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const { sql, params } = buildUpdate$1(this.resolveTableName(), data, where, 1, ops, versionColumn, expectedVersion);
 		this._log(sql, params);
 		const result = await this._wrapConstraintError(() => this._exec().run(sql, params));
@@ -868,7 +883,7 @@ var MysqlAdapter = class MysqlAdapter extends BaseDbAdapter {
 	}
 	async updateMany(filter, data, ops) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const { sql, params } = buildUpdate$1(this.resolveTableName(), data, where, void 0, ops, versionColumn);
 		this._log(sql, params);
 		const result = await this._wrapConstraintError(() => this._exec().run(sql, params));
@@ -879,7 +894,7 @@ var MysqlAdapter = class MysqlAdapter extends BaseDbAdapter {
 	}
 	async replaceOne(filter, data, expectedVersion) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const full = fillReplacePayload(data, replaceColumnsFor(this._table.fieldDescriptors, this.nativeDefaultFns()), versionColumn);
 		const { sql, params } = buildUpdate$1(this.resolveTableName(), full, where, 1, void 0, versionColumn, expectedVersion);
 		this._log(sql, params);
@@ -891,7 +906,7 @@ var MysqlAdapter = class MysqlAdapter extends BaseDbAdapter {
 	}
 	async replaceMany(filter, data) {
 		const where = buildWhere(filter);
-		const versionColumn = this._table.versionColumn;
+		const versionColumn = this._table.versionColumnPhysical;
 		const { sql, params } = buildUpdate$1(this.resolveTableName(), data, where, void 0, void 0, versionColumn);
 		this._log(sql, params);
 		const result = await this._wrapConstraintError(() => this._exec().run(sql, params));
@@ -1035,20 +1050,24 @@ var MysqlAdapter = class MysqlAdapter extends BaseDbAdapter {
 	}
 	/** Live columns of `tableName`, read through `exec` (a held connection, or the pool). */
 	async _readColumns(exec, tableName) {
-		return (await exec.all(`SELECT c.COLUMN_NAME, c.COLUMN_TYPE, c.IS_NULLABLE, c.COLUMN_DEFAULT, c.SRS_ID,
+		return (await exec.all(`SELECT c.COLUMN_NAME, c.COLUMN_TYPE, c.IS_NULLABLE, c.COLUMN_DEFAULT, c.SRS_ID, c.EXTRA,
               (k.COLUMN_NAME IS NOT NULL) AS IS_PK
        FROM INFORMATION_SCHEMA.COLUMNS c
        LEFT JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE k
          ON k.TABLE_SCHEMA = c.TABLE_SCHEMA AND k.TABLE_NAME = c.TABLE_NAME
         AND k.COLUMN_NAME = c.COLUMN_NAME AND k.CONSTRAINT_NAME = 'PRIMARY'
        WHERE c.TABLE_NAME = ? AND c.TABLE_SCHEMA = COALESCE(?, DATABASE())
-       ORDER BY c.ORDINAL_POSITION`, [tableName, this._schema])).map((r) => ({
-			name: r.COLUMN_NAME,
-			type: r.SRS_ID == null ? r.COLUMN_TYPE.toUpperCase() : `${r.COLUMN_TYPE.toUpperCase()} SRID ${r.SRS_ID}`,
-			notnull: r.IS_NULLABLE === "NO",
-			pk: Boolean(Number(r.IS_PK ?? 0)),
-			dflt_value: normalizeMysqlDefault(r.COLUMN_DEFAULT)
-		}));
+       ORDER BY c.ORDINAL_POSITION`, [tableName, this._schema])).map((r) => {
+			const column = {
+				name: r.COLUMN_NAME,
+				type: r.SRS_ID == null ? r.COLUMN_TYPE.toUpperCase() : `${r.COLUMN_TYPE.toUpperCase()} SRID ${r.SRS_ID}`,
+				notnull: r.IS_NULLABLE === "NO",
+				pk: Boolean(Number(r.IS_PK ?? 0)),
+				dflt_value: normalizeMysqlDefault(r.COLUMN_DEFAULT)
+			};
+			if (/\b(VIRTUAL|STORED) GENERATED\b/i.test(r.EXTRA ?? "")) column.generated = true;
+			return column;
+		});
 	}
 	async syncColumns(diff) {
 		return this._withStrictSession(async (conn) => {
@@ -1119,7 +1138,7 @@ var MysqlAdapter = class MysqlAdapter extends BaseDbAdapter {
 				this._log(createSql);
 				await conn.exec(createSql);
 				const oldCols = (await this._readColumns(conn, this._table.tableName)).map((c) => c.name);
-				const newCols = this._table.fieldDescriptors.filter((f) => !f.ignored).map((f) => f.physicalName);
+				const newCols = this._table.storedDescriptors.map((f) => f.physicalName);
 				const oldColSet = new Set(oldCols);
 				const commonCols = newCols.filter((c) => oldColSet.has(c));
 				if (commonCols.length > 0) {

package/dist/plugin.cjs

@@ -14,6 +14,7 @@ const annotations = {
 	engine: new _atscript_core.AnnotationSpec({
 		description: "Specifies the MySQL storage engine.\n\n**Default:** `\"InnoDB\"`\n\n```atscript\n@db.mysql.engine \"MyISAM\"\nexport interface Logs { ... }\n```",
 		nodeType: ["interface"],
+		passedWhenReferred: false,
 		multiple: false,
 		argument: {
 			name: "engine",

package/dist/plugin.mjs

@@ -13,6 +13,7 @@ const annotations = {
 	engine: new AnnotationSpec({
 		description: "Specifies the MySQL storage engine.\n\n**Default:** `\"InnoDB\"`\n\n```atscript\n@db.mysql.engine \"MyISAM\"\nexport interface Logs { ... }\n```",
 		nodeType: ["interface"],
+		passedWhenReferred: false,
 		multiple: false,
 		argument: {
 			name: "engine",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atscript/db-mysql",
-  "version": "0.1.140",
+  "version": "0.1.142",
   "description": "MySQL adapter for @atscript/db with mysql2 driver support.",
   "keywords": [
     "atscript",
@@ -41,19 +41,19 @@
     "access": "public"
   },
   "devDependencies": {
-    "@atscript/core": "^0.1.92",
-    "@atscript/typescript": "^0.1.92",
+    "@atscript/core": "^0.1.95",
+    "@atscript/typescript": "^0.1.95",
     "@uniqu/core": "^0.1.11",
     "mysql2": "^3.11.0",
-    "unplugin-atscript": "^0.1.92"
+    "unplugin-atscript": "^0.1.95"
   },
   "peerDependencies": {
-    "@atscript/core": "^0.1.92",
-    "@atscript/typescript": "^0.1.92",
+    "@atscript/core": "^0.1.95",
+    "@atscript/typescript": "^0.1.95",
     "@uniqu/core": "^0.1.11",
     "mysql2": ">=3.0.0",
-    "@atscript/db": "^0.1.140",
-    "@atscript/db-sql-tools": "^0.1.140"
+    "@atscript/db": "^0.1.142",
+    "@atscript/db-sql-tools": "^0.1.142"
   },
   "peerDependenciesMeta": {
     "mysql2": {