Skip to main content

Class: Limit

Defined in: packages/core/src/plan/operators/item/limit.ts:10

Skips the first skip rows of its source and then passes at most limit rows through.

Extends​

Constructors​

Constructor​

new Limit(lang, skip, limit, source): Limit

Defined in: packages/core/src/plan/operators/item/limit.ts:11

Parameters​

ParameterTypeDescription
langLowercase<string>-
skipnumberNumber of leading rows to skip.
limitnumberMaximum number of rows to emit; Infinity means no upper bound.
sourcePlanOperatorTuple operator to read from.

Returns​

Limit

Overrides​

PlanTupleOperator.constructor

Properties​

lang​

lang: Lowercase<string>

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

PlanOperator.lang

Inherited from​

PlanTupleOperator.lang


limit​

limit: number

Defined in: packages/core/src/plan/operators/item/limit.ts:16

Maximum number of rows to emit; Infinity means no upper bound.


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


skip​

skip: number

Defined in: packages/core/src/plan/operators/item/limit.ts:14

Number of leading rows to skip.


source​

source: PlanOperator

Defined in: packages/core/src/plan/operators/item/limit.ts:18

Tuple operator to read from.

Methods​

accept()​

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

Defined in: packages/core/src/plan/operators/item/limit.ts:28

PlanOperator.accept

Type Parameters​

Type Parameter
Ret
Arg

Parameters​

ParameterType
visitorsRecord<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​

ParameterType
itemIdSet | 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(): Limit

Defined in: packages/core/src/plan/operators/item/limit.ts:44

PlanOperator.clone

Returns​

Limit

Overrides​

PlanTupleOperator.clone


getChildren()​

getChildren(): PlanOperator[]

Defined in: packages/core/src/plan/operators/item/limit.ts:40

PlanOperator.getChildren

Returns​

PlanOperator[]

Overrides​

PlanTupleOperator.getChildren


getDependencies()​

getDependencies(): IdSet

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

PlanOperator.getDependencies

Returns​

IdSet

Inherited from​

PlanTupleOperator.getDependencies


removeFromSchema()​

removeFromSchema(item): boolean

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

will preserve object references

Parameters​

ParameterType
itemIdSet | ASTIdentifier | ASTIdentifier[]

Returns​

boolean

Inherited from​

PlanTupleOperator.removeFromSchema


replaceChild()​

replaceChild(current, replacement): void

Defined in: packages/core/src/plan/operators/item/limit.ts:35

PlanOperator.replaceChild

Parameters​

ParameterType
currentPlanOperator
replacementPlanOperator

Returns​

void

Overrides​

PlanTupleOperator.replaceChild