Class: ObjectCriteriaNode

knex.ObjectCriteriaNode

Hierarchy

• CriteriaNode

  ↳ ObjectCriteriaNode

Constructors

constructor

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

Parameters:

Name	Type	Default value
metadata	MetadataStorage	-
entityName	string	-
parent?	ICriteriaNode	-
key?	string	-
validate	boolean	true

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:

Name	Type
qb	IQueryBuilder<T>
alias	string

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:

Name	Type
path	string

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:

Name	Type
o	Dictionary<any>
payload	Dictionary<any>
field	string
alias?	string
childAlias?	string

Returns: void

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

---

isPrefixed

▸ PrivateisPrefixed(field: string): boolean

Parameters:

Name	Type
field	string

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:

Name	Type
qb	IQueryBuilder<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:

Name	Type
qb	IQueryBuilder<T>

Returns: string

Inherited from: CriteriaNode

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

---

shouldAutoJoin

▸ PrivateshouldAutoJoin(nestedAlias: undefined | string): boolean

Parameters:

Name	Type
nestedAlias	undefined | string

Returns: boolean

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

---

shouldInline

▸ shouldInline(payload: any): boolean

Parameters:

Name	Type
payload	any

Returns: boolean

Overrides: CriteriaNode

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

---

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

Overrides: CriteriaNode

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

---

isCustomExpression

▸ StaticisCustomExpression(field: string): boolean

Parameters:

Name	Type
field	string

Returns: boolean

Inherited from: CriteriaNode

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