This guide explains the usage of each function provided in the MongoDB function module.
Initialize and return the MongoDB collection.
Parameters:
uri
: MongoDB connection URI.db_name
: Name of the MongoDB database.collection_name
: Name of the MongoDB collection.
Returns:
- MongoDB collection object.
Initialize and return the MongoDB collection using TLS certificate authentication.
Parameters:
uri
: MongoDB connection URI.certificate_path
: Path to the TLS certificate file.db_name
: Name of the MongoDB database.collection_name
: Name of the MongoDB collection.
Returns:
- MongoDB collection object.
Insert data into the MongoDB collection.
Parameters:
collection
: MongoDB collection object.data
: Dictionary containing the data to be inserted.
Returns:
- MongoDB insert result.
Retrieve data from the MongoDB collection where 'available' is True.
Parameters:
collection
: MongoDB collection object.
Returns:
- Cursor pointing to the retrieved data.
Retrieve all data from the MongoDB collection.
Parameters:
collection
: MongoDB collection object.
Returns:
- Cursor pointing to all data in the collection.
Retrieve a single document from the MongoDB collection by its ID.
Parameters:
collection
: MongoDB collection object.id_data
: ID of the document to retrieve.
Returns:
- Single documen 8000 t matching the provided ID.
Remove data from the MongoDB collection by its ID and set 'available' to False.
Parameters:
collection
: MongoDB collection object.id_data
: ID of the document to remove.
Returns:
- MongoDB update result.
Remove data from the MongoDB collection by its ID.
Parameters:
collection
: MongoDB collection object.id_data
: ID of the document to remove.
Returns:
- MongoDB delete result.
Update data in the MongoDB collection by its ID.
Parameters:
collection
: MongoDB collection object.id_data
: ID of the document to update.data
: Updated data as a dictionary.
Returns:
- MongoDB update result.
Delete all data from the MongoDB collection.
Parameters:
collection
: MongoDB collection object.
Returns:
- MongoDB delete result.
Count documents in the MongoDB collection where 'available' is True.
Parameters:
collection
: MongoDB collection object.
Returns:
- Number of documents where 'available' is True.
Count all documents in the MongoDB collection.
Parameters:
collection
: MongoDB collection object.
Returns:
- Total number of documents in the collection.
Retrieve data from the MongoDB collection based on a specific field and its value.
Parameters:
collection
: MongoDB collection object.field_name
: Name of the field to search.field_value
: Value to search for in the specified field.
Returns:
- Cursor pointing to the retrieved data.
Update existing data if found, or insert new data if not found.
Parameters:
collection
: MongoDB collection object.query
: Query to identify the document to update.data
: Data to be updated or inserted.
Returns:
- MongoDB update result.
Search across all fields of the MongoDB collection and return matching documents.
Parameters:
collection
: MongoDB collection object.search_query
: Search query string.
Returns:
- Cursor pointing to the retrieved data.
Search for the given term in all fields of the MongoDB collection.
Parameters:
collection
: MongoDB collection object.search_term
: Term to search for in all fields.
Returns:
- Cursor pointing to the retrieved data.
Close the connection to the MongoDB database.
Parameters:
collection
: MongoDB collection object.
Generate a UUID using the uuid7 · PyPI strategy.
Returns:
- UUID string.