orchid-orm 1.12.0 → 1.12.2

package/dist/index.d.ts

@@ -69,6 +69,63 @@ type OrchidORM<T extends TableClasses = TableClasses> = {
     $transaction: typeof transaction;
     $adapter: Adapter;
     $queryBuilder: Db;
+    /**
+     * Use `$query` to perform raw SQL queries.
+     *
+     * ```ts
+     * const value = 1;
+     *
+     * // it is safe to interpolate inside the backticks (``):
+     * const result = await db.$query<{ one: number }>`SELECT ${value} AS one`;
+     * // data is inside `rows` array:
+     * result.rows[0].one;
+     * ```
+     *
+     * If the query is executing inside a transaction, it will use the transaction connection automatically.
+     *
+     * ```ts
+     * await db.transaction(async () => {
+     *   // both queries will execute in the same transaction
+     *   await db.$query`SELECT 1`;
+     *   await db.$query`SELECT 2`;
+     * });
+     * ```
+     *
+     * Alternatively, support a simple SQL string, with optional `values`:
+     *
+     * Note that the values is a simple array, and the SQL is referring to the values with `$1`, `$2` and so on.
+     *
+     * ```ts
+     * const value = 1;
+     *
+     * // it is NOT safe to interpolate inside a simple string, use `values` to pass the values.
+     * const result = await db.$query<{ one: number }>({
+     *   raw: 'SELECT $1 AS one',
+     *   values: [value],
+     * });
+     * // data is inside `rows` array:
+     * result.rows[0].one;
+     * ```
+     *
+     * @param args - SQL template literal, or an object { raw: string, values?: unknown[] }
+     */
+    $query: Db['query'];
+    /**
+     * The same as the {@link $query}, but returns an array of arrays instead of objects:
+     *
+     * ```ts
+     * const value = 1;
+     *
+     * // it is safe to interpolate inside the backticks (``):
+     * const result = await db.$queryArrays<[number]>`SELECT ${value} AS one`;
+     * // `rows` is an array of arrays:
+     * const row = result.rows[0];
+     * row[0]; // our value
+     * ```
+     *
+     * @param args - SQL template literal, or an object { raw: string, values?: unknown[] }
+     */
+    $queryArrays: Db['queryArrays'];
     $from<Args extends FromArgs<Query>>(...args: Args): FromResult<Query, Args>;
     $close(): Promise<void>;
 };
@@ -315,7 +372,7 @@ declare const createBaseTable: <CT extends Record<string, orchid_core.AnyColumnT
             }) | undefined): {};
             check(check: orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, orchid_core.ColumnDataBase>, {}>): {};
         } : CT;
-        query: QueryData;
+        q: QueryData;
         filePath: string;
         result: ColumnsShapeBase;
         clone<T_20 extends QueryBase>(this: T_20): T_20;

package/dist/index.js

@@ -28,7 +28,7 @@ const create = (columnTypes, filePathOrStack, snakeCase, nowSQL, exportAs = "Bas
     constructor() {
       this.snakeCase = snakeCase;
       this.columnTypes = columnTypes;
-      this.query = {};
+      this.q = {};
     }
     static getFilePath() {
       if (filePath)
@@ -141,20 +141,20 @@ class BelongsToVirtualColumn extends pqb.VirtualColumn {
     }
     const relationData = [values];
     store.belongsTo[key] = relationData;
-    q.query.wrapInTransaction = true;
+    q.q.wrapInTransaction = true;
     pqb.pushQueryValue(q, "beforeCreate", async (q2) => {
       const inserted = await this.nestedInsert(
         q2,
         relationData.map(([, , data]) => data)
       );
-      const { values: values2 } = q2.query;
+      const { values: values2 } = q2.q;
       relationData.forEach(([rowIndex2, columnIndex2], index) => {
         values2[rowIndex2][columnIndex2] = inserted[index][primaryKey];
       });
     });
   }
   update(q, ctx, set) {
-    q.query.wrapInTransaction = true;
+    q.q.wrapInTransaction = true;
     const data = set[this.key];
     if (this.nestedUpdate(q, set, data, ctx)) {
       ctx.willSetKeys = true;
@@ -254,14 +254,14 @@ const nestedUpdate$3 = ({ query, primaryKey, foreignKey }) => {
         update[foreignKey] = await query.get(primaryKey)._create(params.create);
       } else if (params.delete) {
         const selectQuery = q2.clone();
-        selectQuery.query.type = void 0;
+        selectQuery.q.type = void 0;
         idsForDelete = await selectQuery._pluck(foreignKey);
         update[foreignKey] = null;
       }
     });
     const { upsert } = params;
     if (upsert || params.update || params.delete) {
-      if (!((_a = q.query.select) == null ? void 0 : _a.includes("*")) && !((_b = q.query.select) == null ? void 0 : _b.includes(foreignKey))) {
+      if (!((_a = q.q.select) == null ? void 0 : _a.includes("*")) && !((_b = q.q.select) == null ? void 0 : _b.includes(foreignKey))) {
         q._select(foreignKey);
       }
     }
@@ -316,7 +316,7 @@ const hasRelationHandleCreate = (q, ctx, item, rowIndex, key, primaryKey, nested
     store.hasRelation[key].push(values);
     return;
   }
-  q.query.wrapInTransaction = true;
+  q.q.wrapInTransaction = true;
   const relationData = [values];
   store.hasRelation[key] = relationData;
   q._afterCreate(
@@ -335,10 +335,10 @@ const hasRelationHandleUpdate = (q, set, key, primaryKey, nestedUpdate) => {
   const value = set[key];
   if (!value.set && !("upsert" in value) && (!value.disconnect || Array.isArray(value.disconnect) && value.disconnect.length === 0) && (!value.delete || Array.isArray(value.delete) && value.delete.length === 0) && (!value.update || Array.isArray(value.update.where) && value.update.where.length === 0) && (!value.create || Array.isArray(value.create) && value.create.length === 0))
     return;
-  if (!((_a = q.query.select) == null ? void 0 : _a.includes("*")) && !((_b = q.query.select) == null ? void 0 : _b.includes(primaryKey))) {
+  if (!((_a = q.q.select) == null ? void 0 : _a.includes("*")) && !((_b = q.q.select) == null ? void 0 : _b.includes(primaryKey))) {
     q._select(primaryKey);
   }
-  q.query.wrapInTransaction = true;
+  q.q.wrapInTransaction = true;
   q._afterUpdate(q.primaryKeys, (rows, q2) => {
     return nestedUpdate(
       q2,
@@ -464,8 +464,10 @@ const makeHasOneMethod = (table, relation, relationName, query) => {
     modifyRelatedQuery(relationQuery) {
       return (query2) => {
         const fromQuery = query2.clone();
-        fromQuery.query.select = fromQuerySelect;
-        relationQuery.query.values = { from: fromQuery };
+        fromQuery.q.select = fromQuerySelect;
+        const q = relationQuery.q;
+        q.kind = "from";
+        q.values = { from: fromQuery };
       };
     }
   };
@@ -661,8 +663,10 @@ const makeHasManyMethod = (table, relation, relationName, query) => {
     modifyRelatedQuery(relationQuery) {
       return (query2) => {
         const fromQuery = query2.clone();
-        fromQuery.query.select = fromQuerySelect;
-        relationQuery.query.values = { from: fromQuery };
+        fromQuery.q.select = fromQuerySelect;
+        const q = relationQuery.q;
+        q.kind = "from";
+        q.values = { from: fromQuery };
       };
     }
   };
@@ -751,7 +755,7 @@ const nestedUpdate$1 = ({ query, primaryKey, foreignKey }) => {
           [foreignKey]: data[0][primaryKey]
         }))
       );
-      delete t.query[pqb.toSqlCacheKey];
+      delete t.q[pqb.toSqlCacheKey];
     }
     if (params.disconnect || params.set) {
       await t.where(
@@ -763,7 +767,7 @@ const nestedUpdate$1 = ({ query, primaryKey, foreignKey }) => {
         )
       )._update({ [foreignKey]: null });
       if (params.set) {
-        delete t.query[pqb.toSqlCacheKey];
+        delete t.q[pqb.toSqlCacheKey];
         await t.where(
           Array.isArray(params.set) ? {
             OR: params.set
@@ -772,7 +776,7 @@ const nestedUpdate$1 = ({ query, primaryKey, foreignKey }) => {
       }
     }
     if (params.delete || params.update) {
-      delete t.query[pqb.toSqlCacheKey];
+      delete t.q[pqb.toSqlCacheKey];
       const q = t._where(
         getWhereForNestedUpdate(
           data,
@@ -863,7 +867,7 @@ const makeHasAndBelongsToManyMethod = (table, qb, relation, relationName, query)
     [fk]: removeColumnName(table.shape[pk]),
     [afk]: removeColumnName(query.shape[apk])
   };
-  baseQuery.query = __spreadProps$1(__spreadValues$3({}, baseQuery.query), {
+  baseQuery.q = __spreadProps$1(__spreadValues$3({}, baseQuery.q), {
     shape: baseQuery.shape
   });
   const subQuery = Object.create(baseQuery);
@@ -896,8 +900,8 @@ const makeHasAndBelongsToManyMethod = (table, qb, relation, relationName, query)
         subQuery,
         (q) => q._on(associationForeignKeyFull, `${pqb.getQueryAs(toQuery)}.${apk}`)._on(foreignKeyFull, `${pqb.getQueryAs(fromQuery)}.${pk}`)
       );
-      join.query.joinedShapes = __spreadProps$1(__spreadValues$3({}, join.query.joinedShapes), {
-        [fromQuery.query.as || fromQuery.table]: fromQuery.query.shape
+      join.q.joinedShapes = __spreadProps$1(__spreadValues$3({}, join.q.joinedShapes), {
+        [fromQuery.q.as || fromQuery.table]: fromQuery.q.shape
       });
       return join;
     },
@@ -917,8 +921,8 @@ const makeHasAndBelongsToManyMethod = (table, qb, relation, relationName, query)
             "Creating multiple `hasAndBelongsToMany` records is not yet supported"
           );
         }
-        const fromQuery = ref.query.clone();
-        fromQuery.query.select = [{ selectAs: { [fk]: pk } }];
+        const fromQuery = ref.q.clone();
+        fromQuery.q.select = [{ selectAs: { [fk]: pk } }];
         const createdCount = await subQuery.count()._createFrom(
           // eslint-disable-next-line @typescript-eslint/no-explicit-any
           fromQuery,
@@ -931,7 +935,7 @@ const makeHasAndBelongsToManyMethod = (table, qb, relation, relationName, query)
         }
       });
       return (q) => {
-        ref.query = q;
+        ref.q = q;
       };
     }
   };
@@ -1118,7 +1122,7 @@ const nestedUpdate = (state) => {
     if (params.set) {
       const j = queryJoinTable(state, data);
       await j._delete();
-      delete j.query[pqb.toSqlCacheKey];
+      delete j.q[pqb.toSqlCacheKey];
       const ids = await queryRelatedTable(
         state.relatedTableQuery,
         params.set
@@ -1267,10 +1271,10 @@ const applyRelation = (qb, { relationName, relation, dbTable, otherDbTable }, de
     } else {
       query._takeOptional();
     }
-    query.query.returnsOne = true;
+    query.q.returnsOne = true;
   }
   if (data.virtualColumn) {
-    dbTable.shape[relationName] = dbTable.query.shape[relationName] = data.virtualColumn;
+    dbTable.shape[relationName] = dbTable.q.shape[relationName] = data.virtualColumn;
   }
   makeRelationQuery(dbTable, relationName, data, query);
   baseQuery.joinQuery = data.joinQuery;
@@ -1280,7 +1284,7 @@ const applyRelation = (qb, { relationName, relation, dbTable, otherDbTable }, de
       return originalJoin.apply(this, args);
     } else {
       const q = this.clone();
-      q.query.innerJoinLateral = true;
+      q.q.innerJoinLateral = true;
       return q;
     }
   };
@@ -1310,10 +1314,10 @@ const makeRelationQuery = (table, relationName, data, q) => {
         this.baseQuery,
         (q2) => data.reverseJoin(this, toTable)
       );
-      query.query.joinedShapes = __spreadValues$2({
-        [pqb.getQueryAs(this)]: this.query.shape
-      }, this.query.joinedShapes);
-      query.query[pqb.relationQueryKey] = {
+      query.q.joinedShapes = __spreadValues$2({
+        [pqb.getQueryAs(this)]: this.q.shape
+      }, this.q.joinedShapes);
+      query.q[pqb.relationQueryKey] = {
         relationName,
         sourceQuery: this,
         relationQuery: toTable,
@@ -1390,7 +1394,7 @@ const orchidORM = (_a, tables) => {
   let transactionStorage;
   let qb;
   if ("db" in options) {
-    adapter = options.db.query.adapter;
+    adapter = options.db.q.adapter;
     transactionStorage = options.db.internal.transactionStorage;
     qb = options.db.queryBuilder;
   } else {
@@ -1411,6 +1415,8 @@ const orchidORM = (_a, tables) => {
     $transaction: transaction,
     $adapter: adapter,
     $queryBuilder: qb,
+    $query: (...args) => qb.query(...args),
+    $queryArrays: (...args) => qb.queryArrays(...args),
     $from: (...args) => qb.from(...args),
     $close: () => adapter.close()
   };
@@ -1447,7 +1453,7 @@ const orchidORM = (_a, tables) => {
     const table = tableInstances[key];
     if (table.init) {
       table.init(result);
-      Object.assign(result[key].baseQuery.query, table.query);
+      Object.assign(result[key].baseQuery.q, table.q);
     }
   }
   return result;
@@ -1476,7 +1482,7 @@ const createRepo = (table, methods) => {
     const proto = Object.create(q2.baseQuery);
     proto.baseQuery = proto;
     const result = Object.create(proto);
-    result.query = pqb.getClonedQueryData(q2.query);
+    result.q = pqb.getClonedQueryData(q2.q);
     if (plainMethods) {
       Object.assign(proto.baseQuery, plainMethods);
     }