How to check if the PyMongo Cursor is Empty?

PyMongo is a Python library that provides a way to interact with MongoDB, the popular NoSQL document-oriented database. It allows developers to easily connect to MongoDB instances and perform operations like inserting, retrieving, and querying documents.

Understanding PyMongo Cursors

A cursor in MongoDB is an object that points to query results. When you execute the find() method, the results are returned as a cursor object. You can iterate through this cursor to access the documents in the result set.

In PyMongo, the cursor is represented by the Cursor class. This object contains the results of your search query and provides methods to check if results exist.

Method 1: Using try-except with next()

The most reliable way to check if a cursor is empty is using next() with exception handling ?

import pymongo

# Simulating PyMongo cursor behavior with a list
def simulate_empty_cursor():
    return iter([])  # Empty iterator

def simulate_non_empty_cursor():
    return iter([{'name': 'John'}, {'name': 'Jane'}])  # Non-empty iterator

# Check empty cursor
cursor = simulate_empty_cursor()
try:
    next(cursor)
    print("Cursor has documents")
except StopIteration:
    print("Cursor is empty")

Cursor is empty

Method 2: Converting to List

You can convert the cursor to a list to check if it contains documents ?

import pymongo

# Simulating cursor with sample data
def simulate_cursor_with_data():
    return iter([{'_id': 1, 'name': 'Alice'}, {'_id': 2, 'name': 'Bob'}])

def simulate_empty_cursor():
    return iter([])

# Check non-empty cursor
cursor = simulate_cursor_with_data()
results = list(cursor)

if len(results) == 0:
    print("Cursor is empty")
else:
    print(f"Cursor has {len(results)} documents")
    for doc in results:
        print(doc)

Cursor has 2 documents
{'_id': 1, 'name': 'Alice'}
{'_id': 2, 'name': 'Bob'}

Method 3: Using count() Method

For actual PyMongo cursors, you can use the count() method to check document count ?

# This demonstrates the concept (requires actual MongoDB connection)
# cursor = collection.find({'status': 'active'})
# document_count = cursor.count()

# Simulation of count behavior
def simulate_cursor_count():
    documents = [{'name': 'Alice'}, {'name': 'Bob'}, {'name': 'Charlie'}]
    return len(documents)

document_count = simulate_cursor_count()

if document_count == 0:
    print("Cursor is empty")
else:
    print(f"Cursor contains {document_count} documents")

Cursor contains 3 documents

Comparison of Methods

Real-World Example Structure

Here's how you would typically structure cursor checking in a real PyMongo application ?

import pymongo

# Connection setup
client = pymongo.MongoClient("mongodb://localhost:27017/")
db = client["mydatabase"]
collection = db["users"]

# Method 1: Check with next()
cursor = collection.find({"status": "active"})
try:
    first_doc = next(cursor)
    print("Found documents:", first_doc)
    # Process remaining documents
    for doc in cursor:
        print(doc)
except StopIteration:
    print("No active users found")

# Method 2: Using estimated_document_count() (newer approach)
total_docs = collection.estimated_document_count()
if total_docs == 0:
    print("Collection is empty")
else:
    print(f"Collection has approximately {total_docs} documents")

Conclusion

Use next() with try-except for memory-efficient cursor checking. For simple cases, converting to a list works well but consumes more memory. Choose the method based on your specific needs and PyMongo version.