Version: 4.3

Class: ObjectCriteriaNode

Hierarchy

Constructors

constructor

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

Inherited from CriteriaNode.constructor

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

Parameters:

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

Returns: ObjectCriteriaNode

Properties

entityName

Readonly entityName: string

Inherited from CriteriaNode.entityName

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


key

Optional Readonly key: string

Inherited from CriteriaNode.key

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


metadata

Protected Readonly metadata: MetadataStorage

Inherited from CriteriaNode.metadata

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


parent

Optional Readonly parent: ICriteriaNode

Inherited from CriteriaNode.parent

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


payload

payload: any

Inherited from CriteriaNode.payload

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


prop

Optional prop: EntityProperty

Inherited from CriteriaNode.prop

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

Methods

[inspect.custom]

[inspect.custom](): string

Inherited from CriteriaNode.[inspect.custom]

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

Returns: string


autoJoin

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

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

Type parameters:

Name
T

Parameters:

NameType
qbIQueryBuilder<T>
aliasstring

Returns: string


getPath

getPath(): string

Inherited from CriteriaNode.getPath

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

Returns: string


getPivotPath

getPivotPath(path: string): string

Inherited from CriteriaNode.getPivotPath

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

Parameters:

NameType
pathstring

Returns: string


inlineChildPayload

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

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

Type parameters:

Name
T

Parameters:

NameType
oDictionary
payloadDictionary
fieldstring
alias?string
childAlias?string

Returns: void


isPrefixed

PrivateisPrefixed(field: string): boolean

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

Parameters:

NameType
fieldstring

Returns: boolean


process

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

Overrides CriteriaNode.process

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

Type parameters:

Name
T

Parameters:

NameType
qbIQueryBuilder<T>
alias?string

Returns: any


renameFieldToPK

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

Inherited from CriteriaNode.renameFieldToPK

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

Type parameters:

Name
T

Parameters:

NameType
qbIQueryBuilder<T>

Returns: string


shouldAutoJoin

PrivateshouldAutoJoin(nestedAlias: string | undefined): boolean

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

Parameters:

NameType
nestedAliasstring | undefined

Returns: boolean


shouldInline

shouldInline(payload: any): boolean

Overrides CriteriaNode.shouldInline

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

Parameters:

NameType
payloadany

Returns: boolean


shouldRename

shouldRename(payload: any): boolean

Inherited from CriteriaNode.shouldRename

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

Parameters:

NameType
payloadany

Returns: boolean


willAutoJoin

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

Overrides CriteriaNode.willAutoJoin

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

Type parameters:

Name
T

Parameters:

NameType
qbIQueryBuilder<T>
alias?string

Returns: boolean


isCustomExpression

StaticisCustomExpression(field: string): boolean

Inherited from CriteriaNode.isCustomExpression

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

Parameters:

NameType
fieldstring

Returns: boolean

Last updated on by Martin Adámek