Skip to main content
Version: 4.4

Interface: Join<TRecord, TResult>#

knex.Knex.Join

Type parameters#

NameTypeDefault
TRecord{}any
TResult-unknown[]

Hierarchy#

  • Join

Callable#

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
rawRaw<any>

Returns: QueryBuilder<TRecord2, TResult2>

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

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:1040

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
tableNamestring | Raw<any> | QueryBuilder<any, any> | AliasDict | QueryCallback<any, unknown[]>
clauseJoinCallback

Returns: QueryBuilder<TRecord2, TResult2>

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

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
tableNamestring | Raw<any> | QueryBuilder<any, any> | AliasDict | QueryCallback<any, unknown[]>
columns{ [key: string]: string | number | boolean | Raw; }

Returns: QueryBuilder<TRecord2, TResult2>

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

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
tableNamestring | Raw<any> | QueryBuilder<any, any> | AliasDict | QueryCallback<any, unknown[]>
rawRaw<any>

Returns: QueryBuilder<TRecord2, TResult2>

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

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:1072

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
tableNamestring | Raw<any> | QueryBuilder<any, any> | AliasDict | QueryCallback<any, unknown[]>
column1string
column2string

Returns: QueryBuilder<TRecord2, TResult2>

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

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
tableNamestring | Raw<any> | QueryBuilder<any, any> | AliasDict | QueryCallback<any, unknown[]>
column1string
rawRaw<any>

Returns: QueryBuilder<TRecord2, TResult2>

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

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:1099

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

Type parameters:#

NameTypeDefault
TJoinTargetRecord{}any
TRecord2{}TRecord & TJoinTargetRecord
TResult2-ReplaceBase<TResult, TRecord2\>

Parameters:#

NameType
tableNamestring | Raw<any> | QueryBuilder<any, any> | AliasDict | QueryCallback<any, unknown[]>
column1string
operatorstring
column2string

Returns: QueryBuilder<TRecord2, TResult2>

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

Last updated on by renovate[bot]