VectorIndexQueryOptions class

Query options for vector indexes.

Inheritance

Constructors

VectorIndexQueryOptions.new({bool enableIndexScan = true, bool enableSeqScan = true, int minParallelTableScanSize = 1024, double parallelSetupCost = 1000.0, int maintenanceWorkMem = 65536, int maxParallelMaintenanceWorkers = 2, int maxParallelWorkersPerGather = 2})
Creates a new vector index query options object.
const

Properties

enableIndexScan bool
Whether to enable index scan. Default is true.
final
enableSeqScan bool
Whether to enable sequential scan. Default is true.
final
hashCode int
The hash code for this object.
no setterinherited
maintenanceWorkMem int
The maintenance work memory (in KB). Default is 65536 (64MB).
final
maxParallelMaintenanceWorkers int
The maximum parallel maintenance workers. Default is 2.
final
maxParallelWorkersPerGather int
The maximum parallel workers per gather. Default is 2.
final
minParallelTableScanSize int
The minimum parallel table scan size (in 8kB blocks). Default is 1024 blocks (8MB).
final
options Map<String, dynamic>
The options that this runtime parameters group can set. The key is the name of the option as it appears in the SQL statement, and the value is the value to set it to. The value can also be a RuntimeParameters.
no setteroverride
parallelSetupCost double
The parallel setup cost. Default is 1000.0.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

build({required bool isLocal}) String
Returns the SQL statement to set the runtime parameters. If isLocal is true, options are set for the current transaction only and not globally.
inherited
buildCheckValues() String
Returns a SELECT statement to check current values of all options. When running the query, parameters that were not yet set will return null.
inherited
buildStatements({required bool isLocal}) Iterable<String>
Returns a list with the SQL statements to set each runtime parameters. If isLocal is true, options are set for the current transaction only.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited