kysely 0.19.6 → 0.19.9

package/dist/esm/operation-node/select-query-node.d.ts

@@ -13,18 +13,18 @@ import { SelectionNode } from './selection-node.js';
 import { WhereNode } from './where-node.js';
 import { WithNode } from './with-node.js';
 import { UnionNode } from './union-node.js';
-export declare type SelectModifier = 'ForUpdate' | 'ForNoKeyUpdate' | 'ForShare' | 'ForKeyShare' | 'NoWait' | 'SkipLocked';
+import { SelectModifierNode } from './select-modifier-node.js';
 export interface SelectQueryNode extends OperationNode {
     readonly kind: 'SelectQueryNode';
     readonly from: FromNode;
     readonly selections?: ReadonlyArray<SelectionNode>;
     readonly distinctOnSelections?: ReadonlyArray<SelectionNode>;
-    readonly distinct?: boolean;
     readonly joins?: ReadonlyArray<JoinNode>;
     readonly groupBy?: GroupByNode;
     readonly orderBy?: OrderByNode;
     readonly where?: WhereNode;
-    readonly modifiers?: ReadonlyArray<SelectModifier>;
+    readonly frontModifiers?: ReadonlyArray<SelectModifierNode>;
+    readonly endModifiers?: ReadonlyArray<SelectModifierNode>;
     readonly limit?: LimitNode;
     readonly offset?: OffsetNode;
     readonly with?: WithNode;
@@ -39,13 +39,13 @@ export declare const SelectQueryNode: Readonly<{
     create(fromItems: ReadonlyArray<TableExpressionNode>, withNode?: WithNode): SelectQueryNode;
     cloneWithSelections(select: SelectQueryNode, selections: ReadonlyArray<SelectionNode>): SelectQueryNode;
     cloneWithDistinctOnSelections(select: SelectQueryNode, selections: ReadonlyArray<SelectionNode>): SelectQueryNode;
-    cloneWithModifier(select: SelectQueryNode, modifier: SelectModifier): SelectQueryNode;
+    cloneWithFrontModifier(select: SelectQueryNode, modifier: SelectModifierNode): SelectQueryNode;
+    cloneWithEndModifier(select: SelectQueryNode, modifier: SelectModifierNode): SelectQueryNode;
     cloneWithOrderByItem(selectNode: SelectQueryNode, item: OrderByItemNode): SelectQueryNode;
     cloneWithGroupByItems(selectNode: SelectQueryNode, items: ReadonlyArray<GroupByItemNode>): SelectQueryNode;
     cloneWithLimit(selectNode: SelectQueryNode, limit: LimitNode): SelectQueryNode;
     cloneWithOffset(selectNode: SelectQueryNode, offset: OffsetNode): SelectQueryNode;
     cloneWithHaving(selectNode: SelectQueryNode, filter: FilterExpressionNode): SelectQueryNode;
     cloneWithOrHaving(selectNode: SelectQueryNode, filter: FilterExpressionNode): SelectQueryNode;
-    cloneWithDistinct(selectNode: SelectQueryNode): SelectQueryNode;
     cloneWithUnion(selectNode: SelectQueryNode, union: UnionNode): SelectQueryNode;
 }>;

package/dist/esm/operation-node/select-query-node.js

@@ -34,11 +34,19 @@ export const SelectQueryNode = freeze({
                 : freeze(selections),
         });
     },
-    cloneWithModifier(select, modifier) {
+    cloneWithFrontModifier(select, modifier) {
         return freeze({
             ...select,
-            modifiers: select.modifiers
-                ? freeze([...select.modifiers, modifier])
+            frontModifiers: select.frontModifiers
+                ? freeze([...select.frontModifiers, modifier])
+                : freeze([modifier]),
+        });
+    },
+    cloneWithEndModifier(select, modifier) {
+        return freeze({
+            ...select,
+            endModifiers: select.endModifiers
+                ? freeze([...select.endModifiers, modifier])
                 : freeze([modifier]),
         });
     },
@@ -86,12 +94,6 @@ export const SelectQueryNode = freeze({
                 : HavingNode.create(filter),
         });
     },
-    cloneWithDistinct(selectNode) {
-        return freeze({
-            ...selectNode,
-            distinct: true,
-        });
-    },
     cloneWithUnion(selectNode, union) {
         return freeze({
             ...selectNode,

package/dist/esm/query-builder/select-query-builder.d.ts

@@ -653,6 +653,50 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
      */
     distinctOn<SE extends SelectExpression<DB, TB>>(selections: ReadonlyArray<SE>): SelectQueryBuilder<DB, TB, O>;
     distinctOn<SE extends SelectExpression<DB, TB>>(selection: SE): SelectQueryBuilder<DB, TB, O>;
+    /**
+     * This can be used to add any additional SQL to the front of the query __after__ the `select` keyword.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .modifyFront(sql`sql_no_cache`)
+     *   .select('first_name')
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * select sql_no_cache `first_name`
+     * from `person`
+     * ```
+     */
+    modifyFront(modifier: AnyRawBuilder): SelectQueryBuilder<DB, TB, O>;
+    /**
+     * This can be used to add any additional SQL to the end of the query.
+     *
+     * Also see {@link forUpdate}, {@link forShare}, {@link forKeyShare}, {@link forNoKeyUpdate}
+     * {@link skipLocked} and  {@link noWait}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select('first_name')
+     *   .modifyEnd(sql`for update`)
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select "first_name"
+     * from "person"
+     * for update
+     * ```
+     */
+    modifyEnd(modifier: AnyRawBuilder): SelectQueryBuilder<DB, TB, O>;
     /**
      * Makes the selection distinct.
      *
@@ -673,27 +717,27 @@ export declare class SelectQueryBuilder<DB, TB extends keyof DB, O> implements W
      */
     distinct(): SelectQueryBuilder<DB, TB, O>;
     /**
-     * Adds the `for update` option to a select query on supported databases.
+     * Adds the `for update` modifier to a select query on supported databases.
      */
     forUpdate(): SelectQueryBuilder<DB, TB, O>;
     /**
-     * Adds the `for share` option to a select query on supported databases.
+     * Adds the `for share` modifier to a select query on supported databases.
      */
     forShare(): SelectQueryBuilder<DB, TB, O>;
     /**
-     * Adds the `for key share` option to a select query on supported databases.
+     * Adds the `for key share` modifier to a select query on supported databases.
      */
     forKeyShare(): SelectQueryBuilder<DB, TB, O>;
     /**
-     * Adds the `for no key update` option to a select query on supported databases.
+     * Adds the `for no key update` modifier to a select query on supported databases.
      */
     forNoKeyUpdate(): SelectQueryBuilder<DB, TB, O>;
     /**
-     * Adds the `skip locked` option to a select query on supported databases.
+     * Adds the `skip locked` modifier to a select query on supported databases.
      */
     skipLocked(): SelectQueryBuilder<DB, TB, O>;
     /**
-     * Adds the `nowait` option to a select query on supported databases.
+     * Adds the `nowait` modifier to a select query on supported databases.
      */
     noWait(): SelectQueryBuilder<DB, TB, O>;
     /**

package/dist/esm/query-builder/select-query-builder.js

@@ -14,6 +14,7 @@ import { parseGroupBy } from '../parser/group-by-parser.js';
 import { parseUnion } from '../parser/union-parser.js';
 import { NoResultError } from './no-result-error.js';
 import { IdentifierNode } from '../operation-node/identifier-node.js';
+import { SelectModifierNode } from '../operation-node/select-modifier-node.js';
 export class SelectQueryBuilder {
     #props;
     constructor(props) {
@@ -127,6 +128,60 @@ export class SelectQueryBuilder {
             queryNode: SelectQueryNode.cloneWithDistinctOnSelections(this.#props.queryNode, parseSelectExpressionOrList(selection)),
         });
     }
+    /**
+     * This can be used to add any additional SQL to the front of the query __after__ the `select` keyword.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .modifyFront(sql`sql_no_cache`)
+     *   .select('first_name')
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * select sql_no_cache `first_name`
+     * from `person`
+     * ```
+     */
+    modifyFront(modifier) {
+        return new SelectQueryBuilder({
+            ...this.#props,
+            queryNode: SelectQueryNode.cloneWithFrontModifier(this.#props.queryNode, SelectModifierNode.createWithRaw(modifier.toOperationNode())),
+        });
+    }
+    /**
+     * This can be used to add any additional SQL to the end of the query.
+     *
+     * Also see {@link forUpdate}, {@link forShare}, {@link forKeyShare}, {@link forNoKeyUpdate}
+     * {@link skipLocked} and  {@link noWait}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.selectFrom('person')
+     *   .select('first_name')
+     *   .modifyEnd(sql`for update`)
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * select "first_name"
+     * from "person"
+     * for update
+     * ```
+     */
+    modifyEnd(modifier) {
+        return new SelectQueryBuilder({
+            ...this.#props,
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.createWithRaw(modifier.toOperationNode())),
+        });
+    }
     /**
      * Makes the selection distinct.
      *
@@ -148,61 +203,61 @@ export class SelectQueryBuilder {
     distinct() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithDistinct(this.#props.queryNode),
+            queryNode: SelectQueryNode.cloneWithFrontModifier(this.#props.queryNode, SelectModifierNode.create('Distinct')),
         });
     }
     /**
-     * Adds the `for update` option to a select query on supported databases.
+     * Adds the `for update` modifier to a select query on supported databases.
      */
     forUpdate() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithModifier(this.#props.queryNode, 'ForUpdate'),
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.create('ForUpdate')),
         });
     }
     /**
-     * Adds the `for share` option to a select query on supported databases.
+     * Adds the `for share` modifier to a select query on supported databases.
      */
     forShare() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithModifier(this.#props.queryNode, 'ForShare'),
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.create('ForShare')),
         });
     }
     /**
-     * Adds the `for key share` option to a select query on supported databases.
+     * Adds the `for key share` modifier to a select query on supported databases.
      */
     forKeyShare() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithModifier(this.#props.queryNode, 'ForKeyShare'),
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.create('ForKeyShare')),
         });
     }
     /**
-     * Adds the `for no key update` option to a select query on supported databases.
+     * Adds the `for no key update` modifier to a select query on supported databases.
      */
     forNoKeyUpdate() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithModifier(this.#props.queryNode, 'ForNoKeyUpdate'),
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.create('ForNoKeyUpdate')),
         });
     }
     /**
-     * Adds the `skip locked` option to a select query on supported databases.
+     * Adds the `skip locked` modifier to a select query on supported databases.
      */
     skipLocked() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithModifier(this.#props.queryNode, 'SkipLocked'),
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.create('SkipLocked')),
         });
     }
     /**
-     * Adds the `nowait` option to a select query on supported databases.
+     * Adds the `nowait` modifier to a select query on supported databases.
      */
     noWait() {
         return new SelectQueryBuilder({
             ...this.#props,
-            queryNode: SelectQueryNode.cloneWithModifier(this.#props.queryNode, 'NoWait'),
+            queryNode: SelectQueryNode.cloneWithEndModifier(this.#props.queryNode, SelectModifierNode.create('NoWait')),
         });
     }
     selectAll(table) {

package/dist/esm/query-compiler/default-query-compiler.d.ts

@@ -68,6 +68,7 @@ import { DefaultValueNode } from '../operation-node/default-value-node.js';
 import { OnNode } from '../operation-node/on-node.js';
 import { ValuesNode } from '../operation-node/values-node.js';
 import { CommonTableExpressionNameNode } from '../operation-node/common-table-expression-name-node.js';
+import { SelectModifierNode } from '../operation-node/select-modifier-node.js';
 export declare class DefaultQueryCompiler extends OperationNodeVisitor implements QueryCompiler {
     #private;
     protected get numParameters(): number;
@@ -143,6 +144,7 @@ export declare class DefaultQueryCompiler extends OperationNodeVisitor implement
     protected visitDropView(node: DropViewNode): void;
     protected visitGenerated(node: GeneratedNode): void;
     protected visitDefaultValue(node: DefaultValueNode): void;
+    protected visitSelectModifier(node: SelectModifierNode): void;
     protected append(str: string): void;
     protected appendValue(parameter: unknown): void;
     protected getLeftIdentifierWrapper(): string;

package/dist/esm/query-compiler/default-query-compiler.js

@@ -42,8 +42,8 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.compileDistinctOn(node.distinctOnSelections);
             this.append(' ');
         }
-        if (node.distinct) {
-            this.append('distinct');
+        if (node.frontModifiers && node.frontModifiers.length > 0) {
+            this.compileList(node.frontModifiers, ' ');
             this.append(' ');
         }
         if (node.selections) {
@@ -83,11 +83,9 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
             this.append(' ');
             this.visitNode(node.offset);
         }
-        if (node.modifiers) {
-            node.modifiers.forEach((modifier) => {
-                this.append(' ');
-                this.append(SELECT_MODIFIER_SQL[modifier]);
-            });
+        if (node.endModifiers && node.endModifiers.length > 0) {
+            this.append(' ');
+            this.compileList(node.endModifiers, ' ');
         }
         if (wrapInParens) {
             this.append(')');
@@ -783,6 +781,14 @@ export class DefaultQueryCompiler extends OperationNodeVisitor {
         this.append('default ');
         this.visitNode(node.defaultValue);
     }
+    visitSelectModifier(node) {
+        if (node.rawModifier) {
+            this.visitNode(node.rawModifier);
+        }
+        else {
+            this.append(SELECT_MODIFIER_SQL[node.modifier]);
+        }
+    }
     append(str) {
         this.#sql += str;
     }
@@ -830,6 +836,7 @@ const SELECT_MODIFIER_SQL = freeze({
     ForShare: 'for share',
     NoWait: 'nowait',
     SkipLocked: 'skip locked',
+    Distinct: 'distinct',
 });
 const JOIN_TYPE_SQL = freeze({
     InnerJoin: 'inner join',

package/dist/esm/util/require-all-props.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Utility type to force use of all properties of T.
+ *
+ * Similar to Required<T> build-in type, but allows `undefined` values.
+ */
+declare type AllProps<T> = T & {
+    [P in keyof T]-?: unknown;
+};
+/**
+ * Helper function to check listed properties according to given type. Check if all properties has been used when object is initialised.
+ *
+ * Example use:
+ *
+ * ```ts
+ * type SomeType = { propA: string; propB?: number; }
+ *
+ * // propB has to be mentioned even it is optional. It still should be initialized with undefined.
+ * const a: SomeType = requireAllProps<SomeType>({ propA: "value A", propB: undefined });
+ *
+ * // checked type is implicit for variable.
+ * const b = requireAllProps<SomeType>({ propA: "value A", propB: undefined });
+ * ```
+ *
+ * Wrong use of this helper:
+ *
+ * 1. Omit checked type - all checked properties will be expect as of type never
+ *
+ * ```ts
+ * const z: SomeType = requireAllProps({ propC: "no type will work" });
+ * ```
+ *
+ * 2. Apply to spreaded object - there is no way how to check in compile time if spreaded object contains all properties
+ *
+ * ```ts
+ * const y: SomeType = { propA: "" }; // valid object according to SomeType declaration
+ * const x = requireAllProps<SomeType>( { ... y } );
+ * ```
+ *
+ * @param obj object to check if all properties has been used
+ * @returns untouched obj parameter is returned
+ */
+export declare function requireAllProps<T>(obj: AllProps<T>): T;
+export {};

package/dist/esm/util/require-all-props.js

@@ -0,0 +1,37 @@
+/// <reference types="./require-all-props.d.ts" />
+/**
+ * Helper function to check listed properties according to given type. Check if all properties has been used when object is initialised.
+ *
+ * Example use:
+ *
+ * ```ts
+ * type SomeType = { propA: string; propB?: number; }
+ *
+ * // propB has to be mentioned even it is optional. It still should be initialized with undefined.
+ * const a: SomeType = requireAllProps<SomeType>({ propA: "value A", propB: undefined });
+ *
+ * // checked type is implicit for variable.
+ * const b = requireAllProps<SomeType>({ propA: "value A", propB: undefined });
+ * ```
+ *
+ * Wrong use of this helper:
+ *
+ * 1. Omit checked type - all checked properties will be expect as of type never
+ *
+ * ```ts
+ * const z: SomeType = requireAllProps({ propC: "no type will work" });
+ * ```
+ *
+ * 2. Apply to spreaded object - there is no way how to check in compile time if spreaded object contains all properties
+ *
+ * ```ts
+ * const y: SomeType = { propA: "" }; // valid object according to SomeType declaration
+ * const x = requireAllProps<SomeType>( { ... y } );
+ * ```
+ *
+ * @param obj object to check if all properties has been used
+ * @returns untouched obj parameter is returned
+ */
+export function requireAllProps(obj) {
+    return obj;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.19.6",
+  "version": "0.19.9",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",