cursor.pretty()¶

On this page

Definition
Examples

Definition¶

cursor.pretty()¶

Configures the cursor to display results in an easy-to-read format.

The pretty() method has the following prototype form:

db.collection.find(<query>).pretty()

Examples¶

Consider the following document:

copy

db.books.save({
    "_id" : ObjectId("54f612b6029b47909a90ce8d"),
    "title" : "A Tale of Two Cities",
    "text" : "It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness...",
    "authorship" : "Charles Dickens"})

By default, db.collection.find() returns data in a dense format:

copy

db.books.find()
{ "_id" : ObjectId("54f612b6029b47909a90ce8d"), "title" : "A Tale of Two Cities", "text" : "It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness...", "authorship" : "Charles Dickens" }

By using cursor.pretty() you can set the cursor to return data in a format that is easier for humans to parse:

copy

db.books.find().pretty()
{
    "_id" : ObjectId("54f612b6029b47909a90ce8d"),
    "title" : "A Tale of Two Cities",
    "text" : "It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness...",
    "authorship" : "Charles Dickens"
}

← cursor.objsLeftInBatch() cursor.readConcern() →