cursor.pretty()

Definition定义

cursor.pretty()

Important重要

mongosh Method

This is a mongosh method. This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

• mongo shell v4.4
• mongo shell v4.2
• mongo shell v4.0

For MongoDB API drivers, refer to the language specific MongoDB driver documentation.

Configures the cursor to display results in a format that is easy to read.将游标配置为以易于阅读的格式显示结果。

The pretty() method has the following prototype form:pretty()方法具有以下原型形式：

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

Behavior行为

The pretty() method:pretty()方法：

• Does not change the output format in mongosh.不更改mongosh中的输出格式。
• Changes the output format in the legacy mongo shell.更改旧mongo shell中的输出格式。

Examples示例

Consider the following document:考虑以下文件：

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:默认情况下，db.collection.find()以密集格式返回数据：

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 to read:通过使用cursor.pretty()，可以将游标设置为以更易于阅读的格式返回数据：

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"
}