Version: 4.3

Class: ScalarCriteriaNode

Hierarchy

Constructors

constructor

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

Inherited from CriteriaNode.constructor

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

Parameters:

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

Returns: ScalarCriteriaNode

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


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


process

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

Overrides CriteriaNode.process

Defined in packages/knex/src/query/ScalarCriteriaNode.ts:7

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


shouldInline

shouldInline(payload: any): boolean

Inherited from CriteriaNode.shouldInline

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

Parameters:

NameType
payloadany

Returns: boolean


shouldJoin

shouldJoin(): boolean

Defined in packages/knex/src/query/ScalarCriteriaNode.ts:25

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

Inherited from CriteriaNode.willAutoJoin

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

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