Skip to content

API reference

The reference documents public constructors, methods, parameters and return values from source docstrings. Start with the user guide for examples.

Area Reference
Shared data Queries and workloads, results and summaries
Data inspection Schemas
Estimation contracts Estimator interfaces
MongoDB Queries, executors, estimation, generation, summary parsing
Couchbase Queries, executors, summary parsing

Synchronous classes are the default for scripts and notebooks. Async classes remain available for applications that already use an event loop.