pygsti.io.readers.remove_resultsdir_from_mongodb

pygsti.io.readers.remove_resultsdir_from_mongodb#

remove_resultsdir_from_mongodb(mongodb, doc_id, comm=None, session=None, recursive='default')#

Remove ProtocolsResultsDir data from a MongoDB database.

Parameters:

  • mongodb (pymongo.database.Database) – The MongoDB instance to remove data from.

  • doc_id (str) – The user-defined identifier of the results directory to remove.

  • comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator used to synchronize database access.

  • session (pymongo.client_session.ClientSession, optional) – MongoDB session object to use when interacting with the MongoDB database. This can be used to implement transactions among other things.

  • recursive (RecursiveRemovalSpecification, optional) – An object that filters the type of documents that are removed. Used when working with inter-related experiment designs, data, and results objects to only remove the types of documents you know aren’t being shared with other documents.

Return type:

None