Class: IndexScan

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:110

A TupleSource variant that uses a secondary Index for efficient key-based row lookup rather than a full sequential scan.

Extends

• TupleSource

Constructors

Constructor

new IndexScan(lang, name, index, access, fromItemKey?): IndexScan

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:111

Parameters

Parameter	Type	Description
lang	Lowercase<string>	-
name	ASTIdentifier	-
index	Index	The secondary index to probe.
access	Calculation	Calculation that produces the lookup key(s) passed to the index.
fromItemKey?	ASTIdentifier	When set, the lookup key is taken from this item-level attribute instead of access.

Returns

IndexScan

Overrides

TupleSource.constructor

Properties

access

access: Calculation

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:117

Calculation that produces the lookup key(s) passed to the index.

---

fromItemKey?

optional fromItemKey?: ASTIdentifier

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:119

When set, the lookup key is taken from this item-level attribute instead of access.

---

index

index: Index

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:115

The secondary index to probe.

---

lang

lang: Lowercase<string>

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

PlanOperator.lang

Inherited from

TupleSource.lang

---

name

name: ASTIdentifier

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:20

Identifier of the data source to read from.

Inherited from

TupleSource.name

---

parent?

optional parent?: PlanOperator

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

PlanOperator.parent

Inherited from

TupleSource.parent

---

schema

schema: ASTIdentifier[]

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

Ordered list of attribute identifiers produced by this operator.

Inherited from

TupleSource.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

TupleSource.schemaSet

Methods

accept()

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

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:126

PlanOperator.accept

Type Parameters

Type Parameter
Ret
Arg

Parameters

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

Returns

Ret

Overrides

TupleSource.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

TupleSource.addToSchema

---

clearSchema()

clearSchema(): void

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

will preserve object references

Returns

void

Inherited from

TupleSource.clearSchema

---

clone()

clone(): IndexScan

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:147

PlanOperator.clone

Returns

IndexScan

Overrides

TupleSource.clone

---

getChildren()

getChildren(): PlanOperator[]

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:143

PlanOperator.getChildren

Returns

PlanOperator[]

Overrides

TupleSource.getChildren

---

getDependencies()

getDependencies(): IdSet

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

PlanOperator.getDependencies

Returns

IdSet

Inherited from

TupleSource.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

TupleSource.removeFromSchema

---

replaceChild()

replaceChild(current, replacement): void

Defined in: packages/core/src/plan/operators/tuple/tuple-source.ts:134

PlanOperator.replaceChild

Parameters

Parameter	Type
current	PlanOperator
replacement	PlanOperator

Returns

void

Overrides

TupleSource.replaceChild