@protobase/query 0.0.0-stage → 0.1.0

package/LICENSE

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

package/dist/anchor-positions.js

@@ -0,0 +1,37 @@
+//#region src/anchor-positions.ts
+const comparators = {
+	integer: (a, b) => Number(a) - Number(b),
+	bigint: (a, b) => Number(a) - Number(b),
+	decimal: (a, b) => Number(a) - Number(b),
+	currency: (a, b) => Number(a) - Number(b),
+	date: (a, b) => Date.parse(a) - Date.parse(b),
+	timestamp: (a, b) => Date.parse(a) - Date.parse(b),
+	uuid: (a, b) => a < b ? -1 : a > b ? 1 : 0
+};
+/**
+* Approximate row position of each histogram bound, in ascending sort order.
+* Histogram buckets hold equal shares of the rows that are neither NULL nor most-common values.
+* Most-common values are interleaved by value where the type has a JS ordering that matches Postgres;
+* for other types (text, enum) their rows are not counted below a bound, so positions are less precise.
+*/
+const ascendingAnchors = (stats, totalRows, type) => {
+	const buckets = stats.bounds.length - 1;
+	const compare = comparators[type];
+	const commonShare = stats.commonFrequencies.reduce((sum, frequency) => sum + frequency, 0);
+	const histogramShare = Math.max(0, 1 - stats.nullFraction - commonShare);
+	return stats.bounds.map((value, i) => {
+		const histogramRows = totalRows * histogramShare * i / buckets;
+		const commonRows = compare ? stats.commonValues.reduce((sum, common, j) => compare(common, value) < 0 ? sum + (stats.commonFrequencies[j] ?? 0) * totalRows : sum, 0) : 0;
+		return {
+			position: Math.round(histogramRows + commonRows),
+			value
+		};
+	});
+};
+/** Anchors for a descending sort: same bounds walked from the top, positions measured from the first row. */
+const descendingAnchors = (ascending, totalRows) => ascending.map((anchor) => ({
+	position: Math.max(0, totalRows - anchor.position),
+	value: anchor.value
+})).reverse();
+//#endregion
+export { ascendingAnchors, descendingAnchors };

package/dist/base-query.js

@@ -0,0 +1,26 @@
+import { columnRef, tableSource } from "./columns.js";
+import { compileFilter } from "./compile-filter.js";
+import { fullModelOf, tenantCondition } from "./scope.js";
+import { sql } from "kysely";
+//#region src/base-query.ts
+const softDeleteColumn = (model, name) => {
+	const field = Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
+	return field ? columnRef(field) : sql`${sql.id("t", name)}`;
+};
+/**
+* The table aliased as `t`, minus soft-deleted rows, inside the tenant and the access rule's row filter,
+* narrowed by the user's filter. Every query starts here, so no query can see rows the scope hides.
+*/
+const baseQuery = (db, model, filter, scope) => {
+	const full = fullModelOf(model, scope);
+	const softDelete = full.softDelete ?? model.softDelete;
+	let query = db.selectFrom(tableSource(model));
+	if (softDelete) query = query.where(sql`${softDeleteColumn(full, softDelete)} is null`);
+	const tenant = tenantCondition(model, scope);
+	if (tenant) query = query.where(tenant);
+	if (scope?.rowFilter) query = query.where(compileFilter(full, scope.rowFilter));
+	if (filter) query = query.where(compileFilter(model, filter));
+	return query;
+};
+//#endregion
+export { baseQuery };

package/dist/columns.js

@@ -0,0 +1,26 @@
+import { QueryError } from "./fields/query-error.js";
+import { sql } from "kysely";
+const columnRef = (field) => sql`${sql.id("t", field.column)}`;
+const tableSource = (model) => {
+	const { schema, name } = model.table;
+	const table = schema ? sql.id(schema, name) : sql.id(name);
+	return sql`${table}`.as("t");
+};
+const findField = (model, name) => {
+	const field = Object.hasOwn(model.fields, name) ? model.fields[name] : void 0;
+	if (!field) throw new QueryError("unknown_field", `Unknown field "${name}" on resource "${model.name}"`);
+	return field;
+};
+const requireField = (model, name, capability) => {
+	const field = findField(model, name);
+	if (field[capability]) return field;
+	throw new QueryError(capability === "filterable" ? "not_filterable" : "not_sortable", `Field "${name}" is not ${capability}`);
+};
+/** Primary key entries may name a field or its column. */
+const primaryKeyFields = (model) => model.primaryKey.map((key) => {
+	const field = Object.hasOwn(model.fields, key) ? model.fields[key] : Object.values(model.fields).find((candidate) => candidate.column === key);
+	if (!field) throw new QueryError("unknown_field", `Primary key "${key}" is not a field of "${model.name}"`);
+	return field;
+});
+//#endregion
+export { columnRef, findField, primaryKeyFields, requireField, tableSource };

package/dist/compile-compare.js

@@ -0,0 +1,25 @@
+import { wildcardPattern } from "./fields/text.js";
+import { columnRef } from "./columns.js";
+import { paramFor } from "./field-values.js";
+import { sql } from "kysely";
+//#region src/compile-compare.ts
+const operators = {
+	"=": "=",
+	"!=": "<>",
+	"<": "<",
+	"<=": "<=",
+	">": ">",
+	">=": ">="
+};
+/** `=` and `!=` on text with a `*` in the value become (NOT) ILIKE with the rest escaped. */
+const compileCompare = ({ field, op, value }) => {
+	const col = columnRef(field);
+	if (field.type === "text" && (op === "=" || op === "!=") && value.kind === "string" && value.value.includes("*")) {
+		const pattern = wildcardPattern(value.value);
+		return op === "=" ? sql`${col} ilike ${pattern}` : sql`${col} not ilike ${pattern}`;
+	}
+	return sql`${col} ${sql.raw(operators[op])} ${paramFor(value, field)}`;
+};
+const compileIn = ({ field, values }) => sql`${columnRef(field)} in (${sql.join(values.map((value) => paramFor(value, field)))})`;
+//#endregion
+export { compileCompare, compileIn };

package/dist/compile-filter.d.ts

@@ -0,0 +1,10 @@
+import { Expression, SqlBool } from "kysely";
+import { CheckedFilter, ResourceModel } from "@protobase/schema";
+//#region src/compile-filter.d.ts
+export type CompileOptions = {
+  /** Minimum pg_trgm similarity for `similar`, from 0.3 (the `%` operator's own floor) to 1. */
+  similarityThreshold?: number;
+};
+/** Compiles a checked filter; every user value becomes a bound parameter. */
+export declare const compileFilter: (model: ResourceModel, filter: CheckedFilter, options?: CompileOptions) => Expression<SqlBool>;
+//#endregion

package/dist/compile-filter.js

@@ -0,0 +1,35 @@
+import { jsonHas, jsonPresent } from "./fields/json.js";
+import { QueryError } from "./fields/query-error.js";
+import { columnRef } from "./columns.js";
+import { compileCompare, compileIn } from "./compile-compare.js";
+import { compileRegex, compileSearch, compileSimilar } from "./compile-text-match.js";
+import { sql } from "kysely";
+//#region src/compile-filter.ts
+const defaultSimilarity = .3;
+const combine = (parts, joiner) => {
+	if (parts.length === 0) return sql`${sql.lit(joiner === "and")}`;
+	return sql`(${sql.join(parts, sql` ${sql.raw(joiner)} `)})`;
+};
+const compileNode = (model, node, threshold) => {
+	switch (node.kind) {
+		case "and":
+		case "or": return combine(node.args.map((arg) => compileNode(model, arg, threshold)), node.kind);
+		case "not": return sql`not ${compileNode(model, node.arg, threshold)}`;
+		case "compare": return compileCompare(node);
+		case "in": return compileIn(node);
+		case "has": return jsonHas(columnRef(node.field), node.value);
+		case "present": return node.field.type === "json" ? jsonPresent(columnRef(node.field)) : sql`${columnRef(node.field)} is not null`;
+		case "isNull": return sql`${columnRef(node.field)} is null`;
+		case "regex": return compileRegex(node);
+		case "similar": return compileSimilar(node, threshold);
+		case "search": return compileSearch(model, node);
+	}
+};
+/** Compiles a checked filter; every user value becomes a bound parameter. */
+const compileFilter = (model, filter, options = {}) => {
+	const threshold = options.similarityThreshold ?? defaultSimilarity;
+	if (!(threshold >= defaultSimilarity && threshold <= 1)) throw new QueryError("invalid_option", `similarityThreshold must be between ${defaultSimilarity} and 1`);
+	return compileNode(model, filter, threshold);
+};
+//#endregion
+export { compileFilter };

package/dist/compile-text-match.js

@@ -0,0 +1,48 @@
+import { QueryError } from "./fields/query-error.js";
+import { containsPattern } from "./fields/text.js";
+import { columnRef, findField } from "./columns.js";
+import { sql } from "kysely";
+import { searchTerms } from "@protobase/schema";
+//#region src/compile-text-match.ts
+const maxRegexLength = 200;
+const compileRegex = ({ field, pattern }) => {
+	if (pattern.length > maxRegexLength) throw new QueryError("invalid_value", `Regex patterns are limited to ${maxRegexLength} characters`);
+	return sql`${columnRef(field)} ~* ${pattern}`;
+};
+/**
+* pg_trgm: `%` lets a trigram index prune candidates (it applies the session's default threshold, 0.3),
+* and the explicit similarity() check enforces the requested threshold on top of it.
+*/
+const compileSimilar = ({ field, text }, threshold) => {
+	const col = columnRef(field);
+	return sql`(${col} % ${text} and similarity(${col}, ${text}) >= ${threshold})`;
+};
+/**
+* Partial match across the resource's `search` fields: every whitespace-separated word of the text appears, ignoring
+* case, somewhere in one of them. Each word is an ILIKE per column, so a pg_trgm index on a search column can serve it.
+* A `digitsEnd` field instead matches when its digits end with the word's (spaces, `+` and dashes ignored, and only for
+* words written like phone numbers), or with the whole text's when that is a phone number of several words; a pg_trgm
+* index on `regexp_replace(column, '[^0-9]', '', 'g')` can serve it. `searchTerms` and `matchesSearch` (schema) are the
+* same rules in memory. Text without words matches nothing. A null column is a non-match rather than unknown, so
+* `NOT search(...)` keeps its rows.
+*/
+const compileSearch = (model, { text }) => {
+	const names = model.search ?? [];
+	if (names.length === 0) throw new QueryError("no_search_fields", `Resource "${model.name}" has no search fields; set model.search to use text search`);
+	const terms = searchTerms(text);
+	const words = terms.filter((term) => !term.whole);
+	if (words.length === 0) return sql`false`;
+	const matchesTerm = (term) => {
+		const matches = names.flatMap((name) => {
+			const col = sql`${columnRef(findField(model, name))}::text`;
+			if (model.searchMatch?.[name] === "digitsEnd") return term.digits ? [sql`(${col} is not null and regexp_replace(${col}, '[^0-9]', '', 'g') like ${`%${term.digits}`})`] : [];
+			return term.whole ? [] : [sql`(${col} is not null and ${col} ilike ${containsPattern(term.text)})`];
+		});
+		return matches.length > 0 ? sql`(${sql.join(matches, sql` or `)})` : sql`false`;
+	};
+	const allWords = sql`(${sql.join(words.map(matchesTerm), sql` and `)})`;
+	const whole = terms.find((term) => term.whole);
+	return whole ? sql`(${matchesTerm(whole)} or ${allWords})` : allWords;
+};
+//#endregion
+export { compileRegex, compileSearch, compileSimilar };

package/dist/cursor.js

@@ -0,0 +1,52 @@
+import { QueryError } from "./fields/query-error.js";
+import { sortSignature } from "./sort.js";
+//#region src/cursor.ts
+const invalidCursor = () => new QueryError("invalid_cursor", "Cursor is malformed or does not match the requested sort");
+const isStringList = (value) => Array.isArray(value) && value.every((item) => typeof item === "string");
+const isCellList = (value) => Array.isArray(value) && value.every((item) => item === null || typeof item === "string");
+/**
+* Opaque cursor: the sort signature plus the row's sort values as text (so timestamps and bigints round-trip exactly,
+* null for NULL values). The JSON is UTF-8 encoded before base64url, so any text value survives.
+* `values` may be a prefix of the sort keys; such a boundary cursor is produced by scroll anchors.
+*/
+const encodeCursor = (keys, values) => {
+	const payload = {
+		s: sortSignature(keys).slice(0, values.length),
+		v: values
+	};
+	return toBase64Url(JSON.stringify(payload));
+};
+const decodeCursor = (cursor, keys) => {
+	const payload = parse(cursor);
+	const signature = sortSignature(keys);
+	const prefixOk = payload.s.length === payload.v.length && payload.s.every((part, i) => part === signature[i]);
+	const lengthOk = payload.v.length === keys.length || payload.v.length === 1;
+	if (!prefixOk || !lengthOk) throw invalidCursor();
+	return payload.v;
+};
+const parse = (cursor) => {
+	const payload = parseJson(cursor);
+	if (typeof payload !== "object" || payload === null) throw invalidCursor();
+	const { s, v } = payload;
+	if (!isStringList(s) || !isCellList(v)) throw invalidCursor();
+	return {
+		s,
+		v
+	};
+};
+const toBase64Url = (text) => btoa(String.fromCharCode(...new TextEncoder().encode(text))).replaceAll("+", "-").replaceAll("/", "_").replaceAll("=", "");
+const fromBase64Url = (encoded) => {
+	const binary = atob(encoded.replaceAll("-", "+").replaceAll("_", "/"));
+	return new TextDecoder().decode(Uint8Array.from(binary, (char) => char.charCodeAt(0)));
+};
+/** atob throws DOMException (InvalidCharacterError) and TextDecoder/JSON throw TypeError/SyntaxError on garbage. */
+const parseJson = (cursor) => {
+	try {
+		return JSON.parse(fromBase64Url(cursor));
+	} catch (error) {
+		if (error instanceof SyntaxError || error instanceof TypeError || error instanceof DOMException) throw invalidCursor();
+		throw error;
+	}
+};
+//#endregion
+export { decodeCursor, encodeCursor };

package/dist/db.d.ts

@@ -0,0 +1,5 @@
+import { Kysely } from "kysely";
+//#region src/db.d.ts
+/** The query layer is schema-agnostic: tables come from the resource model, not from generated types. */
+export type Db = Kysely<any>;
+//#endregion

package/dist/db.js

@@ -0,0 +1,5 @@
+//#region src/db.ts
+/** Quotes one identifier for use inside a to_regclass() argument. */
+const quoteIdent = (name) => `"${name.replaceAll("\"", "\"\"")}"`;
+//#endregion
+export { quoteIdent };

package/dist/estimate-count.d.ts

@@ -0,0 +1,10 @@
+import { Db } from "./db.js";
+import { Scope } from "./scope.js";
+import { CheckedFilter, ResourceModel } from "@protobase/schema";
+//#region src/estimate-count.d.ts
+/**
+ * Without a filter (and no soft delete, tenant or row filter to narrow by) this is pg_class.reltuples, which is O(1).
+ * Otherwise, or before the table was ever analyzed, it is the planner's row estimate.
+ */
+export declare const estimateCount: (db: Db, model: ResourceModel, filter?: CheckedFilter, scope?: Scope) => Promise<number>;
+//#endregion

package/dist/estimate-count.js

@@ -0,0 +1,35 @@
+import { fullModelOf } from "./scope.js";
+import { baseQuery } from "./base-query.js";
+import { assertFilterRequirements } from "./filter-requirements.js";
+import { quoteIdent } from "./db.js";
+import { explainPlan } from "./explain.js";
+import { toNumber } from "./numbers.js";
+import { sql } from "kysely";
+//#region src/estimate-count.ts
+/** Planner estimate of the number of live rows matching the filter. */
+const planEstimate = async (db, model, filter, scope) => {
+	await assertFilterRequirements(db, filter, scope);
+	const compiled = baseQuery(db, model, filter, scope).select(sql.lit(1).as("one")).compile();
+	const plan = await explainPlan(db, compiled);
+	return Math.round(plan["Plan Rows"]);
+};
+const tableReltuples = async (db, model) => {
+	const { schema, name } = model.table;
+	const qualified = schema ? `${quoteIdent(schema)}.${quoteIdent(name)}` : quoteIdent(name);
+	const result = await sql`
+    select reltuples::float8 as reltuples from pg_class where oid = to_regclass(${qualified})
+  `.execute(db);
+	return toNumber(result.rows[0]?.reltuples ?? -1);
+};
+/**
+* Without a filter (and no soft delete, tenant or row filter to narrow by) this is pg_class.reltuples, which is O(1).
+* Otherwise, or before the table was ever analyzed, it is the planner's row estimate.
+*/
+const estimateCount = async (db, model, filter, scope) => {
+	const full = fullModelOf(model, scope);
+	if (filter || scope?.rowFilter || full.softDelete || full.tenant || model.softDelete || model.tenant) return planEstimate(db, model, filter, scope);
+	const reltuples = await tableReltuples(db, model);
+	return reltuples >= 0 ? Math.round(reltuples) : planEstimate(db, model);
+};
+//#endregion
+export { estimateCount, planEstimate };

package/dist/exact-count.d.ts

@@ -0,0 +1,7 @@
+import { Db } from "./db.js";
+import { Scope } from "./scope.js";
+import { CheckedFilter, ResourceModel } from "@protobase/schema";
+//#region src/exact-count.d.ts
+/** Runs a real count(*); call only when the user asks for an exact total. */
+export declare const exactCount: (db: Db, model: ResourceModel, filter?: CheckedFilter, scope?: Scope) => Promise<number>;
+//#endregion

package/dist/exact-count.js

@@ -0,0 +1,13 @@
+import { baseQuery } from "./base-query.js";
+import { assertFilterRequirements } from "./filter-requirements.js";
+import { toNumber } from "./numbers.js";
+import { sql } from "kysely";
+//#region src/exact-count.ts
+/** Runs a real count(*); call only when the user asks for an exact total. */
+const exactCount = async (db, model, filter, scope) => {
+	await assertFilterRequirements(db, filter, scope);
+	const row = await baseQuery(db, model, filter, scope).select(sql`count(*)::text`.as("n")).executeTakeFirstOrThrow();
+	return toNumber(row.n);
+};
+//#endregion
+export { exactCount };

package/dist/explain-guard.d.ts

@@ -0,0 +1,21 @@
+import { Db } from "./db.js";
+import { Compilable, CompiledQuery } from "kysely";
+//#region src/explain-guard.d.ts
+export type GuardOptions = {
+  /** A Seq Scan on a table with more rows than this is a finding. */
+  seqScanRows?: number;
+  /** A Sort over more rows than this is a finding. */
+  sortRows?: number;
+};
+export type GuardFinding = {
+  kind: 'seqScan' | 'sort';
+  relation?: string;
+  rows: number;
+};
+export type GuardReport = {
+  ok: boolean;
+  findings: GuardFinding[];
+};
+/** Plans the query (never executes it) and reports expensive nodes (Seq Scan and Parallel Seq Scan). Pass a Kysely query or a compiled one. */
+export declare const explainGuard: (db: Db, query: Compilable<unknown> | CompiledQuery, options?: GuardOptions) => Promise<GuardReport>;
+//#endregion

package/dist/explain-guard.js

@@ -0,0 +1,42 @@
+import { quoteIdent } from "./db.js";
+import { explainPlan, walkPlan } from "./explain.js";
+import { toNumber } from "./numbers.js";
+import { sql } from "kysely";
+//#region src/explain-guard.ts
+const relationRows = async (db, schema, relation, planRows) => {
+	const qualified = schema ? `${quoteIdent(schema)}.${quoteIdent(relation)}` : quoteIdent(relation);
+	const result = await sql`
+    select reltuples::float8 as reltuples from pg_class where oid = to_regclass(${qualified})
+  `.execute(db);
+	const reltuples = toNumber(result.rows[0]?.reltuples ?? -1);
+	return reltuples >= 0 ? reltuples : planRows;
+};
+/** Plans the query (never executes it) and reports expensive nodes (Seq Scan and Parallel Seq Scan). Pass a Kysely query or a compiled one. */
+const explainGuard = async (db, query, options = {}) => {
+	const { seqScanRows = 1e4, sortRows = 1e5 } = options;
+	const compiled = "sql" in query ? query : query.compile();
+	const nodes = walkPlan(await explainPlan(db, compiled));
+	const findings = [];
+	for (const node of nodes) {
+		const type = node["Node Type"];
+		const relation = node["Relation Name"];
+		if (type.endsWith("Seq Scan") && relation) {
+			const rows = await relationRows(db, node.Schema, relation, node["Plan Rows"]);
+			if (rows > seqScanRows) findings.push({
+				kind: "seqScan",
+				relation,
+				rows
+			});
+		}
+		if ((type === "Sort" || type === "Incremental Sort") && node["Plan Rows"] > sortRows) findings.push({
+			kind: "sort",
+			rows: node["Plan Rows"]
+		});
+	}
+	return {
+		ok: findings.length === 0,
+		findings
+	};
+};
+//#endregion
+export { explainGuard };

package/dist/explain.js

@@ -0,0 +1,10 @@
+import { CompiledQuery } from "kysely";
+//#region src/explain.ts
+/** Plans a compiled query without executing it (EXPLAIN, never ANALYZE; VERBOSE adds each relation's schema). */
+const explainPlan = async (db, compiled) => {
+	const output = (await db.executeQuery(CompiledQuery.raw(`EXPLAIN (VERBOSE, FORMAT JSON) ${compiled.sql}`, [...compiled.parameters]))).rows[0]["QUERY PLAN"];
+	return (typeof output === "string" ? JSON.parse(output) : output)[0].Plan;
+};
+const walkPlan = (node) => [node, ...(node.Plans ?? []).flatMap(walkPlan)];
+//#endregion
+export { explainPlan, walkPlan };

package/dist/facet-counts.d.ts

@@ -0,0 +1,16 @@
+import { Db } from "./db.js";
+import { Scope } from "./scope.js";
+import { CheckedFilter, ResourceModel } from "@protobase/schema";
+//#region src/facet-counts.d.ts
+export type FacetOptions = {
+  statementTimeoutMs: number;
+  limit?: number;
+  scope?: Scope;
+};
+export type FacetCount = {
+  value: unknown;
+  count: number;
+};
+/** Counts per value of `field`, with every filter applied except the ones on `field` itself. */
+export declare const facetCounts: (db: Db, model: ResourceModel, field: string, filter: CheckedFilter | undefined, options: FacetOptions) => Promise<FacetCount[]>;
+//#endregion