index

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 25, 2023 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DeleteOperator

type DeleteOperator struct {
	stream.BaseOperator
	// contains filtered or unexported fields
}

DeleteOperator reads the input stream and deletes the object from the specified index.

func Delete

func Delete(indexName string) *DeleteOperator

func (*DeleteOperator) Iterate

func (op *DeleteOperator) Iterate(in *environment.Environment, fn func(out *environment.Environment) error) error

func (*DeleteOperator) String

func (op *DeleteOperator) String() string

type InsertOperator

type InsertOperator struct {
	stream.BaseOperator
	// contains filtered or unexported fields
}

InsertOperator reads the input stream and indexes each object.

func Insert

func Insert(indexName string) *InsertOperator

func (*InsertOperator) Iterate

func (op *InsertOperator) Iterate(in *environment.Environment, fn func(out *environment.Environment) error) error

func (*InsertOperator) String

func (op *InsertOperator) String() string

type ScanOperator

type ScanOperator struct {
	stream.BaseOperator

	// IndexName references the index that will be used to perform the scan
	IndexName string
	// Ranges defines the boundaries of the scan, each corresponding to one value of the group of values
	// being indexed in the case of a composite index.
	Ranges stream.Ranges
	// Reverse indicates the direction used to traverse the index.
	Reverse bool
}

A ScanOperator iterates over the objects of an index.

func Scan

func Scan(name string, ranges ...stream.Range) *ScanOperator

Scan creates an iterator that iterates over each object of the given table.

func ScanReverse

func ScanReverse(name string, ranges ...stream.Range) *ScanOperator

ScanReverse creates an iterator that iterates over each object of the given table in reverse order.

func (*ScanOperator) Iterate

func (it *ScanOperator) Iterate(in *environment.Environment, fn func(out *environment.Environment) error) error

Iterate over the objects of the table. Each object is stored in the environment that is passed to the fn function, using SetCurrentValue.

func (*ScanOperator) String

func (it *ScanOperator) String() string

type ValidateOperator

type ValidateOperator struct {
	stream.BaseOperator
	// contains filtered or unexported fields
}

ValidateOperator reads the input stream and deletes the object from the specified index.

func Validate

func Validate(indexName string) *ValidateOperator

func (*ValidateOperator) Iterate

func (op *ValidateOperator) Iterate(in *environment.Environment, fn func(out *environment.Environment) error) error

func (*ValidateOperator) String

func (op *ValidateOperator) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL