QueryPlanner

public struct QueryPlanner

A structure responsible for planning and optimizing database queries.

QueryPlanner provides statistical information about indexes and shards to assist in query execution planning.

Properties:
- indexStats: A dictionary containing statistics for each index, where the key is the index name and the value is an IndexStat object.
- shardStats: An array of ShardStat objects representing statistics for each shard in the database.


                    
                    
                    indexStats

Undocumented

Swift

public let indexStats: [String : IndexStat]


                    
                    
                    init(indexStats:shardStats:)

Initializes a new instance of the QueryPlanner class.

Swift

public init(indexStats: [String : IndexStat], shardStats: [ShardStat])

`indexStats`	A dictionary containing statistics for each index, where the key is the index name and the value is an `IndexStat` object.
`shardStats`	An array of `ShardStat` objects representing statistics for each shard.


                    
                    
                    optimize(collection:predicates:availableIndexes:)

Optimizes the execution plan for a query based on the provided collection, predicates, and available indexes.

Swift

public func optimize(
    collection: String,
    predicates: [(field: String, op: QueryOperator)],
    availableIndexes: [String]
) -> ExecutionPlan

`collection`	The name of the collection to query.
`predicates`	An array of tuples representing the query predicates, where each tuple contains:
`availableIndexes`	A list of available indexes for the collection.

An ExecutionPlan object representing the optimized query execution plan.