Skip to main content
Version: 4.5

Class: ObjectCriteriaNode#

knex.ObjectCriteriaNode

Hierarchy#

Constructors#

constructor#

+ new ObjectCriteriaNode(metadata: MetadataStorage, entityName: string, parent?: ICriteriaNode, key?: string, validate?: boolean): ObjectCriteriaNode

Parameters:#

NameTypeDefault value
metadataMetadataStorage-
entityNamestring-
parent?ICriteriaNode-
key?string-
validatebooleantrue

Returns: ObjectCriteriaNode

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:12

Properties#

entityName#

Readonly entityName: string

Inherited from: CriteriaNode.entityName


key#

Optional Readonly key: string

Inherited from: CriteriaNode.key


metadata#

Protected Readonly metadata: MetadataStorage

Inherited from: CriteriaNode.metadata


parent#

Optional Readonly parent: ICriteriaNode

Inherited from: CriteriaNode.parent


payload#

payload: any

Inherited from: CriteriaNode.payload

Defined in: packages/knex/src/query/CriteriaNode.ts:11


prop#

Optional prop: EntityProperty<any>

Inherited from: CriteriaNode.prop

Defined in: packages/knex/src/query/CriteriaNode.ts:12

Methods#

[custom]#

[custom](): string

Returns: string

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:119


autoJoin#

PrivateautoJoin<T>(qb: IQueryBuilder<T>, alias: string): string

Type parameters:#

Name
T

Parameters:#

NameType
qbIQueryBuilder<T>
aliasstring

Returns: string

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:94


getPath#

getPath(): string

Returns: string

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:78


getPivotPath#

getPivotPath(path: string): string

Parameters:#

NameType
pathstring

Returns: string

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:115


inlineChildPayload#

PrivateinlineChildPayload<T>(o: Dictionary<any>, payload: Dictionary<any>, field: string, alias?: string, childAlias?: string): void

Type parameters:#

Name
T

Parameters:#

NameType
oDictionary<any>
payloadDictionary<any>
fieldstring
alias?string
childAlias?string

Returns: void

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:68


isPrefixed#

PrivateisPrefixed(field: string): boolean

Parameters:#

NameType
fieldstring

Returns: boolean

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:112


process#

process<T>(qb: IQueryBuilder<T>, alias?: string): any

Type parameters:#

Name
T

Parameters:#

NameType
qbIQueryBuilder<T>
alias?string

Returns: any

Overrides: CriteriaNode

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:8


renameFieldToPK#

renameFieldToPK<T>(qb: IQueryBuilder<T>): string

Type parameters:#

Name
T

Parameters:#

NameType
qbIQueryBuilder<T>

Returns: string

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:64


shouldAutoJoin#

PrivateshouldAutoJoin(nestedAlias: undefined | string): boolean

Parameters:#

NameType
nestedAliasundefined | string

Returns: boolean

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:82


shouldInline#

shouldInline(payload: any): boolean

Parameters:#

NameType
payloadany

Returns: boolean

Overrides: CriteriaNode

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:60


shouldRename#

shouldRename(payload: any): boolean

Parameters:#

NameType
payloadany

Returns: boolean

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:44


willAutoJoin#

willAutoJoin<T>(qb: IQueryBuilder<T>, alias?: string): boolean

Type parameters:#

Name
T

Parameters:#

NameType
qbIQueryBuilder<T>
alias?string

Returns: boolean

Overrides: CriteriaNode

Defined in: packages/knex/src/query/ObjectCriteriaNode.ts:42


isCustomExpression#

StaticisCustomExpression(field: string): boolean

Parameters:#

NameType
fieldstring

Returns: boolean

Inherited from: CriteriaNode

Defined in: packages/knex/src/query/CriteriaNode.ts:123

Last updated on by Renovate Bot