Skip to main content
Version: 4.5

Interface: Join<TRecord, TResult>#

knex.Knex.Join

Type parameters#

NameTypeDefault
TRecordobjectany
TResult-unknown[]

Callable#

Join<TJoinTargetRecord, TRecord2, TResult2>(raw: Raw<any>): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
rawRaw<any>

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1039

Join<TTable, TRecord2, TResult2>(tableName: TTable, clause: JoinCallback): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TTablenever-
TRecord2-ResolveTableType<TRecord, base> & ResolveTableType<TableType<TTable>, base>
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTTable
clauseJoinCallback

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1046

Join<TJoinTargetRecord, TRecord2, TResult2>(tableName: TableDescriptor | AliasDict | QueryCallback<any, unknown[]>, clause: JoinCallback): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTableDescriptor | AliasDict | QueryCallback<any, unknown[]>
clauseJoinCallback

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1054

Join<TJoinTargetRecord, TRecord2, TResult2>(tableName: TableDescriptor | AliasDict | QueryCallback<any, unknown[]>, columns: { [key: string]: string | number | boolean | Raw; }): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTableDescriptor | AliasDict | QueryCallback<any, unknown[]>
columnsobject

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1062

Join<TJoinTargetRecord, TRecord2, TResult2>(tableName: TableDescriptor | AliasDict | QueryCallback<any, unknown[]>, raw: Raw<any>): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTableDescriptor | AliasDict | QueryCallback<any, unknown[]>
rawRaw<any>

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1070

Join<TTable, TRecord2, TResult2>(tableName: TTable, column1: string, column2: string): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TTablenever-
TRecord2-ResolveTableType<TRecord, base> & ResolveTableType<TableType<TTable>, base>
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTTable
column1string
column2string

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1078

Join<TJoinTargetRecord, TRecord2, TResult2>(tableName: TableDescriptor | AliasDict | QueryCallback<any, unknown[]>, column1: string, column2: string): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTableDescriptor | AliasDict | QueryCallback<any, unknown[]>
column1string
column2string

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1087

Join<TJoinTargetRecord, TRecord2, TResult2>(tableName: TableDescriptor | AliasDict | QueryCallback<any, unknown[]>, column1: string, raw: Raw<any>): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTableDescriptor | AliasDict | QueryCallback<any, unknown[]>
column1string
rawRaw<any>

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1096

Join<TTable, TRecord2, TResult2>(tableName: TTable, column1: string, operator: string, column2: string): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TTablenever-
TRecord2-ResolveTableType<TRecord, base> & ResolveTableType<TableType<TTable>, base>
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTTable
column1string
operatorstring
column2string

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1105

Join<TJoinTargetRecord, TRecord2, TResult2>(tableName: TableDescriptor | AliasDict | QueryCallback<any, unknown[]>, column1: string, operator: string, column2: string): QueryBuilder<TRecord2, TResult2>

Type parameters:#

NameTypeDefault
TJoinTargetRecordobjectany
TRecord2objectTRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2>

Parameters:#

NameType
tableNameTableDescriptor | AliasDict | QueryCallback<any, unknown[]>
column1string
operatorstring
column2string

Returns: QueryBuilder<TRecord2, TResult2>

Defined in: node_modules/knex/types/index.d.ts:1115

Last updated on by Renovate Bot