Class: OrderBy

Defined in: packages/core/src/plan/operators/tuple/order.ts:30

Sorts its source stream according to one or more Order descriptors.

Extends

• PlanTupleOperator

Constructors

Constructor

new OrderBy(lang, orders, source): OrderBy

Defined in: packages/core/src/plan/operators/tuple/order.ts:31

Parameters

Parameter	Type	Description
lang	Lowercase<string>	-
orders	Order[]	Ordered list of sort terms applied left-to-right.
source	PlanTupleOperator	Tuple operator providing the input rows.

Returns

OrderBy

Overrides

PlanTupleOperator.constructor

Properties

lang

lang: Lowercase<string>

Defined in: packages/core/src/plan/visitor.ts:42

PlanOperator.lang

Inherited from

PlanTupleOperator.lang

---

orders

orders: Order[]

Defined in: packages/core/src/plan/operators/tuple/order.ts:34

Ordered list of sort terms applied left-to-right.

---

parent?

optional parent?: PlanOperator

Defined in: packages/core/src/plan/visitor.ts:44

PlanOperator.parent

Inherited from

PlanTupleOperator.parent

---

schema

schema: ASTIdentifier[]

Defined in: packages/core/src/plan/visitor.ts:38

Ordered list of attribute identifiers produced by this operator.

Inherited from

PlanTupleOperator.schema

---

schemaSet

schemaSet: IdSet

Defined in: packages/core/src/plan/visitor.ts:40

Trie-backed set of the same paths as schema; used for O(k) membership tests.

Inherited from

PlanTupleOperator.schemaSet

---

source

source: PlanTupleOperator

Defined in: packages/core/src/plan/operators/tuple/order.ts:36

Tuple operator providing the input rows.

Methods

accept()

accept<Ret, Arg>(visitors, arg?): Ret

Defined in: packages/core/src/plan/operators/tuple/order.ts:47

PlanOperator.accept

Type Parameters

Type Parameter
Ret
Arg

Parameters

Parameter	Type
visitors	Record<string, PlanVisitor<Ret, Arg>>
arg?	Arg

Returns

Ret

Overrides

PlanTupleOperator.accept

---

addToSchema()

addToSchema(item): void

Defined in: packages/core/src/plan/visitor.ts:57

will preserve object references

Parameters

Parameter	Type
item	IdSet | ASTIdentifier | ASTIdentifier[]

Returns

void

Inherited from

PlanTupleOperator.addToSchema

---

clearSchema()

clearSchema(): void

Defined in: packages/core/src/plan/visitor.ts:102

will preserve object references

Returns

void

Inherited from

PlanTupleOperator.clearSchema

---

clone()

clone(): OrderBy

Defined in: packages/core/src/plan/operators/tuple/order.ts:76

PlanOperator.clone

Returns

OrderBy

Overrides

PlanTupleOperator.clone

---

getChildren()

getChildren(): PlanOperator[]

Defined in: packages/core/src/plan/operators/tuple/order.ts:70

PlanOperator.getChildren

Returns

PlanOperator[]

Overrides

PlanTupleOperator.getChildren

---

getDependencies()

getDependencies(): IdSet

Defined in: packages/core/src/plan/operators/tuple/order.ts:89

PlanOperator.getDependencies

Returns

IdSet

Overrides

PlanTupleOperator.getDependencies

---

removeFromSchema()

removeFromSchema(item): boolean

Defined in: packages/core/src/plan/visitor.ts:80

will preserve object references

Parameters

Parameter	Type
item	IdSet | ASTIdentifier | ASTIdentifier[]

Returns

boolean

Inherited from

PlanTupleOperator.removeFromSchema

---

replaceChild()

replaceChild(current, replacement): void

Defined in: packages/core/src/plan/operators/tuple/order.ts:54

PlanOperator.replaceChild

Parameters

Parameter	Type
current	PlanOperator
replacement	OpOrId

Returns

void

Overrides

PlanTupleOperator.replaceChild