@ignisia/sql 0.3.0 → 0.4.1

package/dist/cjs/query/explain.js

@@ -0,0 +1,65 @@
+'use strict';
+
+var constants = require('../table/constants');
+var constants$1 = require('./constants');
+
+function buildPostgresExplainQuery(options) {
+  const clauses = [];
+  if (options?.format) {
+    clauses.push(`${constants$1.ExplainClause.FORMAT} ${options.format}`);
+  }
+  if (options?.analyze) {
+    clauses.push(constants$1.ExplainClause.ANALYZE);
+    if (options?.summary != null) {
+      clauses.push(
+        `${constants$1.ExplainClause.SUMMARY} ${options.summary ? "ON" : "OFF"}`
+      );
+    }
+    if (options?.timing != null)
+      clauses.push(`${constants$1.ExplainClause.TIMING} ${options.timing ? "ON" : "OFF"}`);
+  }
+  if (options?.verbose) {
+    clauses.push(`${constants$1.ExplainClause.VERBOSE} ${options.verbose ? "ON" : "OFF"}`);
+  }
+  if (options?.costs != null) {
+    clauses.push(`${constants$1.ExplainClause.COSTS} ${options.costs ? "ON" : "OFF"}`);
+  }
+  if (options?.buffers != null) {
+    clauses.push(`${constants$1.ExplainClause.BUFFERS} ${options.buffers ? "ON" : "OFF"}`);
+  }
+  if (clauses.length === 0) {
+    return "EXPLAIN ";
+  }
+  return `EXPLAIN (${clauses.join(", ")})`;
+}
+function buildMySqlExplainQuery(options) {
+  const clauses = [];
+  if (options.analyze) {
+    clauses.push(constants$1.ExplainClause.ANALYZE);
+  }
+  if (options.format) {
+    clauses.push(`${constants$1.ExplainClause.FORMAT}=${options.format}`);
+  }
+  if (clauses.length > 1) {
+    throw new Error("MySQL EXPLAIN only support one clauses at a time");
+  }
+  return `EXPLAIN ${clauses.join(" ")}`;
+}
+function buildSqliteExplainQuery() {
+  const clauses = ["QUERY PLAN"];
+  return `EXPLAIN ${clauses.join(" ")}`;
+}
+function buildExplainQuery(q, options) {
+  switch (q.table.dialect) {
+    case constants.Dialect.POSTGRES:
+      return buildPostgresExplainQuery(options);
+    case constants.Dialect.MYSQL:
+      return buildMySqlExplainQuery(options);
+    case constants.Dialect.SQLITE:
+      return buildSqliteExplainQuery();
+    default:
+      throw new Error(`Dialect ${q.table.dialect} is not supported`);
+  }
+}
+
+exports.buildExplainQuery = buildExplainQuery;

package/dist/cjs/query/helper.d.cts

@@ -1,8 +1,8 @@
-export { H as aggregateCol, z as alias, B as clone, G as col, F as rawCol } from '../index-CnQVnCEI.cjs';
+export { a1 as aggregateCol, _ as alias, $ as clone, a0 as col } from '../index-K07efKgt.cjs';
 import '../column/index.cjs';
 import './constants.cjs';
-import '../column/constants.cjs';
-import '../types.cjs';
 import 'bun';
+import '../types.cjs';
+import '../column/constants.cjs';
 import '../table/constants.cjs';
 import '../column/types.cjs';

package/dist/cjs/query/helper.js

@@ -9,12 +9,9 @@ function alias(alias2) {
 }
 function clone() {
   const query = new _.QueryBuilder(this.table);
-  Object.assign(query.definition, utilities.deepClone(this.definition));
+  Object.assign(query.definition, utilities.cloneDefinition(this.definition));
   return query;
 }
-function rawCol(column) {
-  return column;
-}
 function col(column, alias2) {
   return {
     column,
@@ -33,4 +30,3 @@ exports.aggregateCol = aggregateCol;
 exports.alias = alias;
 exports.clone = clone;
 exports.col = col;
-exports.rawCol = rawCol;

package/dist/cjs/query/index.d.cts

@@ -1,8 +1,8 @@
+export { c as QueryBuilder } from '../index-K07efKgt.cjs';
 import '../column/index.cjs';
-export { f as QueryBuilder } from '../index-CnQVnCEI.cjs';
+import '../types.cjs';
 import './constants.cjs';
-import '../table/constants.cjs';
+import 'bun';
 import '../column/constants.cjs';
+import '../table/constants.cjs';
 import '../column/types.cjs';
-import '../types.cjs';
-import 'bun';

package/dist/cjs/query/index.js

@@ -17,90 +17,62 @@ class QueryBuilder {
   clone;
   toQuery;
   toString;
+  toDebugString;
+  explain;
   exec;
-  rawWhere;
-  rawAnd;
-  rawOr;
-  rawHaving;
   where;
   and;
   or;
   having;
+  whereGroup;
+  orGroup;
+  not;
   constructor(table) {
     this.hooks = {};
     this.table = table;
     this.definition = {
-      queryType: null,
-      select: null,
-      having: null,
-      where: null,
-      params: null,
-      limit: null,
-      offset: null,
-      groupBy: null,
-      insertValues: null,
-      updateValues: null,
-      orderBy: null,
-      aggregates: null,
-      joins: null,
-      distinct: null,
-      baseAlias: table.name,
-      joinedTables: null,
-      withDeleted: null
+      baseAlias: table.name
     };
     this.alias = helper.alias.bind(this);
     this.clone = helper.clone.bind(this);
     this.toQuery = sql.toQuery.bind(this);
     this.toString = sql.toString.bind(this);
+    this.toDebugString = sql.toDebugString.bind(this);
+    this.explain = sql.explain.bind(this);
     this.exec = sql.exec.bind(this);
-    this.rawWhere = condition.rawWhere.bind(this);
-    this.rawHaving = condition.rawHaving.bind(this);
-    this.rawAnd = this.rawWhere;
-    this.rawOr = condition.rawOr.bind(this);
     this.where = condition.where.bind(this);
     this.having = condition.having.bind(this);
     this.and = this.where;
     this.or = condition.or.bind(this);
+    this.whereGroup = condition.whereGroup.bind(this);
+    this.orGroup = condition.orGroup.bind(this);
+    this.not = {
+      where: condition.whereNot.bind(this),
+      having: condition.havingNot.bind(this),
+      or: condition.orNot.bind(this),
+      whereGroup: condition.whereNotGroup.bind(
+        this
+      ),
+      orGroup: condition.orNotGroup.bind(this)
+    };
   }
-  leftJoin(joinTable, alias2, baseColumn, joinColumn) {
-    return join.addJoin(
-      this,
-      constants.AcceptedJoin.LEFT,
-      alias2,
-      joinTable,
-      baseColumn,
-      joinColumn
-    );
+  leftJoin(joinTable, alias2) {
+    return join.prepareJoin(this, constants.AcceptedJoin.LEFT, joinTable, alias2);
   }
-  rightJoin(joinTable, alias2, baseColumn, joinColumn) {
-    return join.addJoin(
-      this,
-      constants.AcceptedJoin.RIGHT,
-      alias2,
-      joinTable,
-      baseColumn,
-      joinColumn
-    );
+  rightJoin(joinTable, alias2) {
+    return join.prepareJoin(this, constants.AcceptedJoin.RIGHT, joinTable, alias2);
   }
-  innerJoin(joinTable, alias2, baseColumn, joinColumn) {
-    return join.addJoin(
-      this,
-      constants.AcceptedJoin.INNER,
-      alias2,
-      joinTable,
-      baseColumn,
-      joinColumn
-    );
+  innerJoin(joinTable, alias2) {
+    return join.prepareJoin(this, constants.AcceptedJoin.INNER, joinTable, alias2);
   }
-  naturalJoin(joinTable, alias2, baseColumn, joinColumn) {
-    return join.addJoin(
-      this,
-      constants.AcceptedJoin.NATURAL,
-      alias2,
-      joinTable,
-      baseColumn,
-      joinColumn
-    );
+  fullJoin(joinTable, alias2) {
+    return join.prepareJoin(this, constants.AcceptedJoin.FULL, joinTable, alias2);
+  }
+  crossJoin(joinTable, alias2) {
+    return join.addNoOnJoin(this, constants.AcceptedJoin.CROSS, joinTable, alias2);
+  }
+  naturalJoin(joinTable, alias2) {
+    return join.addNoOnJoin(this, constants.AcceptedJoin.NATURAL, joinTable, alias2);
   }
   distinct() {
     this.definition.distinct = true;
@@ -162,17 +134,19 @@ class QueryBuilder {
       updatedAt,
       timestamp
     } = utilities$1.getTimestamp(this.table);
-    if (isWithTimestamp) {
-      values = values.map((row) => ({
-        ...row,
-        ...isHasCreatedAt && {
-          [createdAt]: row[createdAt] ?? timestamp
-        },
-        ...isHasUpdatedAt && {
-          [updatedAt]: row[updatedAt] ?? timestamp
-        }
-      }));
-    }
+    values = values.map((row) => {
+      const fields = {};
+      for (const key in this.table.columns) {
+        fields[key] = row[key] ?? null;
+      }
+      if (isWithTimestamp && isHasCreatedAt) {
+        fields[createdAt] = row[createdAt] ?? timestamp;
+      }
+      if (isWithTimestamp && isHasUpdatedAt) {
+        fields[updatedAt] = row[updatedAt] ?? timestamp;
+      }
+      return fields;
+    });
     this.definition.insertValues = values;
     return this;
   }
@@ -198,6 +172,17 @@ class QueryBuilder {
     this.definition.queryType = constants.QueryType.DELETE;
     return this;
   }
+  paginate(page, size) {
+    if (page < 1) {
+      throw new Error("Page number must be at least 1");
+    }
+    if (size < 1) {
+      throw new Error("Page size must be at least 1");
+    }
+    this.definition.limit = size;
+    this.definition.offset = (page - 1) * size;
+    return this;
+  }
   infer() {
     return null;
   }

package/dist/cjs/query/join.d.cts

@@ -1,17 +1,29 @@
-import { T as Table, Q as QueryDefinition, C as ColumnSelector, e as StrictColumnSelector, f as QueryBuilder } from '../index-CnQVnCEI.cjs';
+import { T as Table, Q as QueryDefinition, C as ColumnSelector, S as StrictColumnSelector, c as QueryBuilder, J as JoinNode, e as QueryTransformerContract, f as QueryConditionContract } from '../index-K07efKgt.cjs';
 import { Column } from '../column/index.cjs';
 import { AcceptedJoin } from './constants.cjs';
-import '../column/constants.cjs';
-import '../types.cjs';
 import 'bun';
+import '../types.cjs';
+import '../column/constants.cjs';
 import '../table/constants.cjs';
 import '../column/types.cjs';
 
-declare function addJoin<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, JoinType extends AcceptedJoin, JoinTable extends Table<string, Record<string, Column>>, JoinAlias extends string, BaseColName extends `${Alias}."${keyof TableRef['columns'] & string}"`, JoinColName extends `${JoinAlias}."${keyof JoinTable['columns'] & string}"`, FinalJoinedTables extends JoinedTables & {
+declare function addNoOnJoin<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, JoinType extends AcceptedJoin, JoinTable extends Table<string, Record<string, Column>>, JoinAlias extends string, FinalJoinedTables extends JoinedTables & {
     [K in JoinAlias]: JoinTable;
-}>(query: QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>, joinType: JoinType, alias: JoinAlias, joinTable: JoinTable, baseColumn: BaseColName, joinColumn: JoinColName): QueryBuilder<Alias, TableRef, FinalJoinedTables, Omit<Definition, "joins" | "joinedTables"> & {
-    joins: string[];
+}>(query: QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>, joinType: JoinType, joinTable: JoinTable, alias: JoinAlias): QueryBuilder<Alias, TableRef, FinalJoinedTables, Omit<Definition, "joins" | "joinedTables"> & {
+    joins: JoinNode[];
     joinedTables: FinalJoinedTables;
 }>;
+declare function prepareJoin<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, JoinType extends AcceptedJoin, JoinTable extends Table<string, Record<string, Column>>, JoinAlias extends string>(query: QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>, joinType: JoinType, joinTable: JoinTable, alias: JoinAlias): {
+    on<FinalJoinedTables extends JoinedTables & { [K in JoinAlias]: JoinTable; }, ReturnedJoinedTables extends FinalJoinedTables = FinalJoinedTables>(callback: (q: QueryBuilder<Alias, TableRef, FinalJoinedTables>) => QueryBuilder<Alias, TableRef, ReturnedJoinedTables>): QueryBuilder<Alias, TableRef, ReturnedJoinedTables, Omit<Definition, "joins" | "joinedTables"> & {
+        joins: JoinNode[];
+        joinedTables: ReturnedJoinedTables;
+    }, ColumnSelector<Alias, TableRef, ReturnedJoinedTables>, StrictColumnSelector<Alias, TableRef, ReturnedJoinedTables>, QueryTransformerContract<Alias, TableRef, ReturnedJoinedTables, Omit<Definition, "joins" | "joinedTables"> & {
+        joins: JoinNode[];
+        joinedTables: ReturnedJoinedTables;
+    }, ColumnSelector<Alias, TableRef, ReturnedJoinedTables>, StrictColumnSelector<Alias, TableRef, ReturnedJoinedTables>>, QueryConditionContract<Alias, TableRef, ReturnedJoinedTables, Omit<Definition, "joins" | "joinedTables"> & {
+        joins: JoinNode[];
+        joinedTables: ReturnedJoinedTables;
+    }, ColumnSelector<Alias, TableRef, ReturnedJoinedTables>, StrictColumnSelector<Alias, TableRef, ReturnedJoinedTables>>>;
+};
 
-export { addJoin };
+export { addNoOnJoin, prepareJoin };

package/dist/cjs/query/join.js

@@ -1,18 +1,55 @@
 'use strict';
 
-function addJoin(query, joinType, alias, joinTable, baseColumn, joinColumn) {
+var _ = require('.');
+var constants = require('./constants');
+
+function addNoOnJoin(query, joinType, joinTable, alias) {
   if (!query.definition.joins) query.definition.joins = [];
-  query.definition.joins.push(
-    `${joinType} JOIN ${joinTable.name} AS ${alias} ON ${baseColumn} = ${joinColumn}`
-  );
+  query.definition.joins.push({
+    type: constants.AstType.JOIN,
+    alias,
+    join: joinType,
+    table: joinTable
+  });
   if (!query.definition.joinedTables) {
     query.definition.joinedTables = {};
   }
-  query.definition.joinedTables = {
-    ...query.definition.joinedTables,
-    [alias]: joinTable
-  };
+  query.definition.joinedTables[alias] = joinTable;
   return query;
 }
+function prepareJoin(query, joinType, joinTable, alias) {
+  return {
+    on(callback) {
+      const sub = callback(new _.QueryBuilder(query.table));
+      const subDef = sub.definition;
+      if (!subDef.where) {
+        return query;
+      }
+      if (!query.definition.joins) {
+        query.definition.joins = [];
+      }
+      const on = subDef.where;
+      query.definition.joins.push({
+        type: constants.AstType.JOIN,
+        alias,
+        join: joinType,
+        table: joinTable,
+        on
+      });
+      if (subDef.joins?.length) {
+        query.definition.joins.push(...subDef.joins);
+      }
+      if (!query.definition.joinedTables) {
+        query.definition.joinedTables = {};
+      }
+      query.definition.joinedTables[alias] = joinTable;
+      if (subDef.joinedTables) {
+        Object.assign(query.definition.joinedTables, subDef.joinedTables);
+      }
+      return query;
+    }
+  };
+}
 
-exports.addJoin = addJoin;
+exports.addNoOnJoin = addNoOnJoin;
+exports.prepareJoin = prepareJoin;

package/dist/cjs/query/sql.d.cts

@@ -1,18 +1,20 @@
 import { TransactionSQL } from 'bun';
-import { T as Table, Q as QueryDefinition, C as ColumnSelector, e as StrictColumnSelector, f as QueryBuilder } from '../index-CnQVnCEI.cjs';
+import { T as Table, Q as QueryDefinition, C as ColumnSelector, S as StrictColumnSelector, c as QueryBuilder, E as ExplainOptions } from '../index-K07efKgt.cjs';
 import { Column } from '../column/index.cjs';
 import { Dialect } from '../table/constants.cjs';
-import '../column/constants.cjs';
 import '../types.cjs';
 import './constants.cjs';
+import '../column/constants.cjs';
 import '../column/types.cjs';
 
 declare function buildQuery(query: string): string;
 declare function toQuery<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(this: Query, dialect?: Dialect | null): {
     query: string;
-    params: unknown[] | null | undefined;
+    params: unknown[];
 };
 declare function toString<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(this: Query): string;
+declare function toDebugString<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(this: Query): string;
+declare function explain<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(this: Query, options?: ExplainOptions): Promise<unknown>;
 declare function exec<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>, Output extends Query['_output'] = Query['_output']>(this: Query, tx?: TransactionSQL | null): Promise<Output>;
 
-export { buildQuery, exec, toQuery, toString };
+export { buildQuery, exec, explain, toDebugString, toQuery, toString };

package/dist/cjs/query/sql.js

@@ -2,7 +2,9 @@
 
 var constants$1 = require('../table/constants');
 var builder = require('./builder');
+var compiler = require('./compiler');
 var constants = require('./constants');
+var explain$1 = require('./explain');
 var utilities = require('./utilities');
 
 function buildQuery(query) {
@@ -12,62 +14,97 @@ function buildQuery(query) {
     return `$${index}`;
   });
 }
-function toQuery(dialect) {
-  let sql = "";
+function toQuery(dialect = this.table.dialect) {
+  const params = [];
+  const parts = [];
   switch (this.definition.queryType) {
     case constants.QueryType.SELECT:
-      sql = builder.buildSelectQuery(this);
+      parts.push(builder.buildSelectQuery(this));
       break;
     case constants.QueryType.INSERT:
-      sql = builder.buildInsertQuery(this);
+      parts.push(builder.buildInsertQuery(this, params));
       break;
     case constants.QueryType.UPDATE:
-      sql = builder.buildUpdateQuery(this);
+      parts.push(builder.buildUpdateQuery(this, params));
       break;
     case constants.QueryType.DELETE:
-      sql = builder.buildDeleteQuery(this);
+      parts.push(builder.buildDeleteQuery(this));
       break;
     default:
       throw new Error("No query type defined");
   }
   if (this.definition?.joins?.length) {
-    sql += ` ${this.definition.joins.join(" ")}`;
+    const joinParts = this.definition.joins.map(
+      (join) => compiler.compileJoin(dialect, join, params)
+    );
+    parts.push(...joinParts);
   }
-  const whereConditions = utilities.getWhereConditions(this);
-  if (whereConditions.length) {
-    sql += ` WHERE ${whereConditions.join(" ")}`;
+  if (this.definition.where) {
+    const whereConditions = compiler.compileAst(dialect, this.definition.where, params);
+    parts.push(`WHERE ${whereConditions}`);
   }
   const groupByConditions = utilities.getGroupByConditions(this);
   if (groupByConditions.length) {
-    sql += ` GROUP BY ${groupByConditions.join(", ")}`;
+    parts.push(`GROUP BY ${groupByConditions.join(", ")}`);
   }
-  if (this.definition?.having?.length) {
-    sql += ` HAVING ${this.definition.having.join(" ")}`;
+  if (this.definition?.having) {
+    const havingConditions = compiler.compileAst(
+      dialect,
+      this.definition.having,
+      params
+    );
+    parts.push(`HAVING ${havingConditions}`);
   }
   if (this.definition?.orderBy?.length) {
-    sql += ` ORDER BY ${this.definition.orderBy.map((order) => [order.column, order.direction].join(" ")).join(", ")}`;
+    parts.push(
+      `ORDER BY ${this.definition.orderBy.map((order) => `${order.column} ${order.direction}`).join(", ")}`
+    );
   }
-  if (this.definition?.limit !== null) {
-    sql += ` LIMIT ?`;
-    if (!this.definition.params) this.definition.params = [];
-    this.definition.params.push(this.definition.limit);
+  if (this.definition?.limit != null) {
+    parts.push("LIMIT ?");
+    params.push(this.definition.limit);
   }
-  if (this.definition?.offset !== null) {
-    sql += ` OFFSET ?`;
-    if (!this.definition.params) this.definition.params = [];
-    this.definition.params.push(this.definition.offset);
+  if (this.definition?.offset != null) {
+    parts.push("OFFSET ?");
+    params.push(this.definition.offset);
   }
   if (this.definition.queryType === constants.QueryType.UPDATE || this.definition.queryType === constants.QueryType.DELETE) {
     if (dialect !== constants$1.Dialect.MYSQL) {
-      sql += ` RETURNING *`;
+      parts.push("RETURNING *");
     }
   }
-  sql = buildQuery(sql);
-  return { query: sql + ";", params: this.definition.params };
+  const sql = buildQuery(parts.join(" "));
+  return { query: `${sql};`, params };
 }
 function toString() {
   return this.toQuery().query;
 }
+function toDebugString() {
+  const { query, params } = this.toQuery();
+  if (!params || params.length === 0) {
+    return query;
+  }
+  let debugQuery = query;
+  utilities.sanitizeParams(params).forEach((param, index) => {
+    const value = param === null ? "NULL" : `'${String(param).replace(/'/g, "''")}'`;
+    debugQuery = debugQuery.replace(
+      new RegExp(`\\$${index + 1}\\b`, "g"),
+      value
+    );
+  });
+  return debugQuery;
+}
+function explain(options = {}) {
+  const { query, params } = this.toQuery();
+  const explainPrefix = explain$1.buildExplainQuery(this, options);
+  if (!this.table.client) {
+    throw new Error("Database client not defined");
+  }
+  return this.table.client.exec({
+    sql: `${explainPrefix}${query}`,
+    params
+  });
+}
 async function exec(tx) {
   const client = this.table.client;
   const dialect = this.table.dialect;
@@ -128,5 +165,7 @@ async function exec(tx) {
 
 exports.buildQuery = buildQuery;
 exports.exec = exec;
+exports.explain = explain;
+exports.toDebugString = toDebugString;
 exports.toQuery = toQuery;
 exports.toString = toString;

package/dist/cjs/query/types.d.cts

@@ -1,8 +1,8 @@
+import 'bun';
 import '../column/index.cjs';
 import '../column/constants.cjs';
-export { l as AcceptedInsertValues, k as AcceptedOrderBy, m as AcceptedUpdateValues, n as AggregateColumn, A as AliasedColumn, C as ColumnSelector, h as QuerHooks, Q as QueryDefinition, p as QueryOutput, j as QueryRunHooks, q as QueryRunHooksOptions, R as RawColumn, o as SelectQueryOutput, g as SelectableColumn, e as StrictColumnSelector, W as WhereValue } from '../index-CnQVnCEI.cjs';
+export { r as AcceptedInsertValues, q as AcceptedOrderBy, s as AcceptedUpdateValues, t as AggregateColumn, A as AliasedColumn, C as ColumnSelector, E as ExplainOptions, Q as QueryDefinition, n as QueryHooks, v as QueryOutput, p as QueryRunHooks, w as QueryRunHooksOptions, R as RawColumn, u as SelectQueryOutput, d as SelectableColumn, S as StrictColumnSelector, W as WhereValue } from '../index-K07efKgt.cjs';
 import '../types.cjs';
 import './constants.cjs';
 import '../table/constants.cjs';
 import '../column/types.cjs';
-import 'bun';

package/dist/cjs/query/utilities.d.cts

@@ -1,17 +1,16 @@
-import { T as Table, W as WhereValue, Q as QueryDefinition, C as ColumnSelector, e as StrictColumnSelector, f as QueryBuilder, A as AliasedColumn, g as SelectableColumn } from '../index-CnQVnCEI.cjs';
+import { T as Table, Q as QueryDefinition, C as ColumnSelector, S as StrictColumnSelector, c as QueryBuilder, A as AliasedColumn, d as SelectableColumn } from '../index-K07efKgt.cjs';
 import { Column } from '../column/index.cjs';
-import { Dialect } from '../table/constants.cjs';
-import { AcceptedOperator } from './constants.cjs';
-import '../column/constants.cjs';
-import '../types.cjs';
 import 'bun';
+import '../types.cjs';
+import './constants.cjs';
+import '../column/constants.cjs';
+import '../table/constants.cjs';
 import '../column/types.cjs';
 
 declare function getTableColumnNames<ColName extends string, BaseAlias extends string, BaseTable extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>>(column: ColName, baseAlias: BaseAlias, baseTable: BaseTable, joinedTables: JoinedTables): {
     from: string;
     columns: string[];
 };
-declare function getCondition<DbDialect extends Dialect, ColName extends string, Operator extends AcceptedOperator, Value extends WhereValue<Column>[Operator]>(dialect: DbDialect, column: ColName, operator: Operator, value: Value): string;
 declare function getTimestamp<TableRef extends Table<string, Record<string, Column>>>(table: TableRef): {
     isWithTimestamp: boolean;
     timestamp: Date;
@@ -25,7 +24,6 @@ declare function getParanoid<TableRef extends Table<string, Record<string, Colum
     timestamp: Date;
     deletedAt: string;
 };
-declare function getWhereConditions<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(q: Query): string[];
 declare function getGroupByConditions<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(q: Query): (string | AliasedColumn<ColumnSelector<Alias, TableRef, JoinedTables>, string>)[];
 declare function getTableSelectName<Alias extends string, TableRef extends Table<string, Record<string, Column>>, JoinedTables extends Record<string, Table<string, Record<string, Column>>>, Definition extends Partial<QueryDefinition<Alias, TableRef, JoinedTables>>, AllowedColumn extends ColumnSelector<Alias, TableRef, JoinedTables>, StrictAllowedColumn extends StrictColumnSelector<Alias, TableRef, JoinedTables>, Query extends QueryBuilder<Alias, TableRef, JoinedTables, Definition, AllowedColumn, StrictAllowedColumn>>(q: Query): string;
 declare function parseAliasedRow({ row, selects, root, }: {
@@ -33,5 +31,6 @@ declare function parseAliasedRow({ row, selects, root, }: {
     selects: SelectableColumn<string>[];
     root?: string | null;
 }): Record<string, any>;
+declare function sanitizeParams(params: unknown[]): (string | number | bigint | boolean | null)[];
 
-export { getCondition, getGroupByConditions, getParanoid, getTableColumnNames, getTableSelectName, getTimestamp, getWhereConditions, parseAliasedRow };
+export { getGroupByConditions, getParanoid, getTableColumnNames, getTableSelectName, getTimestamp, parseAliasedRow, sanitizeParams };