pygsti.io.mongodb.create_mongodb_indices_for_pygsti_collections

pygsti.io.mongodb.create_mongodb_indices_for_pygsti_collections#

create_mongodb_indices_for_pygsti_collections(mongodb)#

Create, if not existing already, indices useful for speeding up pyGSTi MongoDB operations.

Indices are created as necessary within pygsti_* collections. While not necessary for database operations, these indices may dramatically speed up the reading and writing of pygsti objects to/from a Mongo database. You only need to call this once per database, typically when the database is first setup.

Parameters:

mongodb (pymongo.database.Database) – The MongoDB instance to create indices in.

Return type:

None