@query-doctor/core 0.8.1 → 0.8.2

package/dist/sql/analyzer.d.mts

@@ -0,0 +1,112 @@
+'use client';
+
+import { ExportedStats } from "../optimizer/statistics.mjs";
+import { RootIndexCandidate } from "../optimizer/genalgo.mjs";
+import { Nudge } from "./nudges.mjs";
+import { ColumnReferencePart } from "./walker.mjs";
+import { NullTestType, SortByDir, SortByNulls } from "@pgsql/types";
+
+//#region src/sql/analyzer.d.ts
+interface DatabaseDriver {
+  query(query: string, params: unknown[]): Promise<unknown[]>;
+}
+declare const ignoredIdentifier = "__qd_placeholder";
+interface SQLCommenterTag {
+  key: string;
+  value: string;
+}
+type SortContext = {
+  dir: SortByDir;
+  nulls: SortByNulls;
+};
+type DiscoveredColumnReference = {
+  /** How often the column reference appears in the query. */frequency: number;
+  /**
+   * Representation of the column reference exactly
+   * as it appears in the query.
+   */
+  representation: string;
+  /**
+   * Parts of the column reference separated by dots in the query.
+   * The table reference (if it exists) is resolved if the query
+   * uses an alias.
+   *
+   * Has 3 different potential configurations (in theory)
+   * `a.b.c` - a column reference with a table and a schema reference
+   * `a.b` - a column reference with a table reference but no schema
+   * `a` - a column reference with no table reference.
+   *
+   * We use a simple array here to allow parsing of any syntactically correct
+   * but logically incorrect query. The checks happen later when we're deriving
+   * potential indexes from parts of a column reference in `deriveIndexes`
+   */
+  parts: ColumnReferencePart[];
+  /**
+   * Whether the column reference is invalid. This
+   */
+  ignored: boolean; /** The position of the column reference in the query. */
+  position: {
+    start: number;
+    end: number;
+  };
+  /**
+   * A sort direction associated by the column reference.
+   * Only relevant to references from sorts
+   */
+  sort?: SortContext;
+  where?: {
+    nulltest?: NullTestType;
+  };
+  jsonbOperator?: JsonbOperator;
+  jsonbExtraction?: string;
+};
+type JsonbOperator = "@>" | "?" | "?|" | "?&" | "@@" | "@?";
+type StatementType = "select" | "insert" | "update" | "delete" | "other";
+/** A function defined by @pgsql/parser */
+type Parser = (query: string) => Promise<unknown>;
+type TableReference = {
+  schema?: string;
+  table: string;
+};
+type AnalysisResult = {
+  statementType: StatementType;
+  indexesToCheck: DiscoveredColumnReference[];
+  ansiHighlightedQuery: string;
+  referencedTables: TableReference[];
+  shadowedAliases: ColumnReferencePart[];
+  tags: SQLCommenterTag[];
+  queryWithoutTags: string;
+  formattedQueryWithoutTags?: string;
+  nudges: Nudge[];
+};
+type SQLCommenterExtraction = {
+  tags: SQLCommenterTag[];
+  queryWithoutTags: string;
+};
+/**
+ * Analyzes a query and returns a list of column references that
+ * should be indexed.
+ *
+ * This should be instantiated once per analyzed query.
+ */
+declare class Analyzer {
+  private readonly parser;
+  constructor(parser: Parser);
+  analyze(query: string, formattedQuery?: string): Promise<AnalysisResult>;
+  deriveIndexes(tables: ExportedStats[], discovered: DiscoveredColumnReference[], referencedTables: TableReference[]): RootIndexCandidate[];
+  private filterReferences;
+  private hasColumn;
+  private colorizeKeywords;
+  /**
+   * Resolves aliases such as `a.b` to `x.b` if `a` is a known
+   * alias to a table called x.
+   *
+   * Ignores all other combination of parts such as `a.b.c`
+   */
+  private resolveTableAliases;
+  private normalize;
+  private extractSqlcommenter;
+}
+//#endregion
+export { AnalysisResult, Analyzer, DatabaseDriver, DiscoveredColumnReference, JsonbOperator, Parser, SQLCommenterExtraction, SQLCommenterTag, SortContext, StatementType, TableReference, ignoredIdentifier };
+//# sourceMappingURL=analyzer.d.mts.map

package/dist/sql/analyzer.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzer.d.mts","names":[],"sources":["../../src/sql/analyzer.ts"],"mappings":";;;;;;;;;UAmBiB,cAAA;EACf,KAAA,CAAM,KAAA,UAAe,MAAA,cAAoB,OAAA;AAAA;AAAA,cAG9B,iBAAA;AAAA,UAEI,eAAA;EACf,GAAA;EACA,KAAA;AAAA;AAAA,KAGU,WAAA;EACV,GAAA,EAAK,SAAA;EACL,KAAA,EAAO,WAAA;AAAA;AAAA,KAGG,yBAAA;EAZC,2DAcX,SAAA;;;;AAZF;EAiBE,cAAA;;;;AAZF;;;;;;;;;;AAKA;EAsBE,KAAA,EAAO,mBAAA;;;;EAIP,OAAA,WAYgB;EAVhB,QAAA;IACE,KAAA;IACA,GAAA;EAAA;EARF;;;;EAcA,IAAA,GAAO,WAAA;EACP,KAAA;IAAU,QAAA,GAAW,YAAA;EAAA;EACrB,aAAA,GAAgB,aAAA;EAChB,eAAA;AAAA;AAAA,KAGU,aAAA;AAAA,KAEA,aAAA;;KAUA,MAAA,IAAU,KAAA,aAAkB,OAAA;AAAA,KAE5B,cAAA;EACV,MAAA;EACA,KAAA;AAAA;AAAA,KAGU,cAAA;EACV,aAAA,EAAe,aAAA;EACf,cAAA,EAAgB,yBAAA;EAChB,oBAAA;EACA,gBAAA,EAAkB,cAAA;EAClB,eAAA,EAAiB,mBAAA;EACjB,IAAA,EAAM,eAAA;EACN,gBAAA;EACA,yBAAA;EACA,MAAA,EAAQ,KAAA;AAAA;AAAA,KAGE,sBAAA;EACV,IAAA,EAAM,eAAA;EACN,gBAAA;AAAA;;;AAdF;;;;cAuBa,QAAA;EAAA,iBACkB,MAAA;cAAA,MAAA,EAAQ,MAAA;EAC/B,OAAA,CACJ,KAAA,UACA,cAAA,YACC,OAAA,CAAQ,cAAA;EAuGX,aAAA,CACE,MAAA,EAAQ,aAAA,IACR,UAAA,EAAY,yBAAA,IACZ,gBAAA,EAAkB,cAAA,KACjB,kBAAA;EAAA,QAuHK,gBAAA;EAAA,QAmBA,SAAA;EAAA,QAMA,gBAAA;EAtRO;;;;;;EAAA,QA4SP,mBAAA;EAAA,QAkBA,SAAA;EAAA,QAOA,mBAAA;AAAA"}

package/dist/sql/analyzer.mjs

@@ -0,0 +1,240 @@
+"use client";
+import { getNodeKind } from "./ast-utils.mjs";
+import { Walker } from "./walker.mjs";
+import { bgMagentaBright, blue, dim, strikethrough } from "colorette";
+//#region src/sql/analyzer.ts
+const ignoredIdentifier = "__qd_placeholder";
+const STATEMENT_TYPE_MAP = {
+	SelectStmt: "select",
+	InsertStmt: "insert",
+	UpdateStmt: "update",
+	DeleteStmt: "delete"
+};
+/**
+* Analyzes a query and returns a list of column references that
+* should be indexed.
+*
+* This should be instantiated once per analyzed query.
+*/
+var Analyzer = class {
+	constructor(parser) {
+		this.parser = parser;
+	}
+	async analyze(query, formattedQuery) {
+		const ast = await this.parser(query);
+		if (!ast.stmts) throw new Error("Query did not have any statements. This should probably never happen?");
+		const stmt = ast.stmts[0].stmt;
+		if (!stmt) throw new Error("Query did not have any statements. This should probably never happen?");
+		const statementType = STATEMENT_TYPE_MAP[getNodeKind(stmt)] ?? "other";
+		const { highlights, indexRepresentations, indexesToCheck, shadowedAliases, tempTables, tableMappings, nudges } = new Walker(query).walk(stmt);
+		const sortedHighlights = highlights.sort((a, b) => b.position.end - a.position.end);
+		let currQuery = query;
+		for (const highlight of sortedHighlights) {
+			const parts = this.resolveTableAliases(highlight.parts, tableMappings);
+			if (parts.length === 0) {
+				console.error(highlight);
+				throw new Error("Highlight must have at least one part");
+			}
+			let color;
+			let skip = false;
+			if (highlight.ignored) {
+				color = (x) => dim(strikethrough(x));
+				skip = true;
+			} else if (parts.length === 2 && tempTables.has(parts[0].text) && !tableMappings.has(parts[0].text)) {
+				color = blue;
+				skip = true;
+			} else color = bgMagentaBright;
+			const queryRepr = highlight.representation;
+			const queryBeforeMatch = currQuery.slice(0, highlight.position.start);
+			const queryAfterToken = currQuery.slice(highlight.position.end);
+			currQuery = `${queryBeforeMatch}${color(queryRepr)}${this.colorizeKeywords(queryAfterToken, color)}`;
+			const reprKey = highlight.jsonbExtraction ? `${queryRepr}::${highlight.jsonbExtraction}` : queryRepr;
+			if (indexRepresentations.has(reprKey)) skip = true;
+			if (!skip) {
+				indexesToCheck.push(highlight);
+				indexRepresentations.add(reprKey);
+			}
+		}
+		const referencedTables = [];
+		for (const value of tableMappings.values()) if (!value.alias) referencedTables.push({
+			schema: value.schema,
+			table: value.text
+		});
+		const { tags, queryWithoutTags } = this.extractSqlcommenter(query);
+		const formattedQueryWithoutTags = formattedQuery ? this.extractSqlcommenter(formattedQuery).queryWithoutTags : void 0;
+		return {
+			statementType,
+			indexesToCheck,
+			ansiHighlightedQuery: currQuery,
+			referencedTables,
+			shadowedAliases,
+			tags,
+			queryWithoutTags,
+			formattedQueryWithoutTags,
+			nudges
+		};
+	}
+	deriveIndexes(tables, discovered, referencedTables) {
+		/**
+		* There are 3 different kinds of parts a col reference can have
+		* {a} = just a column within context. Find out the table
+		* {a, b} = a column reference with a table reference. There's still ambiguity here
+		* with what the schema could be in case there are 2 tables with the same name in different schemas.
+		* {a, b, c} = a column reference with a table reference and a schema reference.
+		* This is the best case scenario.
+		*/
+		const allIndexes = [];
+		const seenIndexes = /* @__PURE__ */ new Set();
+		function addIndex(index) {
+			const extractionSuffix = index.jsonbExtraction ? `:"${index.jsonbExtraction}"` : "";
+			const key = `"${index.schema}":"${index.table}":"${index.column}"${extractionSuffix}`;
+			if (seenIndexes.has(key)) return;
+			seenIndexes.add(key);
+			allIndexes.push(index);
+		}
+		const matchingTables = this.filterReferences(referencedTables, tables);
+		for (const colReference of discovered) {
+			const partsCount = colReference.parts.length;
+			const columnOnlyReference = partsCount === 1;
+			const tableReference = partsCount === 2;
+			const fullReference = partsCount === 3;
+			if (columnOnlyReference) {
+				const [column] = colReference.parts;
+				const referencedColumn = this.normalize(column);
+				for (const table of matchingTables) {
+					if (!this.hasColumn(table, referencedColumn)) continue;
+					const index = {
+						schema: table.schemaName,
+						table: table.tableName,
+						column: referencedColumn
+					};
+					if (colReference.sort) index.sort = colReference.sort;
+					if (colReference.where) index.where = colReference.where;
+					if (colReference.jsonbOperator) index.jsonbOperator = colReference.jsonbOperator;
+					if (colReference.jsonbExtraction) index.jsonbExtraction = colReference.jsonbExtraction;
+					addIndex(index);
+				}
+			} else if (tableReference) {
+				const [table, column] = colReference.parts;
+				const referencedTable = this.normalize(table);
+				const referencedColumn = this.normalize(column);
+				for (const matchingTable of matchingTables) {
+					if (!this.hasColumn(matchingTable, referencedColumn)) continue;
+					const index = {
+						schema: matchingTable.schemaName,
+						table: referencedTable,
+						column: referencedColumn
+					};
+					if (colReference.sort) index.sort = colReference.sort;
+					if (colReference.where) index.where = colReference.where;
+					if (colReference.jsonbOperator) index.jsonbOperator = colReference.jsonbOperator;
+					if (colReference.jsonbExtraction) index.jsonbExtraction = colReference.jsonbExtraction;
+					addIndex(index);
+				}
+			} else if (fullReference) {
+				const [schema, table, column] = colReference.parts;
+				const index = {
+					schema: this.normalize(schema),
+					table: this.normalize(table),
+					column: this.normalize(column)
+				};
+				if (colReference.sort) index.sort = colReference.sort;
+				if (colReference.where) index.where = colReference.where;
+				if (colReference.jsonbOperator) index.jsonbOperator = colReference.jsonbOperator;
+				if (colReference.jsonbExtraction) index.jsonbExtraction = colReference.jsonbExtraction;
+				addIndex(index);
+			} else {
+				console.error("Column reference has too many parts. The query is malformed", colReference);
+				continue;
+			}
+		}
+		return allIndexes;
+	}
+	filterReferences(referencedTables, tables) {
+		const matchingTables = [];
+		for (const referencedTable of referencedTables) {
+			const refs = tables.filter(({ tableName, schemaName }) => {
+				let schemaMatches = true;
+				if (referencedTable.schema) schemaMatches = schemaName === referencedTable.schema;
+				return schemaMatches && tableName === referencedTable.table;
+			});
+			matchingTables.push(...refs);
+		}
+		return matchingTables;
+	}
+	hasColumn(table, columnName) {
+		return table.columns?.some((column) => column.columnName === columnName) ?? false;
+	}
+	colorizeKeywords(query, color) {
+		return query.replace(/(^\s+)(asc|desc)?(\s+(nulls first|nulls last))?/i, (_, pre, dir, spaceNulls, nulls) => {
+			return `${pre}${dir ? color(dir) : ""}${nulls ? spaceNulls.replace(nulls, color(nulls)) : ""}`;
+		}).replace(/(^\s+)(is (null|not null))/i, (_, pre, nulltest) => {
+			return `${pre}${color(nulltest)}`;
+		});
+	}
+	/**
+	* Resolves aliases such as `a.b` to `x.b` if `a` is a known
+	* alias to a table called x.
+	*
+	* Ignores all other combination of parts such as `a.b.c`
+	*/
+	resolveTableAliases(parts, tableMappings) {
+		if (parts.length !== 2) return parts;
+		const tablePart = parts[0];
+		const mapping = tableMappings.get(tablePart.text);
+		if (mapping) parts[0] = mapping;
+		return parts;
+	}
+	normalize(columnReference) {
+		return columnReference.quoted ? columnReference.text : columnReference.text.toLowerCase();
+	}
+	extractSqlcommenter(query) {
+		const trimmedQuery = query.trimEnd();
+		const startPosition = trimmedQuery.lastIndexOf("/*");
+		const endPosition = trimmedQuery.lastIndexOf("*/");
+		if (startPosition === -1 || endPosition === -1) return {
+			tags: [],
+			queryWithoutTags: trimmedQuery
+		};
+		const afterComment = trimmedQuery.slice(endPosition + 2).trim();
+		if (afterComment && afterComment !== ";") return {
+			tags: [],
+			queryWithoutTags: trimmedQuery
+		};
+		const queryWithoutTags = trimmedQuery.slice(0, startPosition);
+		const tagString = trimmedQuery.slice(startPosition + 2, endPosition).trim();
+		if (!tagString || typeof tagString !== "string") return {
+			tags: [],
+			queryWithoutTags
+		};
+		const tags = [];
+		for (const match of tagString.split(",")) {
+			const [key, value] = match.split("=");
+			if (!key || !value) {
+				if (tags.length > 0) console.warn(`Invalid sqlcommenter tag: ${match} in comment: ${tagString}. Ignoring`);
+				continue;
+			}
+			try {
+				let sliceStart = 0;
+				if (value.startsWith("'")) sliceStart = 1;
+				let sliceEnd = value.length;
+				if (value.endsWith("'")) sliceEnd -= 1;
+				const decoded = decodeURIComponent(value.slice(sliceStart, sliceEnd));
+				tags.push({
+					key: key.trim(),
+					value: decoded
+				});
+			} catch (err) {
+				console.error(err);
+			}
+		}
+		return {
+			tags,
+			queryWithoutTags
+		};
+	}
+};
+//#endregion
+export { Analyzer, ignoredIdentifier };
+
+//# sourceMappingURL=analyzer.mjs.map

package/dist/sql/analyzer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzer.mjs","names":[],"sources":["../../src/sql/analyzer.ts"],"sourcesContent":["import type {\n  NullTestType,\n  ParseResult,\n  SortByDir,\n  SortByNulls,\n} from \"@pgsql/types\";\nimport {\n  bgMagentaBright,\n  blue,\n  type Color,\n  dim,\n  strikethrough,\n} from \"colorette\";\nimport type { RootIndexCandidate } from \"../optimizer/genalgo.js\";\nimport type { ExportedStats } from \"../optimizer/statistics.js\";\nimport { getNodeKind } from \"./ast-utils.js\";\nimport type { Nudge } from \"./nudges.js\";\nimport { ColumnReferencePart, TableMappings, Walker } from \"./walker.js\";\n\nexport interface DatabaseDriver {\n  query(query: string, params: unknown[]): Promise<unknown[]>;\n}\n\nexport const ignoredIdentifier = \"__qd_placeholder\";\n\nexport interface SQLCommenterTag {\n  key: string;\n  value: string;\n}\n\nexport type SortContext = {\n  dir: SortByDir;\n  nulls: SortByNulls;\n};\n\nexport type DiscoveredColumnReference = {\n  /** How often the column reference appears in the query. */\n  frequency: number;\n  /**\n   * Representation of the column reference exactly\n   * as it appears in the query.\n   */\n  representation: string;\n  /**\n   * Parts of the column reference separated by dots in the query.\n   * The table reference (if it exists) is resolved if the query\n   * uses an alias.\n   *\n   * Has 3 different potential configurations (in theory)\n   * `a.b.c` - a column reference with a table and a schema reference\n   * `a.b` - a column reference with a table reference but no schema\n   * `a` - a column reference with no table reference.\n   *\n   * We use a simple array here to allow parsing of any syntactically correct\n   * but logically incorrect query. The checks happen later when we're deriving\n   * potential indexes from parts of a column reference in `deriveIndexes`\n   */\n  parts: ColumnReferencePart[];\n  /**\n   * Whether the column reference is invalid. This\n   */\n  ignored: boolean;\n  /** The position of the column reference in the query. */\n  position: {\n    start: number;\n    end: number;\n  };\n  /**\n   * A sort direction associated by the column reference.\n   * Only relevant to references from sorts\n   */\n  sort?: SortContext;\n  where?: { nulltest?: NullTestType };\n  jsonbOperator?: JsonbOperator;\n  jsonbExtraction?: string;\n};\n\nexport type JsonbOperator = \"@>\" | \"?\" | \"?|\" | \"?&\" | \"@@\" | \"@?\";\n\nexport type StatementType = \"select\" | \"insert\" | \"update\" | \"delete\" | \"other\";\n\nconst STATEMENT_TYPE_MAP: Record<string, StatementType> = {\n  SelectStmt: \"select\",\n  InsertStmt: \"insert\",\n  UpdateStmt: \"update\",\n  DeleteStmt: \"delete\",\n};\n\n/** A function defined by @pgsql/parser */\nexport type Parser = (query: string) => Promise<unknown>;\n\nexport type TableReference = {\n  schema?: string;\n  table: string;\n};\n\nexport type AnalysisResult = {\n  statementType: StatementType;\n  indexesToCheck: DiscoveredColumnReference[];\n  ansiHighlightedQuery: string;\n  referencedTables: TableReference[];\n  shadowedAliases: ColumnReferencePart[];\n  tags: SQLCommenterTag[];\n  queryWithoutTags: string;\n  formattedQueryWithoutTags?: string;\n  nudges: Nudge[];\n};\n\nexport type SQLCommenterExtraction = {\n  tags: SQLCommenterTag[];\n  queryWithoutTags: string;\n};\n\n/**\n * Analyzes a query and returns a list of column references that\n * should be indexed.\n *\n * This should be instantiated once per analyzed query.\n */\nexport class Analyzer {\n  constructor(private readonly parser: Parser) {}\n  async analyze(\n    query: string,\n    formattedQuery?: string,\n  ): Promise<AnalysisResult> {\n    const ast = (await this.parser(query)) as ParseResult;\n    if (!ast.stmts) {\n      throw new Error(\n        \"Query did not have any statements. This should probably never happen?\",\n      );\n    }\n    const stmt = ast.stmts[0].stmt;\n    if (!stmt) {\n      throw new Error(\n        \"Query did not have any statements. This should probably never happen?\",\n      );\n    }\n    const stmtKind = getNodeKind(stmt);\n    const statementType: StatementType =\n      STATEMENT_TYPE_MAP[stmtKind] ?? \"other\";\n    const walker = new Walker(query);\n    const {\n      highlights,\n      indexRepresentations,\n      indexesToCheck,\n      shadowedAliases,\n      tempTables,\n      tableMappings,\n      nudges,\n    } = walker.walk(stmt);\n    const sortedHighlights = highlights.sort(\n      (a, b) => b.position.end - a.position.end,\n    );\n    let currQuery = query;\n    for (const highlight of sortedHighlights) {\n      // our parts might have\n      const parts = this.resolveTableAliases(highlight.parts, tableMappings);\n      if (parts.length === 0) {\n        console.error(highlight);\n        throw new Error(\"Highlight must have at least one part\");\n      }\n      let color: Color;\n      let skip = false;\n      if (highlight.ignored) {\n        color = (x) => dim(strikethrough(x));\n        skip = true;\n      } else if (\n        parts.length === 2 &&\n        tempTables.has(parts[0].text) &&\n        // sometimes temp tables are aliased as existing tables\n        // we don't want to ignore them if they are\n        !tableMappings.has(parts[0].text)\n      ) {\n        color = blue;\n        skip = true;\n      } else {\n        color = bgMagentaBright;\n      }\n      const queryRepr = highlight.representation;\n      const queryBeforeMatch = currQuery.slice(0, highlight.position.start);\n      const queryAfterToken = currQuery.slice(highlight.position.end);\n      currQuery = `${queryBeforeMatch}${color(queryRepr)}${this.colorizeKeywords(\n        queryAfterToken,\n        color,\n      )}`;\n      const reprKey = highlight.jsonbExtraction\n        ? `${queryRepr}::${highlight.jsonbExtraction}`\n        : queryRepr;\n      if (indexRepresentations.has(reprKey)) {\n        skip = true;\n      }\n      if (!skip) {\n        indexesToCheck.push(highlight);\n        indexRepresentations.add(reprKey);\n      }\n    }\n\n    const referencedTables: TableReference[] = [];\n    for (const value of tableMappings.values()) {\n      // aliased mappings are not concrete tables\n      // eg: select * from table t -> t is not a table\n      if (!value.alias) {\n        referencedTables.push({\n          schema: value.schema,\n          table: value.text,\n        });\n      }\n    }\n    const { tags, queryWithoutTags } = this.extractSqlcommenter(query);\n\n    const formattedQueryWithoutTags = formattedQuery\n      ? this.extractSqlcommenter(formattedQuery).queryWithoutTags\n      : undefined;\n\n    return {\n      statementType,\n      indexesToCheck,\n      ansiHighlightedQuery: currQuery,\n      referencedTables,\n      shadowedAliases,\n      tags,\n      queryWithoutTags,\n      formattedQueryWithoutTags,\n      nudges,\n    };\n  }\n\n  deriveIndexes(\n    tables: ExportedStats[],\n    discovered: DiscoveredColumnReference[],\n    referencedTables: TableReference[],\n  ): RootIndexCandidate[] {\n    /**\n     * There are 3 different kinds of parts a col reference can have\n     * {a} = just a column within context. Find out the table\n     * {a, b} = a column reference with a table reference. There's still ambiguity here\n     * with what the schema could be in case there are 2 tables with the same name in different schemas.\n     * {a, b, c} = a column reference with a table reference and a schema reference.\n     * This is the best case scenario.\n     */\n    const allIndexes: RootIndexCandidate[] = [];\n    const seenIndexes = new Set<string>();\n    function addIndex(index: RootIndexCandidate) {\n      const extractionSuffix = index.jsonbExtraction\n        ? `:\"${index.jsonbExtraction}\"`\n        : \"\";\n      const key = `\"${index.schema}\":\"${index.table}\":\"${index.column}\"${extractionSuffix}`;\n      if (seenIndexes.has(key)) {\n        return;\n      }\n      seenIndexes.add(key);\n      allIndexes.push(index);\n    }\n    const matchingTables = this.filterReferences(referencedTables, tables);\n    for (const colReference of discovered) {\n      const partsCount = colReference.parts.length;\n      const columnOnlyReference = partsCount === 1;\n      const tableReference = partsCount === 2;\n      const fullReference = partsCount === 3;\n      if (columnOnlyReference) {\n        // select c from x\n        const [column] = colReference.parts;\n        const referencedColumn = this.normalize(column);\n        for (const table of matchingTables) {\n          if (!this.hasColumn(table, referencedColumn)) {\n            continue;\n          }\n          const index: RootIndexCandidate = {\n            schema: table.schemaName,\n            table: table.tableName,\n            column: referencedColumn,\n          };\n          if (colReference.sort) {\n            index.sort = colReference.sort;\n          }\n          if (colReference.where) {\n            index.where = colReference.where;\n          }\n          if (colReference.jsonbOperator) {\n            index.jsonbOperator = colReference.jsonbOperator;\n          }\n          if (colReference.jsonbExtraction) {\n            index.jsonbExtraction = colReference.jsonbExtraction;\n          }\n          addIndex(index);\n        }\n      } else if (tableReference) {\n        // select b.c from x\n        const [table, column] = colReference.parts;\n        const referencedTable = this.normalize(table);\n        const referencedColumn = this.normalize(column);\n        for (const matchingTable of matchingTables) {\n          if (!this.hasColumn(matchingTable, referencedColumn)) {\n            continue;\n          }\n          const index: RootIndexCandidate = {\n            schema: matchingTable.schemaName,\n            table: referencedTable,\n            column: referencedColumn,\n          };\n          if (colReference.sort) {\n            index.sort = colReference.sort;\n          }\n          if (colReference.where) {\n            index.where = colReference.where;\n          }\n          if (colReference.jsonbOperator) {\n            index.jsonbOperator = colReference.jsonbOperator;\n          }\n          if (colReference.jsonbExtraction) {\n            index.jsonbExtraction = colReference.jsonbExtraction;\n          }\n          addIndex(index);\n        }\n      } else if (fullReference) {\n        // select a.b.c from x\n        const [schema, table, column] = colReference.parts;\n        const referencedSchema = this.normalize(schema);\n        const referencedTable = this.normalize(table);\n        const referencedColumn = this.normalize(column);\n        const index: RootIndexCandidate = {\n          schema: referencedSchema,\n          table: referencedTable,\n          column: referencedColumn,\n        };\n        if (colReference.sort) {\n          index.sort = colReference.sort;\n        }\n        if (colReference.where) {\n          index.where = colReference.where;\n        }\n        if (colReference.jsonbOperator) {\n          index.jsonbOperator = colReference.jsonbOperator;\n        }\n        if (colReference.jsonbExtraction) {\n          index.jsonbExtraction = colReference.jsonbExtraction;\n        }\n        addIndex(index);\n      } else {\n        // select huh.a.b.c from x\n        console.error(\n          \"Column reference has too many parts. The query is malformed\",\n          colReference,\n        );\n        continue;\n      }\n    }\n    return allIndexes;\n  }\n\n  private filterReferences(\n    referencedTables: TableReference[],\n    tables: ExportedStats[],\n  ): ExportedStats[] {\n    const matchingTables: ExportedStats[] = [];\n    for (const referencedTable of referencedTables) {\n      const refs = tables.filter(({ tableName, schemaName }) => {\n        // not every referenced table carries a schema with it\n        let schemaMatches = true;\n        if (referencedTable.schema) {\n          schemaMatches = schemaName === referencedTable.schema;\n        }\n        return schemaMatches && tableName === referencedTable.table;\n      });\n      matchingTables.push(...refs);\n    }\n    return matchingTables;\n  }\n\n  private hasColumn(table: ExportedStats, columnName: string): boolean {\n    return (\n      table.columns?.some((column) => column.columnName === columnName) ?? false\n    );\n  }\n\n  private colorizeKeywords(query: string, color: Color) {\n    return query\n      .replace(\n        // eh? This kinda sucks\n        /(^\\s+)(asc|desc)?(\\s+(nulls first|nulls last))?/i,\n        (_, pre, dir, spaceNulls, nulls) => {\n          return `${pre}${dir ? color(dir) : \"\"}${\n            nulls ? spaceNulls.replace(nulls, color(nulls)) : \"\"\n          }`;\n        },\n      )\n      .replace(/(^\\s+)(is (null|not null))/i, (_, pre, nulltest) => {\n        return `${pre}${color(nulltest)}`;\n      });\n  }\n\n  /**\n   * Resolves aliases such as `a.b` to `x.b` if `a` is a known\n   * alias to a table called x.\n   *\n   * Ignores all other combination of parts such as `a.b.c`\n   */\n  private resolveTableAliases(\n    parts: ColumnReferencePart[],\n    tableMappings: TableMappings,\n  ): ColumnReferencePart[] {\n    // we don't want to resolve aliases for references such as\n    // `a.b.c` - this is fully qualified with a schema and can't be an alias\n    // `c` - because there's no table reference here (as far as we can tell)\n    if (parts.length !== 2) {\n      return parts;\n    }\n    const tablePart = parts[0];\n    const mapping = tableMappings.get(tablePart.text);\n    if (mapping) {\n      parts[0] = mapping;\n    }\n    return parts;\n  }\n\n  private normalize(columnReference: ColumnReferencePart): string {\n    return columnReference.quoted\n      ? columnReference.text\n      : // postgres automatically lowercases column names if not quoted\n        columnReference.text.toLowerCase();\n  }\n\n  private extractSqlcommenter(query: string): SQLCommenterExtraction {\n    const trimmedQuery = query.trimEnd();\n    const startPosition = trimmedQuery.lastIndexOf(\"/*\");\n    const endPosition = trimmedQuery.lastIndexOf(\"*/\");\n    if (startPosition === -1 || endPosition === -1) {\n      return { tags: [], queryWithoutTags: trimmedQuery };\n    }\n    // Only treat as SQLCommenter if the comment is at the end of the query.\n    // pg_stat_statements (PG 18+) puts /*, ... */ inside IN clauses —\n    // those have SQL after the closing */, so skip them.\n    const afterComment = trimmedQuery.slice(endPosition + 2).trim();\n    if (afterComment && afterComment !== \";\") {\n      return { tags: [], queryWithoutTags: trimmedQuery };\n    }\n    const queryWithoutTags = trimmedQuery.slice(0, startPosition);\n    const tagString = trimmedQuery.slice(startPosition + 2, endPosition).trim();\n    if (!tagString || typeof tagString !== \"string\") {\n      return { tags: [], queryWithoutTags: queryWithoutTags };\n    }\n    const tags: SQLCommenterTag[] = [];\n    for (const match of tagString.split(\",\")) {\n      const [key, value] = match.split(\"=\");\n      // just because a comment has a `,` but not a `=` in it doesn't\n      // mean that it's a malformed sqlcommenter tag. It might just be\n      // a long comment with good punctuation.\n      if (!key || !value) {\n        // however, if there was a previously valid tag, the comment\n        // is more likely to be a malformed sqlcommenter tag\n        if (tags.length > 0) {\n          console.warn(\n            `Invalid sqlcommenter tag: ${match} in comment: ${tagString}. Ignoring`,\n          );\n        }\n        continue;\n      }\n      try {\n        let sliceStart = 0;\n        if (value.startsWith(\"'\")) {\n          sliceStart = 1;\n        }\n        let sliceEnd = value.length;\n        if (value.endsWith(\"'\")) {\n          sliceEnd -= 1;\n        }\n\n        const decoded = decodeURIComponent(value.slice(sliceStart, sliceEnd));\n        // should we be trimming here?\n        tags.push({ key: key.trim(), value: decoded });\n      } catch (err) {\n        // we want to be very conservative with this parser and ignore errors\n        console.error(err);\n      }\n    }\n    return { tags, queryWithoutTags };\n  }\n}\n"],"mappings":";;;;;AAuBA,MAAa,oBAAoB;AA0DjC,MAAM,qBAAoD;CACxD,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,YAAY;CACb;;;;;;;AAiCD,IAAa,WAAb,MAAsB;CACpB,YAAY,QAAiC;AAAhB,OAAA,SAAA;;CAC7B,MAAM,QACJ,OACA,gBACyB;EACzB,MAAM,MAAO,MAAM,KAAK,OAAO,MAAM;AACrC,MAAI,CAAC,IAAI,MACP,OAAM,IAAI,MACR,wEACD;EAEH,MAAM,OAAO,IAAI,MAAM,GAAG;AAC1B,MAAI,CAAC,KACH,OAAM,IAAI,MACR,wEACD;EAGH,MAAM,gBACJ,mBAFe,YAAY,KAAK,KAEA;EAElC,MAAM,EACJ,YACA,sBACA,gBACA,iBACA,YACA,eACA,WARa,IAAI,OAAO,MAAM,CASrB,KAAK,KAAK;EACrB,MAAM,mBAAmB,WAAW,MACjC,GAAG,MAAM,EAAE,SAAS,MAAM,EAAE,SAAS,IACvC;EACD,IAAI,YAAY;AAChB,OAAK,MAAM,aAAa,kBAAkB;GAExC,MAAM,QAAQ,KAAK,oBAAoB,UAAU,OAAO,cAAc;AACtE,OAAI,MAAM,WAAW,GAAG;AACtB,YAAQ,MAAM,UAAU;AACxB,UAAM,IAAI,MAAM,wCAAwC;;GAE1D,IAAI;GACJ,IAAI,OAAO;AACX,OAAI,UAAU,SAAS;AACrB,aAAS,MAAM,IAAI,cAAc,EAAE,CAAC;AACpC,WAAO;cAEP,MAAM,WAAW,KACjB,WAAW,IAAI,MAAM,GAAG,KAAK,IAG7B,CAAC,cAAc,IAAI,MAAM,GAAG,KAAK,EACjC;AACA,YAAQ;AACR,WAAO;SAEP,SAAQ;GAEV,MAAM,YAAY,UAAU;GAC5B,MAAM,mBAAmB,UAAU,MAAM,GAAG,UAAU,SAAS,MAAM;GACrE,MAAM,kBAAkB,UAAU,MAAM,UAAU,SAAS,IAAI;AAC/D,eAAY,GAAG,mBAAmB,MAAM,UAAU,GAAG,KAAK,iBACxD,iBACA,MACD;GACD,MAAM,UAAU,UAAU,kBACtB,GAAG,UAAU,IAAI,UAAU,oBAC3B;AACJ,OAAI,qBAAqB,IAAI,QAAQ,CACnC,QAAO;AAET,OAAI,CAAC,MAAM;AACT,mBAAe,KAAK,UAAU;AAC9B,yBAAqB,IAAI,QAAQ;;;EAIrC,MAAM,mBAAqC,EAAE;AAC7C,OAAK,MAAM,SAAS,cAAc,QAAQ,CAGxC,KAAI,CAAC,MAAM,MACT,kBAAiB,KAAK;GACpB,QAAQ,MAAM;GACd,OAAO,MAAM;GACd,CAAC;EAGN,MAAM,EAAE,MAAM,qBAAqB,KAAK,oBAAoB,MAAM;EAElE,MAAM,4BAA4B,iBAC9B,KAAK,oBAAoB,eAAe,CAAC,mBACzC,KAAA;AAEJ,SAAO;GACL;GACA;GACA,sBAAsB;GACtB;GACA;GACA;GACA;GACA;GACA;GACD;;CAGH,cACE,QACA,YACA,kBACsB;;;;;;;;;EAStB,MAAM,aAAmC,EAAE;EAC3C,MAAM,8BAAc,IAAI,KAAa;EACrC,SAAS,SAAS,OAA2B;GAC3C,MAAM,mBAAmB,MAAM,kBAC3B,KAAK,MAAM,gBAAgB,KAC3B;GACJ,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK,MAAM,MAAM,KAAK,MAAM,OAAO,GAAG;AACnE,OAAI,YAAY,IAAI,IAAI,CACtB;AAEF,eAAY,IAAI,IAAI;AACpB,cAAW,KAAK,MAAM;;EAExB,MAAM,iBAAiB,KAAK,iBAAiB,kBAAkB,OAAO;AACtE,OAAK,MAAM,gBAAgB,YAAY;GACrC,MAAM,aAAa,aAAa,MAAM;GACtC,MAAM,sBAAsB,eAAe;GAC3C,MAAM,iBAAiB,eAAe;GACtC,MAAM,gBAAgB,eAAe;AACrC,OAAI,qBAAqB;IAEvB,MAAM,CAAC,UAAU,aAAa;IAC9B,MAAM,mBAAmB,KAAK,UAAU,OAAO;AAC/C,SAAK,MAAM,SAAS,gBAAgB;AAClC,SAAI,CAAC,KAAK,UAAU,OAAO,iBAAiB,CAC1C;KAEF,MAAM,QAA4B;MAChC,QAAQ,MAAM;MACd,OAAO,MAAM;MACb,QAAQ;MACT;AACD,SAAI,aAAa,KACf,OAAM,OAAO,aAAa;AAE5B,SAAI,aAAa,MACf,OAAM,QAAQ,aAAa;AAE7B,SAAI,aAAa,cACf,OAAM,gBAAgB,aAAa;AAErC,SAAI,aAAa,gBACf,OAAM,kBAAkB,aAAa;AAEvC,cAAS,MAAM;;cAER,gBAAgB;IAEzB,MAAM,CAAC,OAAO,UAAU,aAAa;IACrC,MAAM,kBAAkB,KAAK,UAAU,MAAM;IAC7C,MAAM,mBAAmB,KAAK,UAAU,OAAO;AAC/C,SAAK,MAAM,iBAAiB,gBAAgB;AAC1C,SAAI,CAAC,KAAK,UAAU,eAAe,iBAAiB,CAClD;KAEF,MAAM,QAA4B;MAChC,QAAQ,cAAc;MACtB,OAAO;MACP,QAAQ;MACT;AACD,SAAI,aAAa,KACf,OAAM,OAAO,aAAa;AAE5B,SAAI,aAAa,MACf,OAAM,QAAQ,aAAa;AAE7B,SAAI,aAAa,cACf,OAAM,gBAAgB,aAAa;AAErC,SAAI,aAAa,gBACf,OAAM,kBAAkB,aAAa;AAEvC,cAAS,MAAM;;cAER,eAAe;IAExB,MAAM,CAAC,QAAQ,OAAO,UAAU,aAAa;IAI7C,MAAM,QAA4B;KAChC,QAJuB,KAAK,UAAU,OAAO;KAK7C,OAJsB,KAAK,UAAU,MAAM;KAK3C,QAJuB,KAAK,UAAU,OAAO;KAK9C;AACD,QAAI,aAAa,KACf,OAAM,OAAO,aAAa;AAE5B,QAAI,aAAa,MACf,OAAM,QAAQ,aAAa;AAE7B,QAAI,aAAa,cACf,OAAM,gBAAgB,aAAa;AAErC,QAAI,aAAa,gBACf,OAAM,kBAAkB,aAAa;AAEvC,aAAS,MAAM;UACV;AAEL,YAAQ,MACN,+DACA,aACD;AACD;;;AAGJ,SAAO;;CAGT,iBACE,kBACA,QACiB;EACjB,MAAM,iBAAkC,EAAE;AAC1C,OAAK,MAAM,mBAAmB,kBAAkB;GAC9C,MAAM,OAAO,OAAO,QAAQ,EAAE,WAAW,iBAAiB;IAExD,IAAI,gBAAgB;AACpB,QAAI,gBAAgB,OAClB,iBAAgB,eAAe,gBAAgB;AAEjD,WAAO,iBAAiB,cAAc,gBAAgB;KACtD;AACF,kBAAe,KAAK,GAAG,KAAK;;AAE9B,SAAO;;CAGT,UAAkB,OAAsB,YAA6B;AACnE,SACE,MAAM,SAAS,MAAM,WAAW,OAAO,eAAe,WAAW,IAAI;;CAIzE,iBAAyB,OAAe,OAAc;AACpD,SAAO,MACJ,QAEC,qDACC,GAAG,KAAK,KAAK,YAAY,UAAU;AAClC,UAAO,GAAG,MAAM,MAAM,MAAM,IAAI,GAAG,KACjC,QAAQ,WAAW,QAAQ,OAAO,MAAM,MAAM,CAAC,GAAG;IAGvD,CACA,QAAQ,gCAAgC,GAAG,KAAK,aAAa;AAC5D,UAAO,GAAG,MAAM,MAAM,SAAS;IAC/B;;;;;;;;CASN,oBACE,OACA,eACuB;AAIvB,MAAI,MAAM,WAAW,EACnB,QAAO;EAET,MAAM,YAAY,MAAM;EACxB,MAAM,UAAU,cAAc,IAAI,UAAU,KAAK;AACjD,MAAI,QACF,OAAM,KAAK;AAEb,SAAO;;CAGT,UAAkB,iBAA8C;AAC9D,SAAO,gBAAgB,SACnB,gBAAgB,OAEhB,gBAAgB,KAAK,aAAa;;CAGxC,oBAA4B,OAAuC;EACjE,MAAM,eAAe,MAAM,SAAS;EACpC,MAAM,gBAAgB,aAAa,YAAY,KAAK;EACpD,MAAM,cAAc,aAAa,YAAY,KAAK;AAClD,MAAI,kBAAkB,MAAM,gBAAgB,GAC1C,QAAO;GAAE,MAAM,EAAE;GAAE,kBAAkB;GAAc;EAKrD,MAAM,eAAe,aAAa,MAAM,cAAc,EAAE,CAAC,MAAM;AAC/D,MAAI,gBAAgB,iBAAiB,IACnC,QAAO;GAAE,MAAM,EAAE;GAAE,kBAAkB;GAAc;EAErD,MAAM,mBAAmB,aAAa,MAAM,GAAG,cAAc;EAC7D,MAAM,YAAY,aAAa,MAAM,gBAAgB,GAAG,YAAY,CAAC,MAAM;AAC3E,MAAI,CAAC,aAAa,OAAO,cAAc,SACrC,QAAO;GAAE,MAAM,EAAE;GAAoB;GAAkB;EAEzD,MAAM,OAA0B,EAAE;AAClC,OAAK,MAAM,SAAS,UAAU,MAAM,IAAI,EAAE;GACxC,MAAM,CAAC,KAAK,SAAS,MAAM,MAAM,IAAI;AAIrC,OAAI,CAAC,OAAO,CAAC,OAAO;AAGlB,QAAI,KAAK,SAAS,EAChB,SAAQ,KACN,6BAA6B,MAAM,eAAe,UAAU,YAC7D;AAEH;;AAEF,OAAI;IACF,IAAI,aAAa;AACjB,QAAI,MAAM,WAAW,IAAI,CACvB,cAAa;IAEf,IAAI,WAAW,MAAM;AACrB,QAAI,MAAM,SAAS,IAAI,CACrB,aAAY;IAGd,MAAM,UAAU,mBAAmB,MAAM,MAAM,YAAY,SAAS,CAAC;AAErE,SAAK,KAAK;KAAE,KAAK,IAAI,MAAM;KAAE,OAAO;KAAS,CAAC;YACvC,KAAK;AAEZ,YAAQ,MAAM,IAAI;;;AAGtB,SAAO;GAAE;GAAM;GAAkB"}

package/dist/sql/ast-utils.cjs

@@ -0,0 +1,19 @@
+"use client";
+//#region src/sql/ast-utils.ts
+function is(node, kind) {
+	return kind in node;
+}
+function isANode(node) {
+	if (typeof node !== "object" || node === null) return false;
+	const keys = Object.keys(node);
+	return keys.length === 1 && /^[A-Z]/.test(keys[0]);
+}
+function getNodeKind(node) {
+	return Object.keys(node)[0];
+}
+//#endregion
+exports.getNodeKind = getNodeKind;
+exports.is = is;
+exports.isANode = isANode;
+
+//# sourceMappingURL=ast-utils.cjs.map

package/dist/sql/ast-utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-utils.cjs","names":[],"sources":["../../src/sql/ast-utils.ts"],"sourcesContent":["import type { Node } from \"@pgsql/types\";\n\nexport type KeysOfUnion<T> = T extends T ? keyof T : never;\n\nexport function is<K extends KeysOfUnion<Node>>(\n  node: Node,\n  kind: K,\n): node is Extract<Node, Record<K, unknown>> {\n  return kind in node;\n}\n\nexport function isANode(node: unknown): node is Node {\n  if (typeof node !== \"object\" || node === null) {\n    return false;\n  }\n  const keys = Object.keys(node);\n  return keys.length === 1 && /^[A-Z]/.test(keys[0]);\n}\n\nexport function getNodeKind(node: Node): KeysOfUnion<Node> {\n  const keys = Object.keys(node);\n  return keys[0] as KeysOfUnion<Node>;\n}\n"],"mappings":";;AAIA,SAAgB,GACd,MACA,MAC2C;AAC3C,QAAO,QAAQ;;AAGjB,SAAgB,QAAQ,MAA6B;AACnD,KAAI,OAAO,SAAS,YAAY,SAAS,KACvC,QAAO;CAET,MAAM,OAAO,OAAO,KAAK,KAAK;AAC9B,QAAO,KAAK,WAAW,KAAK,SAAS,KAAK,KAAK,GAAG;;AAGpD,SAAgB,YAAY,MAA+B;AAEzD,QADa,OAAO,KAAK,KAAK,CAClB"}

package/dist/sql/ast-utils.d.cts

@@ -0,0 +1,9 @@
+'use client';
+
+import { Node } from "@pgsql/types";
+
+//#region src/sql/ast-utils.d.ts
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+//#endregion
+export { KeysOfUnion };
+//# sourceMappingURL=ast-utils.d.cts.map

package/dist/sql/ast-utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-utils.d.cts","names":[],"sources":["../../src/sql/ast-utils.ts"],"mappings":";;;;;KAEY,WAAA,MAAiB,CAAA,SAAU,CAAA,SAAU,CAAA"}

package/dist/sql/ast-utils.d.mts

@@ -0,0 +1,9 @@
+'use client';
+
+import { Node } from "@pgsql/types";
+
+//#region src/sql/ast-utils.d.ts
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+//#endregion
+export { KeysOfUnion };
+//# sourceMappingURL=ast-utils.d.mts.map

package/dist/sql/ast-utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-utils.d.mts","names":[],"sources":["../../src/sql/ast-utils.ts"],"mappings":";;;;;KAEY,WAAA,MAAiB,CAAA,SAAU,CAAA,SAAU,CAAA"}

package/dist/sql/ast-utils.mjs

@@ -0,0 +1,17 @@
+"use client";
+//#region src/sql/ast-utils.ts
+function is(node, kind) {
+	return kind in node;
+}
+function isANode(node) {
+	if (typeof node !== "object" || node === null) return false;
+	const keys = Object.keys(node);
+	return keys.length === 1 && /^[A-Z]/.test(keys[0]);
+}
+function getNodeKind(node) {
+	return Object.keys(node)[0];
+}
+//#endregion
+export { getNodeKind, is, isANode };
+
+//# sourceMappingURL=ast-utils.mjs.map

package/dist/sql/ast-utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ast-utils.mjs","names":[],"sources":["../../src/sql/ast-utils.ts"],"sourcesContent":["import type { Node } from \"@pgsql/types\";\n\nexport type KeysOfUnion<T> = T extends T ? keyof T : never;\n\nexport function is<K extends KeysOfUnion<Node>>(\n  node: Node,\n  kind: K,\n): node is Extract<Node, Record<K, unknown>> {\n  return kind in node;\n}\n\nexport function isANode(node: unknown): node is Node {\n  if (typeof node !== \"object\" || node === null) {\n    return false;\n  }\n  const keys = Object.keys(node);\n  return keys.length === 1 && /^[A-Z]/.test(keys[0]);\n}\n\nexport function getNodeKind(node: Node): KeysOfUnion<Node> {\n  const keys = Object.keys(node);\n  return keys[0] as KeysOfUnion<Node>;\n}\n"],"mappings":";;AAIA,SAAgB,GACd,MACA,MAC2C;AAC3C,QAAO,QAAQ;;AAGjB,SAAgB,QAAQ,MAA6B;AACnD,KAAI,OAAO,SAAS,YAAY,SAAS,KACvC,QAAO;CAET,MAAM,OAAO,OAAO,KAAK,KAAK;AAC9B,QAAO,KAAK,WAAW,KAAK,SAAS,KAAK,KAAK,GAAG;;AAGpD,SAAgB,YAAY,MAA+B;AAEzD,QADa,OAAO,KAAK,KAAK,CAClB"}

package/dist/sql/builder.cjs

@@ -0,0 +1,94 @@
+"use client";
+const require_defineProperty = require("../_virtual/_@oxc-project_runtime@0.122.0/helpers/defineProperty.cjs");
+//#region src/sql/builder.ts
+var PostgresQueryBuilder = class PostgresQueryBuilder {
+	constructor(query) {
+		this.query = query;
+		require_defineProperty._defineProperty(this, "commands", {});
+		require_defineProperty._defineProperty(this, "isIntrospection", false);
+		require_defineProperty._defineProperty(this, "explainFlags", []);
+		require_defineProperty._defineProperty(this, "_preamble", 0);
+		require_defineProperty._defineProperty(this, "parameters", {});
+		require_defineProperty._defineProperty(this, "limitSubstitution", void 0);
+	}
+	get preamble() {
+		return this._preamble;
+	}
+	static createIndex(definition, name) {
+		if (name) return new PostgresQueryBuilder(`create index "${name}" on ${definition};`);
+		return new PostgresQueryBuilder(`create index on ${definition};`);
+	}
+	enable(command, value = true) {
+		const commandString = `enable_${command}`;
+		if (value) this.commands[commandString] = "on";
+		else this.commands[commandString] = "off";
+		return this;
+	}
+	withQuery(query) {
+		this.query = query;
+		return this;
+	}
+	introspect() {
+		this.isIntrospection = true;
+		return this;
+	}
+	explain(flags) {
+		this.explainFlags = flags;
+		return this;
+	}
+	parameterize(parameters) {
+		Object.assign(this.parameters, parameters);
+		return this;
+	}
+	replaceLimit(limit) {
+		this.limitSubstitution = limit;
+		return this;
+	}
+	build() {
+		let commands = this.generateSetCommands();
+		commands += this.generateExplain().query;
+		if (this.isIntrospection) commands += " -- @qd_introspection";
+		return commands;
+	}
+	/** Return the "set a=b" parts of the command in the query separate from the explain select ... part */
+	buildParts() {
+		const commands = this.generateSetCommands();
+		const explain = this.generateExplain();
+		this._preamble = explain.preamble;
+		if (this.isIntrospection) explain.query += " -- @qd_introspection";
+		return {
+			commands,
+			query: explain.query
+		};
+	}
+	generateSetCommands() {
+		let commands = "";
+		for (const key in this.commands) {
+			const value = this.commands[key];
+			commands += `set local ${key}=${value};\n`;
+		}
+		return commands;
+	}
+	generateExplain() {
+		let finalQuery = "";
+		if (this.explainFlags.length > 0) finalQuery += `explain (${this.explainFlags.join(", ")}) `;
+		const query = this.substituteQuery();
+		const semicolon = query.endsWith(";") ? "" : ";";
+		const preamble = finalQuery.length;
+		finalQuery += `${query}${semicolon}`;
+		return {
+			query: finalQuery,
+			preamble
+		};
+	}
+	substituteQuery() {
+		let query = this.query;
+		if (this.limitSubstitution !== void 0) query = query.replace(/limit\s+\$\d+/g, `limit ${this.limitSubstitution}`);
+		for (const [key, value] of Object.entries(this.parameters)) query = query.replaceAll(`\\$${key}`, value.toString());
+		return query;
+	}
+};
+//#endregion
+exports.PostgresQueryBuilder = PostgresQueryBuilder;
+
+//# sourceMappingURL=builder.cjs.map

package/dist/sql/builder.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.cjs","names":[],"sources":["../../src/sql/builder.ts"],"sourcesContent":["import { PgIdentifier } from \"./pg-identifier\";\n\nexport type PostgresQueryBuilderCommand =\n  | \"bitmapscan\"\n  | \"indexscan\"\n  | \"seqscan\";\n\nexport class PostgresQueryBuilder {\n  private readonly commands: Record<string, string> = {};\n  private isIntrospection: boolean = false;\n  private explainFlags: string[] = [];\n  private _preamble = 0;\n  private parameters: Record<Parameter, number> = {};\n  // substitution for `limit $1` -> `limit 5`\n  private limitSubstitution?: number;\n\n  constructor(private query: string) {}\n\n  get preamble(): number {\n    return this._preamble;\n  }\n\n  static createIndex(definition: string, name?: PgIdentifier) {\n    if (name) {\n      return new PostgresQueryBuilder(\n        `create index \"${name}\" on ${definition};`,\n      );\n    }\n    return new PostgresQueryBuilder(`create index on ${definition};`);\n  }\n\n  enable(command: PostgresQueryBuilderCommand, value: boolean = true): this {\n    const commandString = `enable_${command}`;\n    if (value) {\n      this.commands[commandString] = \"on\";\n    } else {\n      this.commands[commandString] = \"off\";\n    }\n    return this;\n  }\n\n  withQuery(query: string): this {\n    this.query = query;\n    return this;\n  }\n\n  introspect(): this {\n    this.isIntrospection = true;\n    return this;\n  }\n\n  explain(flags: string[]): this {\n    this.explainFlags = flags;\n    return this;\n  }\n\n  parameterize(parameters: Record<Parameter, number>) {\n    Object.assign(this.parameters, parameters);\n    return this;\n  }\n\n  replaceLimit(limit: number) {\n    this.limitSubstitution = limit;\n    return this;\n  }\n\n  build(): string {\n    let commands = this.generateSetCommands();\n    commands += this.generateExplain().query;\n    if (this.isIntrospection) {\n      commands += \" -- @qd_introspection\";\n    }\n    return commands;\n  }\n\n  /** Return the \"set a=b\" parts of the command in the query separate from the explain select ... part */\n  buildParts() {\n    const commands = this.generateSetCommands();\n    const explain = this.generateExplain();\n    this._preamble = explain.preamble;\n    if (this.isIntrospection) {\n      explain.query += \" -- @qd_introspection\";\n    }\n    return { commands, query: explain.query };\n  }\n\n  private generateSetCommands() {\n    let commands = \"\";\n    for (const key in this.commands) {\n      const value = this.commands[key];\n      commands += `set local ${key}=${value};\\n`;\n    }\n    return commands;\n  }\n\n  private generateExplain() {\n    let finalQuery = \"\";\n    if (this.explainFlags.length > 0) {\n      finalQuery += `explain (${this.explainFlags.join(\", \")}) `;\n    }\n    const query = this.substituteQuery();\n    const semicolon = query.endsWith(\";\") ? \"\" : \";\";\n\n    const preamble = finalQuery.length;\n    finalQuery += `${query}${semicolon}`;\n    return { query: finalQuery, preamble };\n  }\n\n  private substituteQuery() {\n    let query = this.query;\n    if (this.limitSubstitution !== undefined) {\n      query = query.replace(\n        /limit\\s+\\$\\d+/g,\n        `limit ${this.limitSubstitution}`,\n      );\n    }\n    for (const [key, value] of Object.entries(this.parameters)) {\n      query = query.replaceAll(`\\\\$${key}`, value.toString());\n    }\n    return query;\n  }\n}\n\nexport type Parameter = `$${string}`;\n"],"mappings":";;;AAOA,IAAa,uBAAb,MAAa,qBAAqB;CAShC,YAAY,OAAuB;AAAf,OAAA,QAAA;+CARH,YAAmC,EAAE,CAAC;+CAC/C,mBAA2B,MAAM;+CACjC,gBAAyB,EAAE,CAAC;+CAC5B,aAAY,EAAE;+CACd,cAAwC,EAAE,CAAC;+CAE3C,qBAAA,KAAA,EAA2B;;CAInC,IAAI,WAAmB;AACrB,SAAO,KAAK;;CAGd,OAAO,YAAY,YAAoB,MAAqB;AAC1D,MAAI,KACF,QAAO,IAAI,qBACT,iBAAiB,KAAK,OAAO,WAAW,GACzC;AAEH,SAAO,IAAI,qBAAqB,mBAAmB,WAAW,GAAG;;CAGnE,OAAO,SAAsC,QAAiB,MAAY;EACxE,MAAM,gBAAgB,UAAU;AAChC,MAAI,MACF,MAAK,SAAS,iBAAiB;MAE/B,MAAK,SAAS,iBAAiB;AAEjC,SAAO;;CAGT,UAAU,OAAqB;AAC7B,OAAK,QAAQ;AACb,SAAO;;CAGT,aAAmB;AACjB,OAAK,kBAAkB;AACvB,SAAO;;CAGT,QAAQ,OAAuB;AAC7B,OAAK,eAAe;AACpB,SAAO;;CAGT,aAAa,YAAuC;AAClD,SAAO,OAAO,KAAK,YAAY,WAAW;AAC1C,SAAO;;CAGT,aAAa,OAAe;AAC1B,OAAK,oBAAoB;AACzB,SAAO;;CAGT,QAAgB;EACd,IAAI,WAAW,KAAK,qBAAqB;AACzC,cAAY,KAAK,iBAAiB,CAAC;AACnC,MAAI,KAAK,gBACP,aAAY;AAEd,SAAO;;;CAIT,aAAa;EACX,MAAM,WAAW,KAAK,qBAAqB;EAC3C,MAAM,UAAU,KAAK,iBAAiB;AACtC,OAAK,YAAY,QAAQ;AACzB,MAAI,KAAK,gBACP,SAAQ,SAAS;AAEnB,SAAO;GAAE;GAAU,OAAO,QAAQ;GAAO;;CAG3C,sBAA8B;EAC5B,IAAI,WAAW;AACf,OAAK,MAAM,OAAO,KAAK,UAAU;GAC/B,MAAM,QAAQ,KAAK,SAAS;AAC5B,eAAY,aAAa,IAAI,GAAG,MAAM;;AAExC,SAAO;;CAGT,kBAA0B;EACxB,IAAI,aAAa;AACjB,MAAI,KAAK,aAAa,SAAS,EAC7B,eAAc,YAAY,KAAK,aAAa,KAAK,KAAK,CAAC;EAEzD,MAAM,QAAQ,KAAK,iBAAiB;EACpC,MAAM,YAAY,MAAM,SAAS,IAAI,GAAG,KAAK;EAE7C,MAAM,WAAW,WAAW;AAC5B,gBAAc,GAAG,QAAQ;AACzB,SAAO;GAAE,OAAO;GAAY;GAAU;;CAGxC,kBAA0B;EACxB,IAAI,QAAQ,KAAK;AACjB,MAAI,KAAK,sBAAsB,KAAA,EAC7B,SAAQ,MAAM,QACZ,kBACA,SAAS,KAAK,oBACf;AAEH,OAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,WAAW,CACxD,SAAQ,MAAM,WAAW,MAAM,OAAO,MAAM,UAAU,CAAC;AAEzD,SAAO"}

package/dist/sql/builder.d.cts

@@ -0,0 +1,37 @@
+'use client';
+
+import { PgIdentifier } from "./pg-identifier.cjs";
+
+//#region src/sql/builder.d.ts
+type PostgresQueryBuilderCommand = "bitmapscan" | "indexscan" | "seqscan";
+declare class PostgresQueryBuilder {
+  private query;
+  private readonly commands;
+  private isIntrospection;
+  private explainFlags;
+  private _preamble;
+  private parameters;
+  private limitSubstitution?;
+  constructor(query: string);
+  get preamble(): number;
+  static createIndex(definition: string, name?: PgIdentifier): PostgresQueryBuilder;
+  enable(command: PostgresQueryBuilderCommand, value?: boolean): this;
+  withQuery(query: string): this;
+  introspect(): this;
+  explain(flags: string[]): this;
+  parameterize(parameters: Record<Parameter, number>): this;
+  replaceLimit(limit: number): this;
+  build(): string;
+  /** Return the "set a=b" parts of the command in the query separate from the explain select ... part */
+  buildParts(): {
+    commands: string;
+    query: string;
+  };
+  private generateSetCommands;
+  private generateExplain;
+  private substituteQuery;
+}
+type Parameter = `$${string}`;
+//#endregion
+export { Parameter, PostgresQueryBuilder, PostgresQueryBuilderCommand };
+//# sourceMappingURL=builder.d.cts.map

package/dist/sql/builder.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.cts","names":[],"sources":["../../src/sql/builder.ts"],"mappings":";;;;;KAEY,2BAAA;AAAA,cAKC,oBAAA;EAAA,QASS,KAAA;EAAA,iBARH,QAAA;EAAA,QACT,eAAA;EAAA,QACA,YAAA;EAAA,QACA,SAAA;EAAA,QACA,UAAA;EAAA,QAEA,iBAAA;cAEY,KAAA;EAAA,IAEhB,QAAA,CAAA;EAAA,OAIG,WAAA,CAAY,UAAA,UAAoB,IAAA,GAAO,YAAA,GAAY,oBAAA;EAS1D,MAAA,CAAO,OAAA,EAAS,2BAAA,EAA6B,KAAA;EAU7C,SAAA,CAAU,KAAA;EAKV,UAAA,CAAA;EAKA,OAAA,CAAQ,KAAA;EAKR,YAAA,CAAa,UAAA,EAAY,MAAA,CAAO,SAAA;EAKhC,YAAA,CAAa,KAAA;EAKb,KAAA,CAAA;EA1DiB;EAoEjB,UAAA,CAAA;;;;UAUQ,mBAAA;EAAA,QASA,eAAA;EAAA,QAaA,eAAA;AAAA;AAAA,KAeE,SAAA"}