pygsti.io.readers.remove_edesign_from_mongodb

remove_edesign_from_mongodb(mongodb, doc_id, session=None, recursive='default')

Remove an ExperimentDesign from a MongoDB database.

If no experiment design with doc_id exists, this function returns False, otherwise it returns True.

Parameters:

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

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

• 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.

Returns:

True if the specified experiment design was removed, False if it didn’t exist.

Return type:

bool