Class: ScalarCriteriaNode#
knex.ScalarCriteriaNode
Hierarchy#
↳ ScalarCriteriaNode
Constructors#
constructor#
+ new ScalarCriteriaNode(metadata: MetadataStorage, entityName: string, parent?: ICriteriaNode, key?: string, validate?: boolean): ScalarCriteriaNode
Parameters:#
| Name | Type | Default value |
|---|---|---|
metadata | MetadataStorage | - |
entityName | string | - |
parent? | ICriteriaNode | - |
key? | string | - |
validate | boolean | true |
Returns: ScalarCriteriaNode
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
getPath#
â–¸ getPath(): string
Returns: string
Inherited from: CriteriaNode
Defined in: packages/knex/src/query/CriteriaNode.ts:78
getPivotPath#
â–¸ getPivotPath(path: string): string
Parameters:#
| Name | Type |
|---|---|
path | string |
Returns: string
Inherited from: CriteriaNode
Defined in: packages/knex/src/query/CriteriaNode.ts:115
process#
â–¸ process<T>(qb: IQueryBuilder<T>, alias?: string): any
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
qb | IQueryBuilder<T> |
alias? | string |
Returns: any
Overrides: CriteriaNode
Defined in: packages/knex/src/query/ScalarCriteriaNode.ts:7
renameFieldToPK#
â–¸ renameFieldToPK<T>(qb: IQueryBuilder<T>): string
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
qb | IQueryBuilder<T> |
Returns: string
Inherited from: CriteriaNode
Defined in: packages/knex/src/query/CriteriaNode.ts:64
shouldInline#
â–¸ shouldInline(payload: any): boolean
Parameters:#
| Name | Type |
|---|---|
payload | any |
Returns: boolean
Inherited from: CriteriaNode
Defined in: packages/knex/src/query/CriteriaNode.ts:36
shouldJoin#
â–¸ shouldJoin(): boolean
Returns: boolean
Defined in: packages/knex/src/query/ScalarCriteriaNode.ts:25
shouldRename#
â–¸ shouldRename(payload: any): boolean
Parameters:#
| Name | Type |
|---|---|
payload | any |
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:#
| Name | Type |
|---|---|
qb | IQueryBuilder<T> |
alias? | string |
Returns: boolean
Inherited from: CriteriaNode
Defined in: packages/knex/src/query/CriteriaNode.ts:40
isCustomExpression#
â–¸ StaticisCustomExpression(field: string): boolean
Parameters:#
| Name | Type |
|---|---|
field | string |
Returns: boolean
Inherited from: CriteriaNode
Defined in: packages/knex/src/query/CriteriaNode.ts:123