Class: CriteriaNode

knex.CriteriaNode

Helper for working with deeply nested where/orderBy/having criteria. Uses composite pattern to build tree from the payload. Auto-joins relations and converts payload from { books: { publisher: { name: '...' } } } to { 'publisher_alias.name': '...' }

Hierarchy

• CriteriaNode

  ↳ ArrayCriteriaNode

  ↳ ObjectCriteriaNode

  ↳ ScalarCriteriaNode

Constructors

constructor

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

Parameters:

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

Returns: CriteriaNode

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

Properties

entityName

• Readonly entityName: string

---

key

• Optional Readonly key: undefined | string

---

metadata

• Protected Readonly metadata: MetadataStorage

---

parent

• Optional Readonly parent: undefined | ICriteriaNode

---

payload

• payload: any

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

---

prop

• Optional prop: undefined | EntityProperty<any>

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

Methods

__@custom@36825

▸ __@custom@36825(): string

Returns: string

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

---

getPath

▸ getPath(): string

Returns: string

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

---

getPivotPath

▸ getPivotPath(path: string): string

Parameters:

Name	Type
path	string

Returns: string

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

---

isPivotJoin

▸ PrivateisPivotJoin(): boolean

Returns: boolean

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

---

process

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

Type parameters:

Name
T

Parameters:

Name	Type
qb	IQueryBuilder<T>
alias?	string

Returns: any

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

---

renameFieldToPK

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

Type parameters:

Name
T

Parameters:

Name	Type
qb	IQueryBuilder<T>

Returns: string

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

---

shouldInline

▸ shouldInline(payload: any): boolean

Parameters:

Name	Type
payload	any

Returns: boolean

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

---

shouldRename

▸ shouldRename(payload: any): boolean

Parameters:

Name	Type
payload	any

Returns: boolean

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

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

---

isCustomExpression

▸ StaticisCustomExpression(field: string): boolean

Parameters:

Name	Type
field	string

Returns: boolean

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