Skip to main content
Version: 4.4

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: undefined | string

Inherited from: CriteriaNode.key


metadata#

• Protected Readonly metadata: MetadataStorage

Inherited from: CriteriaNode.metadata


parent#

• Optional Readonly parent: undefined | ICriteriaNode

Inherited from: CriteriaNode.parent


payload#

• payload: any

Inherited from: CriteriaNode.payload

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


prop#

• Optional prop: undefined | EntityProperty<any>

Inherited from: CriteriaNode.prop

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

Methods#

__@custom@36825#

â–¸ __@custom@36825(): 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]