pygsti.io.mongodb.remove_dict_from_mongodb

pygsti.io.mongodb.remove_dict_from_mongodb#

remove_dict_from_mongodb(mongodb, collection_name, identifying_metadata, session=None)#

Remove elements of (separate documents) of a dictionary stored in a MongoDB collection

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

  • collection_name (str) – the MongoDB collection within mongodb to remove documents from.

  • identifying_metadata (dict) – JSON-able metadata that identifies the dictionary being serialized.

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

Return type:

None