pqb 0.36.16 → 0.37.0

package/dist/index.d.ts

@@ -220,6 +220,7 @@ type WhereJsonPathEqualsItem = [
 interface WhereOnItem {
     joinFrom: WhereOnJoinItem;
     joinTo: WhereOnJoinItem;
+    useOuterJoinOverrides?: true;
     on: [leftFullColumn: string, rightFullColumn: string] | [leftFullColumn: string, op: string, rightFullColumn: string];
 }
 type WhereOnJoinItem = {
@@ -380,6 +381,7 @@ interface CommonQueryData {
     joinedForSelect?: string;
     innerJoinLateral?: true;
     joinOverrides?: JoinOverrides;
+    outerJoinOverrides?: JoinOverrides;
     schema?: string;
     select?: SelectItem[];
     expr?: Expression;
@@ -817,7 +819,7 @@ declare class Join {
      *
      * All the `join` methods accept the same arguments, but returning type is different because with `join` it's guaranteed to load joined table, and with `leftJoin` the joined table columns may be `NULL` when no matching record was found.
      *
-     * For the following examples, imagine we have a `User` table with `id` and `name`, and `Message` table with `id`, `text`, messages belongs to user via `userId` column:
+     * For the following examples, imagine you have a `User` table with `id` and `name`, and `Message` table with `id`, `text`, messages belongs to user via `userId` column:
      *
      * ```ts
      * export class UserTable extends BaseTable {
@@ -895,7 +897,7 @@ declare class Join {
      * ```ts
      * const result = await db.user
      *   .join('messages')
-     *   // after joining a table, we can use it in `where` conditions:
+     *   // after joining a table, you can use it in `where` conditions:
      *   .where({ 'messages.text': { startsWith: 'Hi' } })
      *   .select(
      *     'name', // name is User column, table name may be omitted
@@ -906,8 +908,8 @@ declare class Join {
      * const ok: { name: string; text: string }[] = result;
      * ```
      *
-     * The first argument can also be a callback, where instead of relation name as a string we're picking it as a property of `q`.
-     * In such a way, we can alias the relation with `as`, add `where` conditions, use other query methods.
+     * The first argument can also be a callback, where instead of relation name as a string you're picking it as a property of `q`.
+     * In such a way, you can alias the relation with `as`, add `where` conditions, use other query methods.
      *
      * ```ts
      * const result = await db.user.join((q) =>
@@ -924,7 +926,7 @@ declare class Join {
      *   (q) => q.messages.as('m'),
      *   (q) =>
      *     q
-     *       .on('text', 'name') // additionally, match message with user name
+     *       .on('messages.text', 'user.name') // additionally, match message with user name
      *       .where({ text: 'some text' }), // you can add `where` in a second callback as well.
      * );
      * ```
@@ -978,17 +980,16 @@ declare class Join {
      * Joined table can be references from `where` and `select` by a table name.
      *
      * ```ts
-     * // Join message where userId = id:
      * db.user
-     *   .join(db.message, 'userId', 'id')
+     *   .join(db.message, 'userId', 'user.id')
      *   .where({ 'message.text': { startsWith: 'Hi' } })
      *   .select('name', 'message.text');
      * ```
      *
-     * Columns in the join list may be prefixed with table names for clarity:
+     * The name of the joining table can be omitted, but not the name of the main table:
      *
      * ```ts
-     * db.user.join(db.message, 'message.userId', 'user.id');
+     * db.user.join(db.message, 'userId', 'user.id');
      * ```
      *
      * Joined table can have an alias for referencing it further:
@@ -1019,7 +1020,7 @@ declare class Join {
      * You can provide a custom comparison operator
      *
      * ```ts
-     * db.user.join(db.message, 'userId', '!=', 'id');
+     * db.user.join(db.message, 'userId', '!=', 'user.id');
      * ```
      *
      * Join can accept raw SQL for the `ON` part of join:
@@ -1054,11 +1055,11 @@ declare class Join {
      *
      * ```ts
      * db.user.join(db.message, {
-     *   userId: 'id',
-     *
-     *   // with table names:
      *   'message.userId': 'user.id',
      *
+     *   // joined table name may be omitted
+     *   userId: 'user.id',
+     *
      *   // value can be a raw SQL expression:
      *   text: sql`lower("user"."name")`,
      * });
@@ -1077,17 +1078,16 @@ declare class Join {
      *   db.message,
      *   (q) =>
      *     q
-     *       // left column is the db.message column, right column is the db.user column
-     *       .on('userId', 'id')
-     *       // table names can be provided:
      *       .on('message.userId', 'user.id')
+     *       // joined table name may be omitted
+     *       .on('userId', 'user.id')
      *       // operator can be specified:
-     *       .on('userId', '!=', 'id')
+     *       .on('userId', '!=', 'user.id')
      *       // operator can be specified with table names as well:
      *       .on('message.userId', '!=', 'user.id')
      *       // `.orOn` takes the same arguments as `.on` and acts like `.or`:
-     *       .on('userId', 'id') // where message.userId = user.id
-     *       .orOn('text', 'name'), // or message.text = user.name
+     *       .on('userId', 'user.id') // where message.userId = user.id
+     *       .orOn('text', 'user.name'), // or message.text = user.name
      * );
      * ```
      *
@@ -1096,7 +1096,7 @@ declare class Join {
      * ```ts
      * db.user.join(db.message, (q) =>
      *   q
-     *     .on('userId', 'id')
+     *     .on('userId', 'user.id')
      *     .where({
      *       // not prefixed column name is for joined table:
      *       text: { startsWith: 'hello' },
@@ -1131,7 +1131,7 @@ declare class Join {
      *     .where({ text: { startsWith: 'Hi' } })
      *     .as('t'),
      *   'userId',
-     *   'id',
+     *   'user.id',
      * );
      * ```
      *
@@ -1188,7 +1188,7 @@ declare class Join {
      *
      * // the same query, but joining table explicitly
      * const result2: typeof result = await db.user
-     *   .leftJoin(db.message, 'userId', 'id')
+     *   .leftJoin(db.message, 'userId', 'user.id')
      *   .select('name', 'message.text');
      *
      * // result has the following type:
@@ -1260,7 +1260,7 @@ declare class Join {
      *     // select message columns
      *     .select('text')
      *     // join the message to the user, column names can be prefixed with table names
-     *     .on('authorId', 'id')
+     *     .on('authorId', 'user.id')
      *     // message columns are available without prefixing,
      *     // outer table columns are available with a table name
      *     .where({ text: 'some text', 'user.name': 'name' })
@@ -1335,6 +1335,7 @@ declare class Join {
     }): JoinLateralResult<T, Table, Meta, Result, false>;
 }
 type OnArgs<S extends SelectableBase> = [leftColumn: keyof S, rightColumn: keyof S] | [leftColumn: keyof S, op: string, rightColumn: keyof S];
+declare const pushQueryOnForOuter: <T extends PickQueryMeta>(q: T, joinFrom: PickQueryMeta, joinTo: PickQueryMeta, ...on: OnArgs<SelectableBase>) => T;
 declare const pushQueryOn: <T extends PickQueryMeta>(q: T, joinFrom: PickQueryMeta, joinTo: PickQueryMeta, ...on: OnArgs<SelectableBase>) => T;
 declare const pushQueryOrOn: <T extends PickQueryMeta>(q: T, joinFrom: PickQueryMeta, joinTo: PickQueryMeta, ...on: OnArgs<SelectableBase>) => PickQueryQ;
 declare const addQueryOn: <T extends PickQueryMeta>(q: T, joinFrom: PickQueryMeta, joinTo: PickQueryMeta, ...args: OnArgs<SelectableBase>) => T;
@@ -1372,16 +1373,13 @@ declare class OnMethods {
      *
      * ```ts
      * q
-     *   // left column is the db.message column, right column is the db.user column
-     *   .on('userId', 'id')
-     *   // table names can be provided:
      *   .on('message.userId', 'user.id')
+     *   // joined table name may be omitted
+     *   .on('userId', 'user.id')
      *   // operator can be specified:
-     *   .on('userId', '!=', 'id')
+     *   .on('userId', '!=', 'user.id')
      *   // operator can be specified with table names as well:
      *   .on('message.userId', '!=', 'user.id')
-     *   // `.orOn` takes the same arguments as `.on` and acts like `.or`:
-     *   .on('userId', 'id') // where message.userId = user.id
      * ```
      *
      * @param args - columns to join with
@@ -5180,7 +5178,7 @@ declare class Select {
      *
      * // table name may refer to the current table or a joined table:
      * db.table
-     *   .join(Message, 'authorId', 'id')
+     *   .join(Message, 'authorId', 'user.id')
      *   .select('user.name', 'message.text', { textAlias: 'message.text' });
      *
      * // select value from the sub-query,
@@ -5309,7 +5307,7 @@ declare class SqlMethod<ColumnTypes> {
      *
      * ```ts
      * // ids will be prefixed with proper table names, no ambiguity:
-     * db.table.join(db.otherTable, 'id', 'otherId').where`
+     * db.table.join(db.otherTable, 'id', 'other.otherId').where`
      *   ${db.table.column('id')} = 1 AND
      *   ${db.otherTable.ref('id')} = 2
      * `;
@@ -8033,4 +8031,4 @@ type CopyResult<T extends PickQueryMeta> = SetQueryKind<T, 'copy'>;
  */
 declare function copyTableData<T extends PickQueryMetaShape>(query: T, arg: CopyArg<T>): CopyResult<T>;
 
-export { Adapter, AdapterConfig, AdapterOptions, AddQueryDefaults, AfterHook, AggregateMethods, AggregateOptions, AliasOrTable, ArrayColumn, ArrayColumnValue, ArrayData, AsMethods, AsQueryArg, BigIntColumn, BigSerialColumn, BitColumn, BitVaryingColumn, BooleanColumn, BooleanQueryColumn, BoxColumn, ByteaColumn, CidrColumn, CircleColumn, CitextColumn, Clear, ClearStatement, ColumnData, ColumnFromDbParams, ColumnInfoQueryData, ColumnRefExpression, ColumnType, ColumnsByType, ColumnsShape, ColumnsShapeToNullableObject, ColumnsShapeToObject, ColumnsShapeToObjectArray, ColumnsShapeToPluck, CommonQueryData, ComputedColumn, ComputedColumns, ComputedColumnsFromOptions, ComputedMethods, ComputedOptionsFactory, CopyOptions, CopyQueryData, Create, CreateBelongsToData, CreateColumn, CreateCtx, CreateData, CreateKind, CreateMethodsNames, CreateRelationsData, CreateRelationsDataOmittingFKeys, CreateResult, CreateSelf, CustomTypeColumn, DateBaseColumn, DateColumn, DateColumnInput, DateTimeBaseClass, DateTimeTzBaseClass, Db, DbDomainArg, DbDomainArgRecord, DbExtension, DbOptions, DbResult, DbSharedOptions, DbTableConstructor, DbTableOptionScopes, DbTableOptions, DecimalColumn, DecimalColumnData, DefaultColumnTypes, DefaultSchemaConfig, Delete, DeleteArgs, DeleteMethodsNames, DeleteQueryData, DeleteResult, DomainColumn, DoublePrecisionColumn, DynamicRawSQL, EnumColumn, ExpressionMethods, ExpressionOutput, FnExpression, FnExpressionArgs, FnExpressionArgsPairs, FnExpressionArgsValue, For, FromArg, FromMethods, FromQuerySelf, FromResult, GetArg, GetColumnInfo, GetQueryResult, GetResult, GetResultOptional, GetStringArg, GroupArgs, HandleResult, Having, HavingItem, HookAction, HookSelectArg, IdentityColumn, InetColumn, InsertQueryData, IntegerBaseColumn, IntegerColumn, IntervalColumn, IsolationLevel, JSONColumn, JSONTextColumn, Join, JoinArgToQuery, JoinArgs, JoinCallback, JoinFirstArg, JoinItem, JoinItemArgs, JoinLateralItem, JoinLateralResult, JoinOverrides, JoinQueryBuilder, JoinQueryMethod, JoinResult, JoinedParsers, JoinedShapes, JsonMethods, LimitedTextBaseColumn, LineColumn, LsegColumn, MacAddr8Column, MacAddrColumn, MapTableScopesOption, MergeQuery, MergeQueryMethods, MoneyColumn, MoreThanOneRowError, NoPrimaryKeyOption, NotFoundError, NumberAsStringBaseColumn, NumberBaseColumn, NumberColumnData, OnConflictMerge, OnConflictQueryBuilder, OnConflictSet, OnConflictTarget, OnMethods, Operator, Operators, OperatorsAny, OperatorsArray, OperatorsBoolean, OperatorsDate, OperatorsJson, OperatorsNumber, OperatorsText, OperatorsTime, OrCreateArg, OrExpression, OrchidOrmError, OrchidOrmInternalError, OrderArg, OrderArgSelf, OrderArgs, OrderItem, OrderTsQueryConfig, Over, PathColumn, PickColumnData, PickQueryBaseQuery, PickQueryColumnTypes, PickQueryDataShapeAndJoinedShapes, PickQueryInternal, PickQueryMetaRelations, PickQueryMetaResultRelations, PickQueryMetaResultRelationsWindows, PickQueryMetaResultRelationsWindowsColumnTypes, PickQueryMetaResultRelationsWithDataReturnType, PickQueryMetaResultRelationsWithDataReturnTypeShape, PickQueryMetaResultReturnTypeWithDataWindows, PickQueryMetaResultReturnTypeWithDataWindowsTable, PickQueryMetaShapeRelationsWithData, PickQueryMetaTable, PickQueryMetaTableShape, PickQueryMetaTableShapeReturnTypeWithData, PickQueryMetaWithData, PickQueryMetaWithDataColumnTypes, PickQueryQ, PickQueryQAndBaseQuery, PickQueryQAndInternal, PickQueryRelations, PickQueryRelationsWithData, PickQueryResultColumnTypes, PickQueryShapeResultSinglePrimaryKey, PickQueryShapeSinglePrimaryKey, PickQuerySinglePrimaryKey, PickQueryWindows, PickQueryWithData, PickQueryWithDataColumnTypes, PointColumn, PolygonColumn, Query, QueryAfterHook, QueryArraysResult, QueryBase, QueryBaseThen, QueryBatchResult, QueryBeforeHook, QueryComputedArg, QueryData, QueryDataFromItem, QueryDataJoinTo, QueryDefaultReturnData, QueryError, QueryErrorName, QueryGet, QueryGetSelf, QueryHelperResult, QueryHooks, QueryInternal, QueryLog, QueryMetaHasSelect, QueryMetaHasWhere, QueryMethods, QueryOrExpression, QueryOrExpressionBooleanOrNullResult, QueryResult, QueryScopeData, QueryScopes, QuerySourceItem, QueryUpsertOrCreate, QueryWithTable, RawSQL, RealColumn, RecordOfColumnsShapeBase, RefExpression, RelationConfigBase, RelationConfigDataForCreate, RelationJoinQuery, RelationQuery, RelationQueryBase, RelationsBase, RuntimeComputedQueryColumn, SearchArg, SearchMethods, SearchWeight, SearchWeightRecord, Select, SelectArg, SelectArgs, SelectAs, SelectAsValue, SelectItem, SelectQueryData, SelectSubQueryResult, SelectableFromShape, SelectableOfType, SelectableOrExpression, SelectableOrExpressionOfType, SelectableOrExpressions, SerialColumn, SerialColumnData, SetQueryKind, SetQueryKindResult, SetQueryReturnsAll, SetQueryReturnsAllKind, SetQueryReturnsAllKindResult, SetQueryReturnsColumnInfo, SetQueryReturnsColumnKind, SetQueryReturnsColumnKindResult, SetQueryReturnsColumnOptional, SetQueryReturnsColumnOrThrow, SetQueryReturnsOne, SetQueryReturnsOneKind, SetQueryReturnsOneKindResult, SetQueryReturnsOneOptional, SetQueryReturnsPluck, SetQueryReturnsPluckColumn, SetQueryReturnsPluckColumnKind, SetQueryReturnsPluckColumnKindResult, SetQueryReturnsRowCount, SetQueryReturnsRows, SetQueryReturnsValueOptional, SetQueryReturnsValueOrThrow, SetQueryReturnsVoid, SetQueryReturnsVoidKind, SetQueryTableAlias, ShapeColumnPrimaryKeys, ShapeUniqueColumns, SimpleJoinItem, SimpleJoinItemNonSubQueryArgs, SmallIntColumn, SmallSerialColumn, SortDir, SqlFn, SqlMethod, StringColumn$1 as StringColumn, TableData, TableDataFn, TableDataInput, TableDataItem, TableDataItemsUniqueColumnTuples, TableDataItemsUniqueColumns, TableDataItemsUniqueConstraints, TableDataMethods, TextBaseColumn, TextColumn, TextColumnData, Then, TimeColumn, TimestampColumn, TimestampTZColumn, ToSQLCtx, ToSQLOptions, ToSQLQuery, Transaction, TransactionAdapter, TransactionOptions, TransformMethods, TruncateQueryData, TsQueryColumn, TsVectorColumn, TypeParsers, UUIDColumn, UnhandledTypeError, Union, UnionArgs, UnionItem, UnionKind, UnionSet, UniqueConstraints, UniqueQueryTypeOrExpression, UniqueTableDataItem, UnknownColumn, Update, UpdateArg, UpdateCtx, UpdateCtxCollect, UpdateData, UpdateQueryData, UpdateQueryDataItem, UpdateQueryDataObject, UpdateSelf, UpdatedAtDataInjector, UpsertResult, UpsertThis, VarCharColumn, VirtualColumn, Where, WhereArg, WhereArgs, WhereInArg, WhereInColumn, WhereInItem, WhereInValues, WhereItem, WhereJsonPathEqualsItem, WhereNotArgs, WhereOnItem, WhereOnJoinItem, WhereQueryBuilder, WhereResult, WhereSearchItem, WhereSearchResult, WindowArg, WindowArgDeclaration, WindowDeclaration, WindowItem, WithArgsOptions, WithConfigs, WithDataItem, WithDataItems, WithItem, WithMethods, WithOptions, WithQueryBuilder, WithRecursiveOptions, WithResult, WithSqlResult, WrapQueryArg, XMLColumn, _initQueryBuilder, _queryAfterSaveCommit, _queryAll, _queryAs, _queryChangeCounter, _queryCreate, _queryCreateFrom, _queryCreateMany, _queryCreateManyFrom, _queryCreateManyRaw, _queryCreateRaw, _queryDefaults, _queryDelete, _queryExec, _queryFindBy, _queryFindByOptional, _queryGet, _queryGetOptional, _queryHookAfterCreate, _queryHookAfterCreateCommit, _queryHookAfterDelete, _queryHookAfterDeleteCommit, _queryHookAfterQuery, _queryHookAfterSave, _queryHookAfterUpdate, _queryHookAfterUpdateCommit, _queryHookBeforeCreate, _queryHookBeforeDelete, _queryHookBeforeQuery, _queryHookBeforeSave, _queryHookBeforeUpdate, _queryInsert, _queryInsertFrom, _queryInsertMany, _queryInsertManyFrom, _queryInsertManyRaw, _queryInsertRaw, _queryJoinOn, _queryJoinOnJsonPathEquals, _queryJoinOrOn, _queryOr, _queryOrNot, _queryRows, _querySelect, _queryTake, _queryTakeOptional, _queryUnion, _queryUpdate, _queryUpdateOrThrow, _queryUpdateRaw, _queryWhere, _queryWhereExists, _queryWhereIn, _queryWhereNot, _queryWhereNotOneOf, _queryWhereNotSql, _queryWhereOneOf, _queryWhereSql, addParserForRawExpression, addParserForSelectItem, addQueryOn, anyShape, applyComputedColumns, checkIfASimpleQuery, cloneQuery, cloneQueryBaseUnscoped, columnCheckToCode, columnCode, columnForeignKeysToCode, columnIndexesToCode, columnsShapeToCode, commitSql, constraintInnerToCode, constraintToCode, copyTableData, countSelect, createDb, defaultSchemaConfig, extendQuery, filterResult, foreignKeyArgumentToCode, getClonedQueryData, getColumnInfo, getColumnTypes, getPrimaryKeys, getQueryAs, getShapeFromSelect, getSqlText, handleResult, identityToCode, indexInnerToCode, indexToCode, instantiateColumn, isDefaultTimeStamp, isQueryReturnsAll, isSelectingCount, joinSubQuery, logParamToLogObject, makeColumnTypes, makeColumnsByType, makeFnExpression, makeRegexToFindInSql, makeSQL, parseRecord, parseTableData, parseTableDataInput, primaryKeyInnerToCode, processComputedBatches, processComputedResult, processSelectArg, pushLimitSQL, pushQueryArray, pushQueryOn, pushQueryOrOn, pushQueryValue, pushTableDataCode, queryFrom, queryFromSql, queryJson, queryMethodByReturnType, queryTypeWithLimitOne, queryWrap, quote, quoteString, raw, referencesArgsToCode, resolveSubQueryCallback, rollbackSql, saveSearchAlias, setParserForSelectedString, setQueryObjectValue, setQueryOperators, simplifyColumnDefault, sqlFn, sqlQueryArgsToExpression, tableDataMethods, templateLiteralToSQL, testTransaction, throwIfNoWhere, toSQL, toSQLCacheKey };
+export { Adapter, AdapterConfig, AdapterOptions, AddQueryDefaults, AfterHook, AggregateMethods, AggregateOptions, AliasOrTable, ArrayColumn, ArrayColumnValue, ArrayData, AsMethods, AsQueryArg, BigIntColumn, BigSerialColumn, BitColumn, BitVaryingColumn, BooleanColumn, BooleanQueryColumn, BoxColumn, ByteaColumn, CidrColumn, CircleColumn, CitextColumn, Clear, ClearStatement, ColumnData, ColumnFromDbParams, ColumnInfoQueryData, ColumnRefExpression, ColumnType, ColumnsByType, ColumnsShape, ColumnsShapeToNullableObject, ColumnsShapeToObject, ColumnsShapeToObjectArray, ColumnsShapeToPluck, CommonQueryData, ComputedColumn, ComputedColumns, ComputedColumnsFromOptions, ComputedMethods, ComputedOptionsFactory, CopyOptions, CopyQueryData, Create, CreateBelongsToData, CreateColumn, CreateCtx, CreateData, CreateKind, CreateMethodsNames, CreateRelationsData, CreateRelationsDataOmittingFKeys, CreateResult, CreateSelf, CustomTypeColumn, DateBaseColumn, DateColumn, DateColumnInput, DateTimeBaseClass, DateTimeTzBaseClass, Db, DbDomainArg, DbDomainArgRecord, DbExtension, DbOptions, DbResult, DbSharedOptions, DbTableConstructor, DbTableOptionScopes, DbTableOptions, DecimalColumn, DecimalColumnData, DefaultColumnTypes, DefaultSchemaConfig, Delete, DeleteArgs, DeleteMethodsNames, DeleteQueryData, DeleteResult, DomainColumn, DoublePrecisionColumn, DynamicRawSQL, EnumColumn, ExpressionMethods, ExpressionOutput, FnExpression, FnExpressionArgs, FnExpressionArgsPairs, FnExpressionArgsValue, For, FromArg, FromMethods, FromQuerySelf, FromResult, GetArg, GetColumnInfo, GetQueryResult, GetResult, GetResultOptional, GetStringArg, GroupArgs, HandleResult, Having, HavingItem, HookAction, HookSelectArg, IdentityColumn, InetColumn, InsertQueryData, IntegerBaseColumn, IntegerColumn, IntervalColumn, IsolationLevel, JSONColumn, JSONTextColumn, Join, JoinArgToQuery, JoinArgs, JoinCallback, JoinFirstArg, JoinItem, JoinItemArgs, JoinLateralItem, JoinLateralResult, JoinOverrides, JoinQueryBuilder, JoinQueryMethod, JoinResult, JoinedParsers, JoinedShapes, JsonMethods, LimitedTextBaseColumn, LineColumn, LsegColumn, MacAddr8Column, MacAddrColumn, MapTableScopesOption, MergeQuery, MergeQueryMethods, MoneyColumn, MoreThanOneRowError, NoPrimaryKeyOption, NotFoundError, NumberAsStringBaseColumn, NumberBaseColumn, NumberColumnData, OnConflictMerge, OnConflictQueryBuilder, OnConflictSet, OnConflictTarget, OnMethods, Operator, Operators, OperatorsAny, OperatorsArray, OperatorsBoolean, OperatorsDate, OperatorsJson, OperatorsNumber, OperatorsText, OperatorsTime, OrCreateArg, OrExpression, OrchidOrmError, OrchidOrmInternalError, OrderArg, OrderArgSelf, OrderArgs, OrderItem, OrderTsQueryConfig, Over, PathColumn, PickColumnData, PickQueryBaseQuery, PickQueryColumnTypes, PickQueryDataShapeAndJoinedShapes, PickQueryInternal, PickQueryMetaRelations, PickQueryMetaResultRelations, PickQueryMetaResultRelationsWindows, PickQueryMetaResultRelationsWindowsColumnTypes, PickQueryMetaResultRelationsWithDataReturnType, PickQueryMetaResultRelationsWithDataReturnTypeShape, PickQueryMetaResultReturnTypeWithDataWindows, PickQueryMetaResultReturnTypeWithDataWindowsTable, PickQueryMetaShapeRelationsWithData, PickQueryMetaTable, PickQueryMetaTableShape, PickQueryMetaTableShapeReturnTypeWithData, PickQueryMetaWithData, PickQueryMetaWithDataColumnTypes, PickQueryQ, PickQueryQAndBaseQuery, PickQueryQAndInternal, PickQueryRelations, PickQueryRelationsWithData, PickQueryResultColumnTypes, PickQueryShapeResultSinglePrimaryKey, PickQueryShapeSinglePrimaryKey, PickQuerySinglePrimaryKey, PickQueryWindows, PickQueryWithData, PickQueryWithDataColumnTypes, PointColumn, PolygonColumn, Query, QueryAfterHook, QueryArraysResult, QueryBase, QueryBaseThen, QueryBatchResult, QueryBeforeHook, QueryComputedArg, QueryData, QueryDataFromItem, QueryDataJoinTo, QueryDefaultReturnData, QueryError, QueryErrorName, QueryGet, QueryGetSelf, QueryHelperResult, QueryHooks, QueryInternal, QueryLog, QueryMetaHasSelect, QueryMetaHasWhere, QueryMethods, QueryOrExpression, QueryOrExpressionBooleanOrNullResult, QueryResult, QueryScopeData, QueryScopes, QuerySourceItem, QueryUpsertOrCreate, QueryWithTable, RawSQL, RealColumn, RecordOfColumnsShapeBase, RefExpression, RelationConfigBase, RelationConfigDataForCreate, RelationJoinQuery, RelationQuery, RelationQueryBase, RelationsBase, RuntimeComputedQueryColumn, SearchArg, SearchMethods, SearchWeight, SearchWeightRecord, Select, SelectArg, SelectArgs, SelectAs, SelectAsValue, SelectItem, SelectQueryData, SelectSubQueryResult, SelectableFromShape, SelectableOfType, SelectableOrExpression, SelectableOrExpressionOfType, SelectableOrExpressions, SerialColumn, SerialColumnData, SetQueryKind, SetQueryKindResult, SetQueryReturnsAll, SetQueryReturnsAllKind, SetQueryReturnsAllKindResult, SetQueryReturnsColumnInfo, SetQueryReturnsColumnKind, SetQueryReturnsColumnKindResult, SetQueryReturnsColumnOptional, SetQueryReturnsColumnOrThrow, SetQueryReturnsOne, SetQueryReturnsOneKind, SetQueryReturnsOneKindResult, SetQueryReturnsOneOptional, SetQueryReturnsPluck, SetQueryReturnsPluckColumn, SetQueryReturnsPluckColumnKind, SetQueryReturnsPluckColumnKindResult, SetQueryReturnsRowCount, SetQueryReturnsRows, SetQueryReturnsValueOptional, SetQueryReturnsValueOrThrow, SetQueryReturnsVoid, SetQueryReturnsVoidKind, SetQueryTableAlias, ShapeColumnPrimaryKeys, ShapeUniqueColumns, SimpleJoinItem, SimpleJoinItemNonSubQueryArgs, SmallIntColumn, SmallSerialColumn, SortDir, SqlFn, SqlMethod, StringColumn$1 as StringColumn, TableData, TableDataFn, TableDataInput, TableDataItem, TableDataItemsUniqueColumnTuples, TableDataItemsUniqueColumns, TableDataItemsUniqueConstraints, TableDataMethods, TextBaseColumn, TextColumn, TextColumnData, Then, TimeColumn, TimestampColumn, TimestampTZColumn, ToSQLCtx, ToSQLOptions, ToSQLQuery, Transaction, TransactionAdapter, TransactionOptions, TransformMethods, TruncateQueryData, TsQueryColumn, TsVectorColumn, TypeParsers, UUIDColumn, UnhandledTypeError, Union, UnionArgs, UnionItem, UnionKind, UnionSet, UniqueConstraints, UniqueQueryTypeOrExpression, UniqueTableDataItem, UnknownColumn, Update, UpdateArg, UpdateCtx, UpdateCtxCollect, UpdateData, UpdateQueryData, UpdateQueryDataItem, UpdateQueryDataObject, UpdateSelf, UpdatedAtDataInjector, UpsertResult, UpsertThis, VarCharColumn, VirtualColumn, Where, WhereArg, WhereArgs, WhereInArg, WhereInColumn, WhereInItem, WhereInValues, WhereItem, WhereJsonPathEqualsItem, WhereNotArgs, WhereOnItem, WhereOnJoinItem, WhereQueryBuilder, WhereResult, WhereSearchItem, WhereSearchResult, WindowArg, WindowArgDeclaration, WindowDeclaration, WindowItem, WithArgsOptions, WithConfigs, WithDataItem, WithDataItems, WithItem, WithMethods, WithOptions, WithQueryBuilder, WithRecursiveOptions, WithResult, WithSqlResult, WrapQueryArg, XMLColumn, _initQueryBuilder, _queryAfterSaveCommit, _queryAll, _queryAs, _queryChangeCounter, _queryCreate, _queryCreateFrom, _queryCreateMany, _queryCreateManyFrom, _queryCreateManyRaw, _queryCreateRaw, _queryDefaults, _queryDelete, _queryExec, _queryFindBy, _queryFindByOptional, _queryGet, _queryGetOptional, _queryHookAfterCreate, _queryHookAfterCreateCommit, _queryHookAfterDelete, _queryHookAfterDeleteCommit, _queryHookAfterQuery, _queryHookAfterSave, _queryHookAfterUpdate, _queryHookAfterUpdateCommit, _queryHookBeforeCreate, _queryHookBeforeDelete, _queryHookBeforeQuery, _queryHookBeforeSave, _queryHookBeforeUpdate, _queryInsert, _queryInsertFrom, _queryInsertMany, _queryInsertManyFrom, _queryInsertManyRaw, _queryInsertRaw, _queryJoinOn, _queryJoinOnJsonPathEquals, _queryJoinOrOn, _queryOr, _queryOrNot, _queryRows, _querySelect, _queryTake, _queryTakeOptional, _queryUnion, _queryUpdate, _queryUpdateOrThrow, _queryUpdateRaw, _queryWhere, _queryWhereExists, _queryWhereIn, _queryWhereNot, _queryWhereNotOneOf, _queryWhereNotSql, _queryWhereOneOf, _queryWhereSql, addParserForRawExpression, addParserForSelectItem, addQueryOn, anyShape, applyComputedColumns, checkIfASimpleQuery, cloneQuery, cloneQueryBaseUnscoped, columnCheckToCode, columnCode, columnForeignKeysToCode, columnIndexesToCode, columnsShapeToCode, commitSql, constraintInnerToCode, constraintToCode, copyTableData, countSelect, createDb, defaultSchemaConfig, extendQuery, filterResult, foreignKeyArgumentToCode, getClonedQueryData, getColumnInfo, getColumnTypes, getPrimaryKeys, getQueryAs, getShapeFromSelect, getSqlText, handleResult, identityToCode, indexInnerToCode, indexToCode, instantiateColumn, isDefaultTimeStamp, isQueryReturnsAll, isSelectingCount, joinSubQuery, logParamToLogObject, makeColumnTypes, makeColumnsByType, makeFnExpression, makeRegexToFindInSql, makeSQL, parseRecord, parseTableData, parseTableDataInput, primaryKeyInnerToCode, processComputedBatches, processComputedResult, processSelectArg, pushLimitSQL, pushQueryArray, pushQueryOn, pushQueryOnForOuter, pushQueryOrOn, pushQueryValue, pushTableDataCode, queryFrom, queryFromSql, queryJson, queryMethodByReturnType, queryTypeWithLimitOne, queryWrap, quote, quoteString, raw, referencesArgsToCode, resolveSubQueryCallback, rollbackSql, saveSearchAlias, setParserForSelectedString, setQueryObjectValue, setQueryOperators, simplifyColumnDefault, sqlFn, sqlQueryArgsToExpression, tableDataMethods, templateLiteralToSQL, testTransaction, throwIfNoWhere, toSQL, toSQLCacheKey };

package/dist/index.js

@@ -2206,37 +2206,16 @@ const processWhere = (ands, ctx, table, query, data, quotedAs) => {
         );
       } else {
         const item = value;
-        const leftColumn = columnToSql(
-          ctx,
-          query,
-          query.shape,
-          item.on[0],
-          `"${getJoinItemSource(item.joinFrom)}"`
+        const joinAs = `"${getJoinItemSource(item.joinFrom)}"`;
+        const { on } = item;
+        const q = item.useOuterJoinOverrides ? {
+          joinedShapes: query.joinedShapes,
+          joinOverrides: query.outerJoinOverrides,
+          shape: query.shape
+        } : query;
+        ands.push(
+          `${onColumnToSql(ctx, q, joinAs, on[0])} ${on.length === 2 ? "=" : on[1]} ${onColumnToSql(ctx, q, joinAs, on.length === 3 ? on[2] : on[1])}`
         );
-        const joinTo = getJoinItemSource(item.joinTo);
-        const joinedShape = query.joinedShapes[joinTo];
-        let op;
-        let rightColumn;
-        if (item.on.length === 2) {
-          op = "=";
-          rightColumn = columnToSql(
-            ctx,
-            query,
-            joinedShape,
-            item.on[1],
-            `"${joinTo}"`
-          );
-        } else {
-          op = item.on[1];
-          rightColumn = columnToSql(
-            ctx,
-            query,
-            joinedShape,
-            item.on[2],
-            `"${joinTo}"`
-          );
-        }
-        ands.push(`${leftColumn} ${op} ${rightColumn}`);
       }
     } else if (key === "IN") {
       orchidCore.toArray(value).forEach((item) => {
@@ -2332,6 +2311,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs) => {
     }
   }
 };
+const onColumnToSql = (ctx, query, joinAs, column) => columnToSql(ctx, query, query.shape, column, joinAs);
 const getJoinItemSource = (joinItem) => {
   return typeof joinItem === "string" ? joinItem : getQueryAs(joinItem);
 };
@@ -5970,12 +5950,14 @@ const makeRegexToFindInSql = (value) => {
   return new RegExp(`${value}(?=(?:[^']*'[^']*')*[^']*$)`, "g");
 };
 const resolveSubQueryCallback = (q, cb) => {
-  const { subQuery, relChain } = q.q;
+  const { subQuery, relChain, outerJoinOverrides } = q.q;
   q.q.subQuery = 1;
   q.q.relChain = void 0;
+  q.q.outerJoinOverrides = q.q.joinOverrides;
   const result = cb(q);
   q.q.subQuery = subQuery;
   q.q.relChain = relChain;
+  q.q.outerJoinOverrides = outerJoinOverrides;
   return result;
 };
 const joinSubQuery = (q, sub) => {
@@ -8405,7 +8387,7 @@ class Join {
    *
    * All the `join` methods accept the same arguments, but returning type is different because with `join` it's guaranteed to load joined table, and with `leftJoin` the joined table columns may be `NULL` when no matching record was found.
    *
-   * For the following examples, imagine we have a `User` table with `id` and `name`, and `Message` table with `id`, `text`, messages belongs to user via `userId` column:
+   * For the following examples, imagine you have a `User` table with `id` and `name`, and `Message` table with `id`, `text`, messages belongs to user via `userId` column:
    *
    * ```ts
    * export class UserTable extends BaseTable {
@@ -8483,7 +8465,7 @@ class Join {
    * ```ts
    * const result = await db.user
    *   .join('messages')
-   *   // after joining a table, we can use it in `where` conditions:
+   *   // after joining a table, you can use it in `where` conditions:
    *   .where({ 'messages.text': { startsWith: 'Hi' } })
    *   .select(
    *     'name', // name is User column, table name may be omitted
@@ -8494,8 +8476,8 @@ class Join {
    * const ok: { name: string; text: string }[] = result;
    * ```
    *
-   * The first argument can also be a callback, where instead of relation name as a string we're picking it as a property of `q`.
-   * In such a way, we can alias the relation with `as`, add `where` conditions, use other query methods.
+   * The first argument can also be a callback, where instead of relation name as a string you're picking it as a property of `q`.
+   * In such a way, you can alias the relation with `as`, add `where` conditions, use other query methods.
    *
    * ```ts
    * const result = await db.user.join((q) =>
@@ -8512,7 +8494,7 @@ class Join {
    *   (q) => q.messages.as('m'),
    *   (q) =>
    *     q
-   *       .on('text', 'name') // additionally, match message with user name
+   *       .on('messages.text', 'user.name') // additionally, match message with user name
    *       .where({ text: 'some text' }), // you can add `where` in a second callback as well.
    * );
    * ```
@@ -8566,17 +8548,16 @@ class Join {
    * Joined table can be references from `where` and `select` by a table name.
    *
    * ```ts
-   * // Join message where userId = id:
    * db.user
-   *   .join(db.message, 'userId', 'id')
+   *   .join(db.message, 'userId', 'user.id')
    *   .where({ 'message.text': { startsWith: 'Hi' } })
    *   .select('name', 'message.text');
    * ```
    *
-   * Columns in the join list may be prefixed with table names for clarity:
+   * The name of the joining table can be omitted, but not the name of the main table:
    *
    * ```ts
-   * db.user.join(db.message, 'message.userId', 'user.id');
+   * db.user.join(db.message, 'userId', 'user.id');
    * ```
    *
    * Joined table can have an alias for referencing it further:
@@ -8607,7 +8588,7 @@ class Join {
    * You can provide a custom comparison operator
    *
    * ```ts
-   * db.user.join(db.message, 'userId', '!=', 'id');
+   * db.user.join(db.message, 'userId', '!=', 'user.id');
    * ```
    *
    * Join can accept raw SQL for the `ON` part of join:
@@ -8642,11 +8623,11 @@ class Join {
    *
    * ```ts
    * db.user.join(db.message, {
-   *   userId: 'id',
-   *
-   *   // with table names:
    *   'message.userId': 'user.id',
    *
+   *   // joined table name may be omitted
+   *   userId: 'user.id',
+   *
    *   // value can be a raw SQL expression:
    *   text: sql`lower("user"."name")`,
    * });
@@ -8665,17 +8646,16 @@ class Join {
    *   db.message,
    *   (q) =>
    *     q
-   *       // left column is the db.message column, right column is the db.user column
-   *       .on('userId', 'id')
-   *       // table names can be provided:
    *       .on('message.userId', 'user.id')
+   *       // joined table name may be omitted
+   *       .on('userId', 'user.id')
    *       // operator can be specified:
-   *       .on('userId', '!=', 'id')
+   *       .on('userId', '!=', 'user.id')
    *       // operator can be specified with table names as well:
    *       .on('message.userId', '!=', 'user.id')
    *       // `.orOn` takes the same arguments as `.on` and acts like `.or`:
-   *       .on('userId', 'id') // where message.userId = user.id
-   *       .orOn('text', 'name'), // or message.text = user.name
+   *       .on('userId', 'user.id') // where message.userId = user.id
+   *       .orOn('text', 'user.name'), // or message.text = user.name
    * );
    * ```
    *
@@ -8684,7 +8664,7 @@ class Join {
    * ```ts
    * db.user.join(db.message, (q) =>
    *   q
-   *     .on('userId', 'id')
+   *     .on('userId', 'user.id')
    *     .where({
    *       // not prefixed column name is for joined table:
    *       text: { startsWith: 'hello' },
@@ -8719,7 +8699,7 @@ class Join {
    *     .where({ text: { startsWith: 'Hi' } })
    *     .as('t'),
    *   'userId',
-   *   'id',
+   *   'user.id',
    * );
    * ```
    *
@@ -8786,7 +8766,7 @@ class Join {
    *
    * // the same query, but joining table explicitly
    * const result2: typeof result = await db.user
-   *   .leftJoin(db.message, 'userId', 'id')
+   *   .leftJoin(db.message, 'userId', 'user.id')
    *   .select('name', 'message.text');
    *
    * // result has the following type:
@@ -8888,7 +8868,7 @@ class Join {
    *     // select message columns
    *     .select('text')
    *     // join the message to the user, column names can be prefixed with table names
-   *     .on('authorId', 'id')
+   *     .on('authorId', 'user.id')
    *     // message columns are available without prefixing,
    *     // outer table columns are available with a table name
    *     .where({ text: 'some text', 'user.name': 'name' })
@@ -8970,14 +8950,22 @@ class Join {
     );
   }
 }
-const makeOnItem = (joinTo, joinFrom, args) => {
-  return {
+const makeOnItem = (joinTo, joinFrom, args) => ({
+  ON: {
+    joinTo,
+    joinFrom,
+    on: args
+  }
+});
+const pushQueryOnForOuter = (q, joinFrom, joinTo, ...on) => {
+  return pushQueryValue(q, "and", {
     ON: {
-      joinTo,
-      joinFrom,
-      on: args
+      joinTo: joinFrom,
+      joinFrom: joinTo,
+      useOuterJoinOverrides: true,
+      on
     }
-  };
+  });
 };
 const pushQueryOn = (q, joinFrom, joinTo, ...on) => {
   return pushQueryValue(
@@ -9028,16 +9016,13 @@ class OnMethods {
    *
    * ```ts
    * q
-   *   // left column is the db.message column, right column is the db.user column
-   *   .on('userId', 'id')
-   *   // table names can be provided:
    *   .on('message.userId', 'user.id')
+   *   // joined table name may be omitted
+   *   .on('userId', 'user.id')
    *   // operator can be specified:
-   *   .on('userId', '!=', 'id')
+   *   .on('userId', '!=', 'user.id')
    *   // operator can be specified with table names as well:
    *   .on('message.userId', '!=', 'user.id')
-   *   // `.orOn` takes the same arguments as `.on` and acts like `.or`:
-   *   .on('userId', 'id') // where message.userId = user.id
    * ```
    *
    * @param args - columns to join with
@@ -9382,6 +9367,7 @@ const resolveCallbacksInArgs = (q, args) => {
       qb.q = getClonedQueryData(q.q);
       qb.q.and = qb.q.or = qb.q.scopes = void 0;
       qb.q.subQuery = 1;
+      qb.q.outerJoinOverrides = qb.q.joinOverrides;
       args[i] = resolveSubQueryCallback(qb, arg);
     }
   }
@@ -12986,6 +12972,7 @@ exports.processSelectArg = processSelectArg;
 exports.pushLimitSQL = pushLimitSQL;
 exports.pushQueryArray = pushQueryArray;
 exports.pushQueryOn = pushQueryOn;
+exports.pushQueryOnForOuter = pushQueryOnForOuter;
 exports.pushQueryOrOn = pushQueryOrOn;
 exports.pushQueryValue = pushQueryValue;
 exports.pushTableDataCode = pushTableDataCode;