@simtlix/simfinity-postgres 3.7.0 → 3.9.0

package/README.md

@@ -31,7 +31,7 @@ import { postgresPlugin } from '@simtlix/simfinity-postgres';
 const simfinity = createSQL({ plugin: postgresPlugin({ pool, schema: 'library' }) });
 ```
 
-Install `@simtlix/simfinity-sql@3.7.0` as a direct dependency when importing its factory. PostgreSQL 15 or later is the only supported SQL plugin. The [SQL package guide](https://github.com/simtlix/simfinity.js/tree/master/packages/sql) documents relational planning and the versioned plugin contract.
+Install `@simtlix/simfinity-sql@3.9.0` as a direct dependency when importing its factory. PostgreSQL 15 or later is the only supported SQL plugin. The [SQL package guide](https://github.com/simtlix/simfinity.js/tree/master/packages/sql) documents relational planning and the versioned plugin contract.
 
 Both factories permanently bind one pool and schema, and five optional settings: `multiRowInserts: false` keeps one `INSERT` per owned row instead of multi-row statements; `explicitNullsOrder: true` keeps the `NULLS` clause on sorts of `id` and required fields, as 3.5.9 did, instead of letting indexes serve them; `batchedCollections: true` reads the generated collection fields of the parents that share their arguments with one statement per 100 parents, in a transaction that turns JIT off for that transaction only, instead of one statement per field as 3.6.0 did and as the default still does, and can return unsorted and tied rows in another order; the opt-in `refreshTriggers: 'perRoot'` refreshes each changed root's owned shape and unique keys once per transaction, while its guard trigger stays deferred, instead of once per changed row; and the opt-in `ownerIndexes: 'minimal'` leaves out the `(__owner_id)` indexes that the primary key or a unique index covers on new owned and guard tables. An unknown `refreshTriggers` or `ownerIndexes` value throws `INVALID_DATABASE_SCHEMA` (400). Read the [upgrade notes](https://simtlix.github.io/simfinity.js/resources/compatibility.html#upgrade-to-3-6-0) before enabling the opt-ins: versions up to 3.5.9 cannot validate databases created with them. The returned runtime supports registration, generated queries and mutations, middleware and scopes, controllers and validators, custom mutations, state machines, nested relationship writes, embedded reconstruction, and native PostgreSQL model handles. Native handles expose `findById`, `find`, `create`, `update`, and `delete`; they are not Mongoose models. `find(args, { session })` accepts the generated GraphQL list query arguments. Existing `pg.Pool` configuration and `pg.PoolClient` query interfaces remain compatible across both factories. A custom pool or client wrapper should pass `pg`'s `command` through in query results: the plugin reads it from the `COMMIT` result to detect a transaction that PostgreSQL rolled back because one of its statements failed, and without it such a transaction reports success with nothing stored.
 
@@ -62,7 +62,7 @@ The module and every `createPostgres` instance expose the shared `auth`, `valida
 MCP integration is an independent opt-in and does not add MCP dependencies to PostgreSQL applications:
 
 ```sh
-npm install @simtlix/simfinity-mcp@3.7.0 @modelcontextprotocol/sdk@^1.31.0
+npm install @simtlix/simfinity-mcp@3.9.0 @modelcontextprotocol/sdk@^1.31.0
 ```
 
 ```javascript
@@ -77,13 +77,17 @@ Entity identities and references use UUIDs. Scalars use native PostgreSQL types,
 
 Queries support nested scalar/reference paths, logical filter groups, scopes, sort, pagination, count, and grouped `SUM`, `COUNT`, `AVG`, `MIN`, and `MAX` facts. The PostgreSQL implementation preserves root multiplicity when joining collection paths.
 
+The text operators take literal values as bound parameters. `LIKE`, `STARTS_WITH` and `ENDS_WITH` compare code points, and `STARTS_WITH` can use a column's btree index. `ILIKE`, `ISTARTS_WITH`, `IENDS_WITH` and `IEQ` fold both sides with the Unicode simple case foldings that MongoDB's case-insensitive matching applies, through one expression, `translate(lower((x) COLLATE "pg_catalog"."und-x-icu"), from, to)`, where `translate()` maps the 22 lowercase variants that ICU `lower()` keeps, such as `ſ`, `µ` and the final sigma `ς`, to their usual letters; so each returns every row that its case-sensitive form returns, and `ISTARTS_WITH "ΚΑΣ"` finds `ΚΑΣΤΡΟ`. The first three match a `LIKE` pattern whose `%`, `_` and `\` are escaped. The two backends still differ on `İ`, which ICU lowers to `i` followed by U+0307, and on letters newer than one side's Unicode tables. The fold needs a `UTF8` database on a server built with ICU: on another, such as one in `LATIN1`, these four operators fail with `UNSUPPORTED_QUERY` (400), and every other operation works. Indexes serve them only on exactly the compiled expression, which the exported `caseFoldExpression(sqlExpression)` returns, such as `caseFoldExpression('"name"')`: a btree with `text_pattern_ops` on it serves `IEQ` and `ISTARTS_WITH`, and a `pg_trgm` GIN index with `gin_trgm_ops` serves `ILIKE`, `ISTARTS_WITH` and `IENDS_WITH`. The [queries guide](https://simtlix.github.io/simfinity.js/guide/queries.html#case-folding) gives the details and the index statements.
+
 Errors that PostgreSQL reports become `SimfinityError`s without SQL details, with the driver error as `getCause()`; errors that application code throws propagate unchanged. Text cannot contain NUL and native date-times start at 4714-11-24 BC: such input fails with `INVALID_VALUE` (400).
 
 PostgreSQL enforces required values, real FKs, JSONB/owned embedded shapes, root and embedded scalar/reference uniqueness, and scalar-list multikey uniqueness. Root unique indexes use `NULLS NOT DISTINCT`; private typed owner-key tables allow repeated keys within one owner but reject the same key across owners. Presence markers preserve missing versus explicit null fields. This is stronger and broader than generated Mongoose storage.
 
+Virtual fields (`extensions.virtual`), on entities and on members of embedded values, have no storage: no column, presence marker, check, JSON validation function, owned table, index or foreign key, and any output type works as their result. Adding one to a deployed type is therefore not a schema change. A field that a database already stores and that becomes virtual leaves its storage behind, so initialization keeps failing with `SCHEMA_MISMATCH` until the database is migrated. When the leftover is a column named after that field, its presence marker or owned-records state, its owned table, a validation or maintenance function of its own column or root, or the owned table of an embedded value whose last member with its own table it was, the error names the field and lists the migration. Storage named otherwise is not attributed: the `connectionField` column of a former reference, and the private back-reference column of a former collection in its child's table.
+
 Scalar-list leaves inside nested embedded lists support filters, sorts, ragged group projections, and array-valued facts. Array `MIN`/`MAX` compares complete arrays; result sorting uses immediate extrema. Date parameters use per-query UTC encoding without changing global `pg` behavior.
 
-The following mappings remain unsupported and fail explicitly: implicit many-to-many reciprocal lists, non-embedded collections inside embedded objects, embedded cycles, nested list wrappers, whole embedded-object uniqueness, conflicting relationship metadata, enum values that collide after text conversion, and custom scalars without a recognized base scalar. Query paths cannot sort or group whole embedded objects. Arbitrary MongoDB pipelines and Mongoose-native methods are outside the PostgreSQL contract.
+The following mappings remain unsupported and fail explicitly: implicit many-to-many reciprocal lists, non-embedded collections inside embedded objects, embedded cycles, nested list wrappers, whole embedded-object uniqueness, conflicting relationship metadata, enum values that collide after text conversion, and stored custom scalars without a recognized base scalar. Query paths cannot sort or group whole embedded objects. Arbitrary MongoDB pipelines and Mongoose-native methods are outside the PostgreSQL contract.
 
 ## Low-level schema API
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simtlix/simfinity-postgres",
-  "version": "3.7.0",
+  "version": "3.9.0",
   "description": "PostgreSQL GraphQL runtime and schema generation with foreign keys for Simfinity",
   "type": "module",
   "main": "./src/index.js",
@@ -27,8 +27,8 @@
     "directory": "packages/postgres"
   },
   "dependencies": {
-    "@simtlix/simfinity-core": "3.7.0",
-    "@simtlix/simfinity-sql": "3.7.0",
+    "@simtlix/simfinity-core": "3.9.0",
+    "@simtlix/simfinity-sql": "3.9.0",
     "pg": "^8.16.3"
   },
   "peerDependencies": {

package/src/codecs.js

@@ -1,5 +1,6 @@
 import { getNamedType, isEnumType } from 'graphql';
 import { SimfinityError } from '@simtlix/simfinity-core';
+import { isCaseFoldUnsupported } from './query/case-fold.js';
 
 export const storageTypes = { ID: 'uuid', String: 'text', Enum: 'text', Int: 'integer', Float: 'double precision', Boolean: 'boolean', DateTime: 'timestamp with time zone' };
 export const invalidValue = (message) => { throw new SimfinityError(message, 'INVALID_FILTER_VALUE', 400); };
@@ -69,10 +70,14 @@ export const isRetryableDatabaseError = (error) => ['40001', '40P01'].includes(e
 // An application error that only has a `code`, such as ECONNREFUSED or a domain code, is not one.
 export const isPostgresError = (error) => typeof error?.code === 'string' && /^[0-9A-Z]{5}$/.test(error.code) && typeof error.severity === 'string';
 
+// A statement that folds case on a database that cannot evaluate the fold (see isCaseFoldUnsupported): the request
+// uses an operator that this database cannot run, while every other operation keeps working.
+const CASE_FOLD_UNSUPPORTED = ['ILIKE, ISTARTS_WITH, IENDS_WITH and IEQ need a UTF8 database with the ICU collation und-x-icu', 'UNSUPPORTED_QUERY', 400];
+
 /** Maps PostgreSQL errors (and exhausted retries) without SQL details; returns every other value unchanged. */
 export const normalizeDatabaseError = (error) => {
   if (error instanceof SimfinityError || !(isPostgresError(error) || isRetryableDatabaseError(error))) return error;
-  const normalized = new SimfinityError(...(databaseErrors[error.code] || ['Database operation failed', 'DATABASE_ERROR', 500]));
+  const normalized = new SimfinityError(...(isCaseFoldUnsupported(error) ? CASE_FOLD_UNSUPPORTED : databaseErrors[error.code] || ['Database operation failed', 'DATABASE_ERROR', 500]));
   // Kept for server logging, but non-enumerable as on a native Error, so serializing or spreading the
   // client-facing error never copies the driver's detail, table or constraint.
   Object.defineProperty(normalized, 'cause', { value: error, writable: true, configurable: true, enumerable: false });

package/src/index.js

@@ -5,6 +5,7 @@ import { compileDatabaseSchema as compileSchemaSQL } from './schema/ddl.js';
 import { initializeDatabase as initializeSchema } from './schema/initialize.js';
 
 export { postgresPlugin } from './plugin.js';
+export { caseFoldExpression } from './query/case-fold.js';
 export {
   auth,
   buildErrorFormatter,

package/src/plugin.js

@@ -5,6 +5,7 @@ import { describeRelationalSchema } from './schema/describe.js';
 import { initializeDatabase } from './schema/initialize.js';
 import { compileDatabaseSchema } from './schema/ddl.js';
 import { compileChildrenQuery, compileQuery } from './query/compiler.js';
+import { markCaseFoldFailure } from './query/case-fold.js';
 import { compileRecord, compileRecordBatch, MAX_RECORD_BATCH_VALUES } from './record-statements.js';
 import { castId, encodeScalar, decodeScalar, encodeParameter, isRetryableDatabaseError, normalizeDatabaseError } from './codecs.js';
 
@@ -17,10 +18,18 @@ export const postgresPlugin = (options) => ({
   // singleStatementReads: one statement reads one snapshot at any isolation level, so a read without owned
   // tables needs no repeatable-read transaction.
   capabilities: ['transactions', 'foreignKeys', 'deferredForeignKeys', 'embeddedValues', 'ownedRecords', 'scalarLists', 'uniqueValues', 'nullableUnique', 'singleStatementReads'],
+  // Every filter operator compileQuery and compileChildrenQuery compile, listed one by one so that a later
+  // QLOperator value is rejected until the compiler supports it. The declaration names the compileQuery it describes,
+  // so a copy of this plugin with another compileQuery compiles the operators of 3.7.0 until it declares its own.
+  queryFeatures: {
+    operators: ['EQ', 'NE', 'LT', 'LTE', 'GT', 'GTE', 'BTW', 'IN', 'NIN', 'LIKE', 'ILIKE', 'STARTS_WITH', 'ISTARTS_WITH', 'ENDS_WITH', 'IENDS_WITH', 'IEQ'],
+    compileQuery,
+  },
   naming: { validateIdentifier: identifier, generatedName },
   // The runtime passes its bound configuration: createPostgres(options) or configure(value).
   describeSchema: (plan, configuration) => describeRelationalSchema(plan, { refreshTriggers: configuration?.refreshTriggers, ownerIndexes: configuration?.ownerIndexes }),
-  initialize: (configuration, description, initialization) => initializeDatabase(configuration.pool, description, initialization),
+  // `context.virtualFields` locates virtual fields, so that SCHEMA_MISMATCH can name one whose earlier storage is left.
+  initialize: (configuration, description, initialization, context) => initializeDatabase(configuration.pool, description, initialization, context),
   compileSchema: compileDatabaseSchema,
   compileQuery,
   // Optional member: the find statements of many parents in one statement, for findChildrenBatch, which the SQL
@@ -36,7 +45,15 @@ export const postgresPlugin = (options) => ({
     assertConfiguration(configuration) {
       if (!configuration?.pool?.connect || !configuration.pool.query) throw new SimfinityError('Configure a pg.Pool before creating the schema', 'DATABASE_NOT_CONFIGURED', 500);
     },
-    query: (configuration, statement, client) => (client || configuration.pool).query(statement.text, statement.values?.map(encodeParameter)),
+    // The error of a statement that folds case is marked, unchanged, so that normalizeError reports a database that
+    // cannot evaluate the fold as UNSUPPORTED_QUERY.
+    query: async (configuration, statement, client) => {
+      try {
+        return await (client || configuration.pool).query(statement.text, statement.values?.map(encodeParameter));
+      } catch (error) {
+        throw markCaseFoldFailure(statement, error);
+      }
+    },
     acquire: (configuration) => configuration.pool.connect(),
     begin: (client) => client.query('BEGIN ISOLATION LEVEL REPEATABLE READ'),
     // PostgreSQL answers COMMIT with ROLLBACK, and no error, when a statement in the transaction failed

package/src/query/case-fold.js

@@ -0,0 +1,88 @@
+// The case fold of the case-insensitive text operators (ILIKE, ISTARTS_WITH, IENDS_WITH and IEQ), the shared
+// contract of #108 section 3.1: the Unicode simple case foldings that MongoDB's case-insensitive regular expressions
+// apply. lower() under ICU's root collation applies them to every script the same way on every server, whatever the
+// database's default collation (text paths are `C` columns, under which lower() folds ASCII only), except for the
+// lowercase variants below, which it keeps and simple folding maps to another lowercase letter; translate() then
+// maps them. lower() also turns a capital sigma that ends a word into ς and any other into σ, and the value is folded
+// apart from the stored text, so mapping ς to σ also makes a value fold as it does inside the stored text: a value
+// that starts or ends with Σ finds every row that its case-sensitive form finds. The fold is one inline expression,
+// without a database function, so it needs no schema object and no migration, and an application index serves the
+// operators only on exactly this expression, which caseFoldExpression writes.
+
+/**
+ * The one-to-one simple case foldings (CaseFolding.txt, status C) that ICU lower() does not apply and MongoDB 8.0
+ * does, found by comparing both over every code point with a case mapping, on PostgreSQL 16.15 with an ICU of Unicode
+ * 16 and MongoDB 8.0.32: with them, the two differ only on letters newer than MongoDB's Unicode tables. Changing the
+ * list changes every statement and the expression that application indexes must repeat, so it is part of the release
+ * contract.
+ */
+const CASE_FOLD_MAPPINGS = Object.freeze([
+  ['\u00B5', '\u03BC'], // MICRO SIGN, GREEK SMALL LETTER MU
+  ['\u017F', '\u0073'], // LATIN SMALL LETTER LONG S, LATIN SMALL LETTER S
+  ['\u0345', '\u03B9'], // COMBINING GREEK YPOGEGRAMMENI, GREEK SMALL LETTER IOTA
+  ['\u03C2', '\u03C3'], // GREEK SMALL LETTER FINAL SIGMA, GREEK SMALL LETTER SIGMA
+  ['\u03D0', '\u03B2'], // GREEK BETA SYMBOL, GREEK SMALL LETTER BETA
+  ['\u03D1', '\u03B8'], // GREEK THETA SYMBOL, GREEK SMALL LETTER THETA
+  ['\u03D5', '\u03C6'], // GREEK PHI SYMBOL, GREEK SMALL LETTER PHI
+  ['\u03D6', '\u03C0'], // GREEK PI SYMBOL, GREEK SMALL LETTER PI
+  ['\u03F0', '\u03BA'], // GREEK KAPPA SYMBOL, GREEK SMALL LETTER KAPPA
+  ['\u03F1', '\u03C1'], // GREEK RHO SYMBOL, GREEK SMALL LETTER RHO
+  ['\u03F5', '\u03B5'], // GREEK LUNATE EPSILON SYMBOL, GREEK SMALL LETTER EPSILON
+  ['\u1C80', '\u0432'], // CYRILLIC SMALL LETTER ROUNDED VE, CYRILLIC SMALL LETTER VE
+  ['\u1C81', '\u0434'], // CYRILLIC SMALL LETTER LONG-LEGGED DE, CYRILLIC SMALL LETTER DE
+  ['\u1C82', '\u043E'], // CYRILLIC SMALL LETTER NARROW O, CYRILLIC SMALL LETTER O
+  ['\u1C83', '\u0441'], // CYRILLIC SMALL LETTER WIDE ES, CYRILLIC SMALL LETTER ES
+  ['\u1C84', '\u0442'], // CYRILLIC SMALL LETTER TALL TE, CYRILLIC SMALL LETTER TE
+  ['\u1C85', '\u0442'], // CYRILLIC SMALL LETTER THREE-LEGGED TE, CYRILLIC SMALL LETTER TE
+  ['\u1C86', '\u044A'], // CYRILLIC SMALL LETTER TALL HARD SIGN, CYRILLIC SMALL LETTER HARD SIGN
+  ['\u1C87', '\u0463'], // CYRILLIC SMALL LETTER TALL YAT, CYRILLIC SMALL LETTER YAT
+  ['\u1C88', '\uA64B'], // CYRILLIC SMALL LETTER UNBLENDED UK, CYRILLIC SMALL LETTER MONOGRAPH UK
+  ['\u1E9B', '\u1E61'], // LATIN SMALL LETTER LONG S WITH DOT ABOVE, LATIN SMALL LETTER S WITH DOT ABOVE
+  ['\u1FBE', '\u03B9'], // GREEK PROSGEGRAMMENI, GREEK SMALL LETTER IOTA
+]);
+
+const COLLATION = '"pg_catalog"."und-x-icu"';
+// No character of either list is a quote or a backslash, so both are plain string literals.
+const FROM = `'${CASE_FOLD_MAPPINGS.map(([from]) => from).join('')}'`;
+const TO = `'${CASE_FOLD_MAPPINGS.map(([, to]) => to).join('')}'`;
+
+/**
+ * The SQL text that folds `sqlExpression` for the case-insensitive text operators, exactly as the compiler writes it on
+ * both sides of each comparison: `translate(lower((<expression>) COLLATE "pg_catalog"."und-x-icu"), '<22 characters>',
+ * '<their simple case foldings>')`. Applications build their expression indexes with it, such as
+ * `CREATE INDEX ... (${caseFoldExpression('"name"')} text_pattern_ops)`. The expression is trusted SQL, inserted as
+ * given: quote identifiers yourself and never pass request input. It goes in parentheses, because COLLATE binds more
+ * tightly than `->>` and every other binary operator: without them, `"details" ->> 'label'` would collate only
+ * 'label', and an index on that expression would never serve the operators. PostgreSQL keeps no trace of parentheses
+ * in the parse tree, so an expression gives the same index expression with or without parentheses of its own.
+ */
+export const caseFoldExpression = (sqlExpression) => {
+  if (typeof sqlExpression !== 'string' || !sqlExpression.trim()) throw new TypeError('caseFoldExpression expects a non-empty SQL expression string');
+  return `translate(lower((${sqlExpression}) COLLATE ${COLLATION}), ${FROM}, ${TO})`;
+};
+
+// Each statement that folds case contains the list of characters, which a GraphQL name, a generated identifier or a
+// compiled literal never contains, since values are bound parameters.
+const foldsCase = (statement) => typeof statement?.text === 'string' && statement.text.includes(FROM);
+// The errors of statements that fold case, which normalizeDatabaseError reports as unsupported when the database
+// cannot evaluate the fold.
+const failures = new WeakSet();
+
+/**
+ * Records that `error`, which the driver raised for `statement`, comes from a statement that folds case, and returns
+ * it unchanged, so that retries and normalization see the driver's own error.
+ */
+export const markCaseFoldFailure = (statement, error) => {
+  if (error !== null && typeof error === 'object' && foldsCase(statement)) failures.add(error);
+  return error;
+};
+
+/**
+ * Whether the database cannot evaluate the fold of a statement that failed: one whose server encoding lacks the
+ * characters of the fold (22P05, untranslatable character, such as LATIN1, which fails the statement's text before
+ * any row is read, whatever the value), or a server without the ICU collation und-x-icu, built without ICU or with a
+ * database encoding that ICU does not support, such as SQL_ASCII (42704, undefined object). Compiled statements
+ * cannot raise either code otherwise in a UTF8 database with ICU: the collation is their only object that can be
+ * missing, and the database stores no text that UTF8 cannot convert.
+ */
+export const isCaseFoldUnsupported = (error) => failures.has(error) && ['22P05', '42704'].includes(error.code);

package/src/query/compiler.js

@@ -1,9 +1,17 @@
 import { resolveModelPath, SimfinityError } from '@simtlix/simfinity-core';
+import { textQueryOperator, validateTextFilterValue } from '@simtlix/simfinity-core/internal/query-operators';
 import { identifier as q, literal, qualified } from '../schema/sql.js';
 import { encodeScalar, storageTypes, invalidValue } from '../codecs.js';
+import { caseFoldExpression as fold } from './case-fold.js';
 
 const unsupported = (message) => { throw new SimfinityError(message, 'UNSUPPORTED_QUERY', 400); };
 
+// The case-insensitive text operators compare the case fold of both sides (see case-fold.js), so an application
+// index serves them only on that expression, which caseFoldExpression writes.
+// LIKE's default escape character is the backslash, so escaping it, % and _ leaves only literal characters.
+const likeLiteral = (value) => value.replace(/[\\%_]/g, '\\$&');
+const likePatterns = { contains: (value) => `%${likeLiteral(value)}%`, prefix: (value) => `${likeLiteral(value)}%`, suffix: (value) => `%${likeLiteral(value)}` };
+
 // Alias of each per-parent statement in the batched children statement. The per-parent statement only uses t<n>,
 // f<n> and short subquery aliases, so it never shadows this one.
 const CHILDREN = 'simfinity_children';
@@ -207,14 +215,15 @@ const compileSelect = (models, database, plan, extra, configuration, batched) =>
           const sql = arrayFrom(vector, `${name}.value`);
           return { sql: type === 'text' ? `(${sql}) COLLATE "pg_catalog"."C"` : sql, field, type: dateNumeric ? 'double precision' : type, list: true, vector: true, dateNumeric, sortKey };
         }
-        let sql = context.vector ? arrayFrom(context.vector, expression) : expression;
-        if (type === 'text') sql = `(${sql}) COLLATE "pg_catalog"."C"`;
+        // `uncollated` is the value before the C collation, which the case-insensitive text operators replace.
+        const uncollated = context.vector ? arrayFrom(context.vector, expression) : expression;
+        const sql = type === 'text' ? `(${uncollated}) COLLATE "pg_catalog"."C"` : uncollated;
         // A NOT NULL column of the root row has no nulls to place, so its sort needs no NULLS clause and a
         // default-order btree (the primary key or a declared index) can return it in order. Joined and
         // embedded paths can be NULL even for NOT NULL columns, so they keep the clause.
         const notNull = !context.json && !context.vector && !field.list && context.alias === 't0'
           && context.table.columns.find((item) => item.name === (identity ? 'id' : field.storageName))?.nullable === false;
-        return { sql, field: identity ? { ...field, scalar: 'ID' } : field, type: dateNumeric ? 'double precision' : type, list: field.list || !!context.vector, vector: !!context.vector, dateNumeric, sortKey, notNull };
+        return { sql, uncollated, field: identity ? { ...field, scalar: 'ID' } : field, type: dateNumeric ? 'double precision' : type, list: field.list || !!context.vector, vector: !!context.vector, dateNumeric, sortKey, notNull };
       }
     }
     unsupported('Invalid query path');
@@ -266,16 +275,50 @@ const compileSelect = (models, database, plan, extra, configuration, batched) =>
     }
     if (operator === 'BTW') return `(${predicate(expression, 'GTE', value[0], negated)} AND ${predicate(expression, 'LTE', value[1], negated)})`;
     if (value == null || Array.isArray(value)) invalidValue(`${operator} requires a non-null scalar value`);
+    const text = textQueryOperator(operator);
+    if (text) return textPredicate(expression, operator, text, value, negated);
+    const ordering = { LT: '<', LTE: '<=', GT: '>', GTE: '>=' }[operator];
+    if (!ordering && operator !== 'LIKE') unsupported(`Unsupported filter operator ${operator}`);
     const parameter = scalarBind(value);
     const compare = (left) => {
       if (operator === 'LIKE') {
         return `strpos(${left}, ${parameter}) > 0`;
       }
-      return `${left} ${{ LT: '<', LTE: '<=', GT: '>', GTE: '>=' }[operator]} ${parameter}`;
+      return `${left} ${ordering} ${parameter}`;
     };
     if (list) return `EXISTS (SELECT 1 FROM unnest(${sql}) v(value) WHERE ${compare('v.value')})`;
     return negated ? `COALESCE(${compare(sql)}, FALSE)` : compare(sql);
   };
+  /**
+   * The literal text operators (ILIKE, STARTS_WITH, ISTARTS_WITH, ENDS_WITH, IENDS_WITH and IEQ) on a String leaf or
+   * list, where some element must match. Values stay bound parameters. The case-sensitive forms, STARTS_WITH and
+   * ENDS_WITH, compare code points with starts_with and right under the C collation of text paths, so a column's
+   * btree serves STARTS_WITH. The case-insensitive forms compare the case fold of both sides (see case-fold.js): IEQ
+   * with =, the others with LIKE and a bound pattern whose metacharacters are escaped, so that a btree on the folded
+   * column with text_pattern_ops serves IEQ and ISTARTS_WITH, and a trigram index on it serves ILIKE, ISTARTS_WITH and
+   * IENDS_WITH.
+   */
+  const textPredicate = ({ sql, uncollated, field, list }, operator, { match, ignoreCase }, value, negated) => {
+    // createQueryPlan has validated the value; a plan built by hand gets the same INVALID_FILTER_VALUE.
+    validateTextFilterValue(operator, value, field.scalar);
+    let compare;
+    if (!ignoreCase) {
+      const parameter = bind(value, 'text');
+      compare = match === 'prefix'
+        ? (left) => `starts_with(${left}, ${parameter})`
+        : (left) => `right(${left}, char_length(${parameter})) = ${parameter}`;
+    } else if (match === 'exact') {
+      const parameter = bind(value, 'text');
+      compare = (left) => `${fold(left)} = ${fold(parameter)}`;
+    } else {
+      const pattern = bind(likePatterns[match](value), 'text');
+      compare = (left) => `${fold(left)} LIKE ${fold(pattern)}`;
+    }
+    // fold puts its argument in parentheses, so the uncollated value goes in as it is.
+    if (list) return `EXISTS (SELECT 1 FROM unnest(${sql}) v(value) WHERE ${compare('v.value')})`;
+    const left = ignoreCase ? uncollated : sql;
+    return negated ? `COALESCE(${compare(left)}, FALSE)` : compare(left);
+  };
   // A negation reaches every predicate below it, including those nested in AND/OR groups.
   const where = (node, negated = false) => {
     if (!node) return 'TRUE';

package/src/schema/initialize.js

@@ -1,5 +1,5 @@
 import { SimfinityError } from '@simtlix/simfinity-core';
-import { identifier, qualified, generatedName } from './sql.js';
+import { identifier, qualified, generatedName, literal } from './sql.js';
 import { createTableSQL, createForeignKeySQL, createIndexSQL, createFunctionSQL, createTriggerSQL, triggerEvents } from './ddl.js';
 import { maintenanceLayouts, layoutOf, withLayouts } from './constraints.js';
 
@@ -342,8 +342,18 @@ const traverse = async (client, description, catalog, pass, missing, created) =>
   return legacy;
 };
 
-// Names to read from the catalog: the description's, plus the refresh-trigger objects of both layouts.
-const catalogNames = (description, layouts) => {
+// The table that an embedded value holding a virtual member owned while that member was stored, when the description
+// no longer has it: the value then has no member with its own table, so it is stored as JSON.
+const formerOwnedTable = (description, location) => {
+  if (!location.path.length) return null;
+  const name = generatedName(location.table, location.path[0]);
+  return description.tables.some((table) => table.name === name) ? null : name;
+};
+
+// Names to read from the catalog: the description's, plus the refresh-trigger objects of both layouts. With virtual
+// fields, also the touch trigger of each root that owns nothing, and the former owned table of each embedded value
+// that holds one (see formerOwnedTable), which only storage no longer described can leave.
+const catalogNames = (description, layouts, virtualFields) => {
   const functions = new Set((description.functions || []).map((fn) => fn.name));
   const triggers = new Set((description.triggers || []).map((trigger) => trigger.name));
   for (const layout of layouts.values()) {
@@ -352,7 +362,18 @@ const catalogNames = (description, layouts) => {
       for (const trigger of objects.triggers) triggers.add(trigger.name);
     }
   }
-  return { tables: description.tables.map((table) => table.name), functions: [...functions], triggers: [...triggers] };
+  const tables = new Set(description.tables.map((table) => table.name));
+  if (virtualFields.length) {
+    const maintained = new Set((description.maintenance || []).map((item) => item.rootTable));
+    for (const table of description.tables) {
+      if (!table.ownership && !table.auxiliary && !maintained.has(table.name)) triggers.add(generatedName(table.name, 'touch'));
+    }
+    for (const location of virtualFields) {
+      const former = formerOwnedTable(description, location);
+      if (former) tables.add(former);
+    }
+  }
+  return { tables: [...tables], functions: [...functions], triggers: [...triggers] };
 };
 
 // Each maintained root keeps the refresh-trigger layout its database already has: a function or trigger
@@ -412,6 +433,148 @@ const lockRoots = async (client, description, catalog, roots) => {
   if (names.length) await client.query(`LOCK TABLE ${names.map((table) => qualified(description.schema, table.name)).join(', ')} IN SHARE ROW EXCLUSIVE MODE`);
 };
 
+const UPGRADE_NOTES = 'https://simtlix.github.io/simfinity.js/resources/compatibility.html';
+const series = (items) => (items.length < 3 ? items.join(' and ') : `${items.slice(0, -1).join(', ')} and ${items.at(-1)}`);
+// A name longer than PostgreSQL identifiers was never stored, so nothing can refer to it.
+const quotedName = (name) => (Buffer.byteLength(name) <= 63 ? identifier(name) : null);
+
+// The described functions whose bodies could refer to the storage of a virtual field's location: for a member of a
+// JSON value, the validation functions of its column, which the column's shape check calls; for a column, the
+// maintenance functions of its table's root and the functions of that root's triggers. Each set includes the
+// described functions that its functions call.
+const functionOwners = (description) => {
+  const functions = description.functions || [];
+  const called = (text) => functions.filter((fn) => text.includes(qualified(description.schema, fn.name)));
+  const closure = (seeds) => {
+    const names = new Set();
+    const queue = [...seeds];
+    while (queue.length) {
+      const fn = queue.pop();
+      if (names.has(fn.name)) continue;
+      names.add(fn.name);
+      queue.push(...called(fn.body));
+    }
+    return names;
+  };
+  const ofRoot = (table) => {
+    const root = rootOf(description, table);
+    const item = (description.maintenance || []).find((entry) => entry.rootTable === root);
+    const triggered = new Set((description.triggers || []).filter((trigger) => rootOf(description, trigger.table) === root).map((trigger) => trigger.function));
+    return closure(functions.filter((fn) => triggered.has(fn.name) || (item && [item.validateFunction, item.refreshFunction].includes(fn.name))));
+  };
+  const ofColumn = (tableName, column) => {
+    const table = description.tables.find((item) => item.name === tableName);
+    const check = table?.checks.find((item) => item.name === generatedName(tableName, column, 'shape'));
+    return closure(check ? called(check.expression) : []);
+  };
+  return { ofRoot, ofColumn };
+};
+
+// Storage that virtual fields (`extensions.virtual`) left in a database created while they were stored, found in
+// the catalog this run has read, with no further statement: a column of a described table named as such a field's
+// column, presence flag or owned-records state, a described function whose stored body still refers to such a
+// field while its description does not, and the owned table of an embedded value that such a field, as its last
+// member with its own table, made the value own. A state column means the field owned tables, which are dropped. An
+// embedded value that no longer owns a table is stored as JSON instead, which needs a data migration. A root that
+// now owns nothing but still has its refresh triggers loses them and its guard table, since the functions they call
+// refer to the storage being dropped. Only the functions of a field's own column or root are compared (see
+// functionOwners). Returns the explanation, with the migration, that a SCHEMA_MISMATCH appends, or null when
+// nothing is left.
+const virtualLeftovers = (description, catalog, virtualFields) => {
+  const { schema } = description;
+  const maintained = new Set((description.maintenance || []).map((item) => item.rootTable));
+  const owners = functionOwners(description);
+  const left = new Set();
+  const columns = new Map();
+  const owned = [];
+  const moved = new Map();
+  const has = (actual, name) => actual.columns.some((column) => column.name === name);
+  for (const location of virtualFields) {
+    const former = formerOwnedTable(description, location);
+    const table = former && description.tables.find((item) => item.name === location.table);
+    const actual = table && catalog.tables.get(table.name);
+    const ownedActual = former && catalog.tables.get(former);
+    const [value, member = location.name] = location.path;
+    const state = `__${value}_state`;
+    if (!actual || !ownedActual || table.columns.some((column) => column.name === state) || !has(actual, state)) continue;
+    // The member, or the value inside the owned table that holds it, had storage there.
+    if (![member, generatedName('__field', member, 'present'), `__${member}_state`].some((name) => has(ownedActual, name))) continue;
+    left.add(location.field);
+    moved.set(former, { table: table.name, value, state, location });
+  }
+  for (const location of virtualFields.filter((item) => !item.path.length)) {
+    const table = description.tables.find((item) => item.name === location.table);
+    const actual = table && catalog.tables.get(table.name);
+    if (!actual) continue;
+    const state = `__${location.name}_state`;
+    const names = [location.name, generatedName('__field', location.name, 'present'), state].filter((name) => !table.columns.some((column) => column.name === name)
+      && actual.columns.some((column) => column.name === name));
+    if (!names.length) continue;
+    left.add(location.field);
+    columns.set(table.name, [...(columns.get(table.name) || []), ...names]);
+    if (names.includes(state)) owned.push(location);
+  }
+  const statements = [...columns].map(([table, names]) => `ALTER TABLE ${qualified(schema, table)} ${names.map((name) => `DROP COLUMN ${identifier(name)}`).join(', ')};`);
+  const add = (statement) => { if (!statements.includes(statement)) statements.push(statement); };
+  for (const location of owned) add(`DROP TABLE IF EXISTS ${qualified(schema, generatedName(location.table, location.name))} CASCADE;`);
+  for (const [former, { table, value, state }] of moved) {
+    const json = [value, generatedName('__field', value, 'present')].map(identifier).join(' and ');
+    add(`The embedded value ${value} of ${qualified(schema, table)} now has no member with its own table, so it is stored as JSON in the columns ${json} `
+      + `of that table, with the checks and functions that compileDatabaseSchema() gives them, instead of in the table ${qualified(schema, former)}: `
+      + `add them, fill them from the rows of ${qualified(schema, former)}, then drop the column ${identifier(state)} and run DROP TABLE IF EXISTS ${qualified(schema, former)} CASCADE;`);
+  }
+  for (const root of new Set([...columns.keys(), ...[...moved.values()].map((item) => item.table)].map((table) => rootOf(description, table)))) {
+    if (maintained.has(root) || !catalog.triggers(root, generatedName(root, 'touch')).length) continue;
+    for (const suffix of ['touch', 'deferred']) add(`DROP TRIGGER IF EXISTS ${identifier(generatedName(root, suffix))} ON ${qualified(schema, root)};`);
+    add(`DROP TABLE IF EXISTS ${qualified(schema, generatedName(root, 'guard'))};`);
+  }
+  // A column is referred to as `alias."name"`, a member of a JSON value as `($1 -> 'name')`, and a former owned table
+  // by its qualified name.
+  const references = [
+    ...virtualFields.map((location) => ({
+      field: location.field,
+      functions: location.path.length ? owners.ofColumn(location.table, location.path[0]) : owners.ofRoot(location.table),
+      tokens: location.path.length
+        ? [`($1 -> ${literal(location.name)})`]
+        : [location.name, generatedName('__field', location.name, 'present'), `__${location.name}_state`].map(quotedName).filter(Boolean).map((name) => `.${name}`),
+    })),
+    ...[...moved].map(([former, { table, location }]) => ({ field: location.field, functions: owners.ofRoot(table), tokens: [qualified(schema, former)] })),
+  ];
+  const functions = [];
+  for (const fn of description.functions || []) {
+    const rows = catalog.functions(fn.name);
+    if (rows.length !== 1 || rows[0].body === fn.body) continue;
+    const matched = references.filter(({ functions: owned, tokens }) => owned.has(fn.name)
+      && tokens.some((token) => rows[0].body.includes(token) && !fn.body.includes(token)));
+    if (!matched.length) continue;
+    functions.push(qualified(schema, fn.name));
+    for (const { field } of matched) left.add(field);
+  }
+  if (!left.size) return null;
+  const fields = [...new Set(virtualFields.map((item) => item.field))].filter((field) => left.has(field));
+  const many = fields.length > 1;
+  if (functions.length) {
+    statements.push(`Replace ${functions.length > 1 ? 'the functions' : 'the function'} ${series(functions)} with ${functions.length > 1 ? 'their CREATE FUNCTION statements' : 'its CREATE FUNCTION statement'} `
+      + 'from compileDatabaseSchema(), run as CREATE OR REPLACE FUNCTION.');
+  }
+  return `${series(fields)} ${many ? 'are' : 'is'} virtual (extensions.virtual), so ${many ? 'they are' : 'it is'} never stored, but this database still holds ${many ? 'their' : 'its'} `
+    + `earlier storage. Once nothing reads that storage, migrate it: ${statements.join(' ')} See the upgrade notes at ${UPGRADE_NOTES}`;
+};
+// A SCHEMA_MISMATCH of a database that still holds storage of fields that are now virtual also names them.
+const explainMismatch = (error, description, catalog, layouts, virtualFields) => {
+  if (!virtualFields.length || !catalog || !(error instanceof SimfinityError) || error.extensions?.code !== 'SCHEMA_MISMATCH') return error;
+  let resolved = description;
+  // Refresh-trigger objects of two layouts in one root are themselves the mismatch; compare with the description.
+  try { resolved = resolveLayouts(description, catalog, layouts); } catch { /* keep the description */ }
+  try {
+    const explanation = virtualLeftovers(resolved, catalog, virtualFields);
+    return explanation ? new SimfinityError(`${error.message} ${explanation}`, 'SCHEMA_MISMATCH', 409) : error;
+  } catch {
+    // An explanation never replaces the mismatch it explains.
+    return error;
+  }
+};
+
 const backfill = async (client, description, roots) => {
   // The keys of these roots can be stale because maintenance objects were recreated. Their tables are
   // locked; rebuild their complete derived key set before testing owners against one another. Rollback
@@ -430,18 +593,23 @@ const backfill = async (client, description, roots) => {
  * Create missing objects or validate an existing schema; never alter/drop existing storage. The catalog is
  * read in a fixed number of statements without table locks. Create mode changes nothing, and locks nothing,
  * when nothing is missing; otherwise it locks only the tables of roots whose keys it must rebuild.
+ * `context.virtualFields`, which the SQL runtime passes when its types declare virtual fields, lets a
+ * SCHEMA_MISMATCH name such a field whose earlier storage the database still holds, with its migration.
  */
-export const initializeDatabase = async (pool, description, { mode = 'create' } = {}) => {
+export const initializeDatabase = async (pool, description, { mode = 'create' } = {}, context) => {
   if (!['create', 'validate'].includes(mode)) throw new SimfinityError(`Unknown initialization mode: ${mode}`, 'INVALID_INITIALIZATION_MODE', 400);
   const { schema } = description;
   identifier(schema);
   if (schema.startsWith('pg_') || schema === 'information_schema') throw new SimfinityError('System schemas cannot be managed', 'INVALID_DATABASE_SCHEMA', 400);
   const layouts = maintenanceLayouts(description);
-  const names = catalogNames(description, layouts);
+  const virtualFields = Array.isArray(context?.virtualFields) ? context.virtualFields : [];
+  const names = catalogNames(description, layouts, virtualFields);
   const client = await pool.connect();
   const created = [];
   let legacy = [];
   let rollbackError;
+  // The catalog most recently read, which explains a mismatch.
+  let latest = null;
   try {
     await client.query(mode === 'validate' ? 'BEGIN READ ONLY' : 'BEGIN');
     await client.query('SET LOCAL search_path = pg_catalog');
@@ -451,6 +619,7 @@ export const initializeDatabase = async (pool, description, { mode = 'create' }
     // Serializes initializers of this schema before anything is read.
     await client.query('SELECT pg_advisory_xact_lock(hashtextextended($1, 0))', [`simfinity:${schema}`]);
     const inspected = await loadCatalog(client, schema, names);
+    latest = inspected;
     if (mode === 'validate') legacy = await traverse(client, resolveLayouts(description, inspected, layouts), inspected, 'validate', [], created);
     else {
       // Inspect first, without table locks or DDL. Drift before the first missing object is reported as
@@ -468,6 +637,7 @@ export const initializeDatabase = async (pool, description, { mode = 'create' }
         const roots = staleRoots(planned, missing);
         await lockRoots(client, planned, inspected, roots);
         const catalog = await loadCatalog(client, schema, names);
+        latest = catalog;
         const effective = resolveLayouts(description, catalog, layouts);
         const objects = [];
         legacy = await traverse(client, effective, catalog, 'create', objects, created);
@@ -487,7 +657,7 @@ export const initializeDatabase = async (pool, description, { mode = 'create' }
     return { mode, created };
   } catch (error) {
     try { await client.query('ROLLBACK'); } catch (failure) { rollbackError = failure; }
-    throw error;
+    throw explainMismatch(error, description, latest, layouts, virtualFields);
   } finally {
     // A failed ROLLBACK can leave the transaction open; the error makes pg-pool destroy the connection.
     client.release(rollbackError);

package/types/index.d.ts

@@ -32,6 +32,8 @@ export type {
   StateMachine,
   TypePermissions,
   TypeScopes,
+  VirtualFieldDeclaration,
+  VirtualFieldOptions,
 } from '@simtlix/simfinity-core';
 
 export interface DatabaseColumn {
@@ -222,12 +224,18 @@ export interface PostgresRuntime extends Runtime<PostgresModel, PostgresSession>
    * Must be awaited before operations execute. Does not synchronize incompatible schemas. A request rejected before
    * storage is touched, such as an unknown mode (INVALID_INITIALIZATION_MODE, 400) or, on a validation-only runtime,
    * a non-empty mode other than validate (DATABASE_CREATION_DISABLED, 409), keeps the current readiness; a ready runtime keeps serving while it is initialized again, and any failure of the latest
-   * initialization makes it unavailable.
+   * initialization makes it unavailable. When the database still holds storage of a field that is now virtual (`extensions.virtual`), such as its column,
+   * the SCHEMA_MISMATCH (409) message also names the field and gives the migration.
    */
   initializeDatabase(options?: InitializationOptions): Promise<InitializationResult>;
   withTransaction<T>(session: PostgresSession | null | undefined, callback: (session: PostgresSession) => Promise<T> | T): Promise<T>;
 }
-/** PostgreSQL 15+ plugin for createSQL; omitted options allow later runtime.configure. */
+/**
+ * PostgreSQL 15+ plugin for createSQL; omitted options allow later runtime.configure. Its `queryFeatures` lists every
+ * `QLOperator` value. The case-insensitive text operators fold case with {@link caseFoldExpression}, which needs a UTF8
+ * database with the ICU collation `und-x-icu`: on another database, such as one in LATIN1 or on a server built without
+ * ICU, they fail with UNSUPPORTED_QUERY (400), and every other operation works.
+ */
 export function postgresPlugin(options?: PostgresConfiguration): SQLPlugin<
   PostgresConfiguration,
   DatabaseQueryable,
@@ -240,6 +248,17 @@ export function postgresPlugin(options?: PostgresConfiguration): SQLPlugin<
   }
 >;
 export function createPostgres(options?: PostgresConfiguration): PostgresRuntime;
+/**
+ * The SQL text with which ILIKE, ISTARTS_WITH, IENDS_WITH and IEQ fold both sides of their comparison, for an SQL
+ * expression such as a quoted column name or a jsonb member: `translate(lower((<expression>) COLLATE
+ * "pg_catalog"."und-x-icu"), '<22 characters>', '<their simple case foldings>')`, the Unicode simple case foldings that
+ * MongoDB's case-insensitive matching applies. Indexes serve these operators only on exactly this expression, so build
+ * them with it, for example `CREATE INDEX ... (${caseFoldExpression('"name"')} text_pattern_ops)` or
+ * `CREATE INDEX ... (${caseFoldExpression('"details" ->> \'label\'')})`. The expression is inserted as given, in
+ * parentheses, so that COLLATE applies to all of it; pass trusted SQL, never request input. Throws a TypeError for
+ * anything other than a non-empty string.
+ */
+export function caseFoldExpression(sqlExpression: string): string;
 export const configure: PostgresRuntime['configure'];
 export const connect: PostgresRuntime['connect'];
 export const addNoEndpointType: PostgresRuntime['addNoEndpointType'];