Метод db.collection.find

https://www.mongodb.com/docs/manual/reference/method/db.collection.find/

db.collection.find(query, projection, options)

Вибирає документи в колекції або поданні та повертає cursor до вибраних документів.

Projection

Параметр projection означує, які поля повертаються у відповідних документах. Параметр projection приймає документ такої форми:

{ <field1>: <value>, <field2>: <value> ... }

Специфікація вбудованого поля

Для полів у вбудованих документах ви можете вказати поле за допомогою:

• нотація з точкою; e.g. "field.nestedfield": <value>
• вкладена форма; наприклад { field: { nestedfield: <value> } } (Starting in MongoDB 4.4)

_id Field Projection

Поле _id включено до повернених документів за замовчуванням, якщо ви явно не вкажете _id: 0 у проекції, щоб приховати поле.

Включення чи виключення

Проекція (projection) не може містити як специфікації включення, так і виключення, за винятком поля _id:

• У projection, які явно включають поля, поле _id є єдиним полем, яке можна явно виключити.
• У projection, які явно виключають поля, поле _id є єдиним полем, яке можна явно включити; однак поле _id включено за замовчуванням.

Див. Приклади проекцій.

Обробка курсору

Виконання db.collection.find() у mongosh автоматично повторює курсор, щоб відобразити до перших 20 документів. Введіть it, щоб продовжити ітерацію. Щоб отримати доступ до повернених документів за допомогою драйвера, скористайтеся відповідним механізмом обробки курсору для мови драйвера.

Див також:

• Iterate the Returned Cursor
• Modify the Cursor Behavior
• Available mongosh Cursor Methods

Read Concern

Щоб указати read concern для db.collection.find(), використовуйте метод cursor.readConcern()

Брекетинг типу

MongoDB розглядає деякі типи даних як еквівалентні для порівняння. Наприклад, числові типи піддаються перетворенню перед порівнянням. Однак для більшості типів даних оператори порівняння виконують порівняння лише в документах, де тип BSON цільового поля відповідає типу операнда запиту. Розглянемо таку колекцію:

{ "_id": "apples", "qty": 5 }
{ "_id": "bananas", "qty": 7 }
{ "_id": "oranges", "qty": { "in stock": 8, "ordered": 12 } }
{ "_id": "avocados", "qty": "fourteen" }

Наступний запит використовує $gt, щоб повернути документи, де значення “кількість” більше за “4”.

db.collection.find( { qty: { $gt: 4 } } )

Запит повертає такі документи:

{ "_id": "apples", "qty": 5 }
{ "_id": "bananas", "qty": 7 }

Документ із _id, що дорівнює "avocados", не повертається, оскільки його значення qty має тип string, тоді як $gt операнд має тип integer. Документ із значенням _id, що дорівнює "oranges", не повертається, оскільки його значення qty має тип object. Щоб застосувати типи даних у колекції, використовуйте Перевірку схеми.

Sessions

Для курсорів, створених у сеансі, ви не можете викликати getMore поза сеансом. Так само для курсорів, створених поза сеансом, ви не можете викликати getMore всередині сесії.

Час простою сеансу

Драйвери MongoDB і mongosh пов’язують усі операції з сеансом сервера, за винятком непідтверджених операцій запису. Для операцій, явно не пов’язаних із сеансом (тобто використання Mongo.startSession()), драйвери MongoDB і mongosh створюють неявний сеанс і пов’язують його з операцією.

Якщо сеанс неактивний більше 30 хвилин, сервер MongoDB позначає цей сеанс як завершений і може закрити його в будь-який час. Коли сервер MongoDB закриває сеанс, він також припиняє всі поточні операції та відкриває курсори, пов’язані з сеансом. Це включає курсори, налаштовані за допомогою noCursorTimeout() або maxTimeMS( ) понад 30 хвилин. Для операцій, які можуть бути неактивними довше 30 хвилин, пов’яжіть операцію з явним сеансом за допомогою Mongo.startSession() і періодично оновлювати сеанс за допомогою refreshSessions. Для отримання додаткової інформації див. Тайм-аут простою сеансу.

Transactions

db.collection.find() can be used inside multi-document transactions.

• For cursors created outside of a transaction, you cannot call getMore inside the transaction.
• For cursors created in a transaction, you cannot call getMore outside the transaction.

In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document transactions should not be a replacement for effective schema design. For many scenarios, the denormalized data model (embedded documents and arrays) will continue to be optimal for your data and use cases. That is, for many scenarios, modeling your data appropriately will minimize the need for multi-document transactions.

For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.

Транзакції

db.collection.find() можна використовувати всередині багатодокументних транзакцій.

• Для курсорів, створених поза транзакцією, ви не можете викликати getMore всередині транзакції .
• Для курсорів, створених у транзакції, ви не можете викликати getMore поза транзакцією.

У більшості випадків транзакції з кількома документами спричиняють більшу вартість продуктивності порівняно з записом одного документа, і доступність транзакцій з кількома документами не повинна замінювати ефективний дизайн схеми. Для багатьох сценаріїв денормалізована модель даних (вбудовані документи та масиви) залишатиметься оптимальним для ваших даних і випадків використання. Тобто для багатьох сценаріїв належне моделювання ваших даних зведе до мінімуму потребу в багатодокументних транзакціях.

Додаткові зауваження щодо використання транзакцій (наприклад, обмеження часу виконання та обмеження розміру oplog) також див.

Відключення клієнта

Починаючи з MongoDB 4.2, якщо клієнт, який видав db.collection.find() від’єднується до завершення операції, MongoDB позначає db.collection.find() для завершення за допомогою killOp.

Приклади

У прикладах у цьому розділі використовуються документи з колекції bios, де документи зазвичай мають такий вигляд:

{
    "_id" : <value>,
    "name" : { "first" : <string>, "last" : <string> },       // embedded document
    "birth" : <ISODate>,
    "death" : <ISODate>,
    "contribs" : [ <string>, ... ],                           // Array of Strings
    "awards" : [
        { "award" : <string>, year: <number>, by: <string> }  // Array of embedded documents
        ...
    ]
}

Щоб створити та заповнити колекцію bios, див The bios Example Collection.

Знайти всі документи в колекції

Метод find() без параметрів повертає всі документи з колекції та повертає всі поля для документів. Наприклад, наступна операція повертає всі документи в колекцію bios:

db.bios.find()

Знайдіть документи, які відповідають критеріям запиту

Запит на рівність

• Наступна операція повертає документи в колекцію bios, де _id дорівнює 5:

db.bios.find( { _id: 5 } )

Наступна операція повертає документи в колекцію bios, де поле last у вбудованому документі name дорівнює ` “Hopper”`:

db.bios.find( { "name.last": "Hopper" } )

Щоб отримати доступ до полів у вбудованому документі, використовуйте крапковий запис ("<вбудований документ>.<поле>").

Query Using Operators

To find documents that match a set of selection criteria, call find() with the <criteria> parameter.

MongoDB provides various query operators to specify the criteria.

• The following operation uses the $in operator to return documents in the bios collection where _id equals either 5 or ObjectId("507c35dd8fada716c89d0013"):

  db.bios.find(
     { _id: { $in: [ 5, ObjectId("507c35dd8fada716c89d0013") ] } }
  )
  

The following operation uses the $gt operator returns all the documents from the bios collection where birth is greater than new Date('1950-01-01'):

db.bios.find( { birth: { $gt: new Date('1950-01-01') } } )

The following operation uses the $regex operator to return documents in the bios collection where name.last field starts with the letter N (or is "LIKE N%")

db.bios.find(
   { "name.last": { $regex: /^N/ } }
)

For a list of the query operators, see Query Selectors.

Query for Ranges

Combine comparison operators to specify ranges for a field. The following operation returns from the bios collection documents where birth is between new Date('1940-01-01') and new Date('1960-01-01') (exclusive):

db.bios.find( { birth: { $gt: new Date('1940-01-01'), $lt: new Date('1960-01-01') } } )

For a list of the query operators, see Query Selectors.

Query for Multiple Conditions

The following operation returns all the documents from the bios collection where birth field is greater than new Date('1950-01-01') and death field does not exists:

db.bios.find( {
   birth: { $gt: new Date('1920-01-01') },
   death: { $exists: false }
} )

For a list of the query operators, see Query Selectors.

Query Embedded Documents

The following examples query the name embedded field in the bios collection.

Query Exact Matches on Embedded Documents

The following operation returns documents in the bios collection where the embedded document name is exactly { first: "Yukihiro", last: "Matsumoto" }, including the order:

db.bios.find(
    { name: { first: "Yukihiro", last: "Matsumoto" } }
)

The name field must match the embedded document exactly. The query does not match documents with the following name fields:

{
   first: "Yukihiro",
   aka: "Matz",
   last: "Matsumoto"
}

{
   last: "Matsumoto",
   first: "Yukihiro"
}

Query Fields of an Embedded Document

The following operation returns documents in the bios collection where the embedded document name contains a field first with the value "Yukihiro" and a field last with the value "Matsumoto". The query uses dot notation to access fields in an embedded document:

db.bios.find(
   {
     "name.first": "Yukihiro",
     "name.last": "Matsumoto"
   }
)

The query matches the document where the name field contains an embedded document with the field first with the value "Yukihiro" and a field last with the value "Matsumoto". For instance, the query would match documents with name fields that held either of the following values:

{
  first: "Yukihiro",
  aka: "Matz",
  last: "Matsumoto"
}

{
  last: "Matsumoto",
  first: "Yukihiro"
}

For more information and examples, see also Query on Embedded/Nested Documents.

Query Arrays

Query for an Array Element

The following examples query the contribs array in the bios collection.

• The following operation returns documents in the bios collection where the array field contribs contains the element "UNIX":

  db.bios.find( { contribs: "UNIX" } )
  

The following operation returns documents in the bios collection where the array field contribs contains the element "ALGOL" or "Lisp":

db.bios.find( { contribs: { $in: [ "ALGOL", "Lisp" ]} } )

The following operation use the $all query operator to return documents in the bios collection where the array field contribs contains both the elements "ALGOL" and "Lisp":

db.bios.find( { contribs: { $all: [ "ALGOL", "Lisp" ] } } )

For more examples, see $all. See also $elemMatch.

The following operation uses the $size operator to return documents in the bios collection where the array size of contribs is 4:

db.bios.find( { contribs: { $size: 4 } } )

For more information and examples of querying an array, see:

• Query an Array
• Query an Array of Embedded Documents

For a list of array specific query operators, see Array.

Query an Array of Documents

The following examples query the awards array in the bios collection.

• The following operation returns documents in the bios collection where the awards array contains an element with award field equals "Turing Award":

  db.bios.find(
     { "awards.award": "Turing Award" }
  )
  

The following operation returns documents in the bios collection where the awards array contains at least one element with both the award field equals "Turing Award" and the year field greater than 1980:

db.bios.find(
   { awards: { $elemMatch: { award: "Turing Award", year: { $gt: 1980 } } } }
)

• Use the $elemMatch operator to specify multiple criteria on an array element.

For more information and examples of querying an array, see:

• Query an Array
• Query an Array of Embedded Documents

For a list of array specific query operators, see Array.

Projections

Параметр projection означує, які поля повертати. Параметр містить специфікації включення або виключення, але не обидва, якщо виключення не стосується поля _id.

Якщо поле _id явно не виключено в документі проекції _id: 0, повертається поле _id.

Означення полів для повернення

Наступна операція знаходить усі документи в колекції bios і повертає лише поле name, поле contribs і Поле _id:

db.bios.find( { }, { name: 1, contribs: 1 } )

Якщо поле _id явно не виключено в документі проекції _id: 0, повертається поле _id.

Явне виключення полів

Наступна операція запитує колекцію bios і повертає всі поля окрім поля first в name вбудований документ і поле birth:

db.bios.find(
   { contribs: 'OOP' },
   { 'name.first': 0, birth: 0 }
)

Явне виключення поля _id

Якщо поле _id явно не виключено в документі проекції _id: 0, повертається поле _id.

Наступна операція знаходить документи в колекції bios і повертає лише поля name і contribs:

db.bios.find(
   { },
   { name: 1, contribs: 1, _id: 0 }
)

Про масиви та вбудовані документи

Наступна операція запитує колекцію bios і повертає поле last у вбудованому документі name і перше два елементи в масиві contribs:

db.bios.find(
   { },
   { _id: 0, 'name.last': 1, contribs: { $slice: 2 } } )

Починаючи з MongoDB 4.4, ви також можете вказати вбудовані поля за допомогою вкладеної форми, наприклад.

db.bios.find(
   { },
   { _id: 0, name: { last: 1 }, contribs: { $slice: 2 } }
)

Використовуйте вираз агрегації

Починаючи з MongoDB 4.4, db.collection.find() проекція може приймати вирази агрегування та синтаксис. З використанням виразів агрегування і синтаксису, ви можете проектувати нові поля або проектувати існуючі поля з новими значеннями. Наприклад, наступна операція використовує агрегаційні вирази для заміни значення полів name і awards, а також для включення нових полів reportDate, reportBy і reportNumber.

db.bios.find(
   { },
   {
     _id: 0,
     name: {
        $concat: [
           { $ifNull: [ "$name.aka", "$name.first" ] },
           " ",
           "$name.last"
        ]
     },
     birth: 1,
     contribs: 1,
     awards: { $cond: { if: { $isArray: "$awards" }, then: { $size: "$awards" }, else: 0 } },
     reportDate: { $dateToString: {  date: new Date(), format: "%Y-%m-%d" } },
     reportBy: "hellouser123",
     reportNumber: { $literal: 1 }
   }
)

Щоб встановити для поля reportRun значення 1 Операція повертає такі документи:

{ "birth" : ISODate("1924-12-03T05:00:00Z"), "contribs" : [ "Fortran", "ALGOL", "Backus-Naur Form", "FP" ], "name" : "John Backus", "awards" : 4, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1927-09-04T04:00:00Z"), "contribs" : [ "Lisp", "Artificial Intelligence", "ALGOL" ], "name" : "John McCarthy", "awards" : 3, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1906-12-09T05:00:00Z"), "contribs" : [ "UNIVAC", "compiler", "FLOW-MATIC", "COBOL" ], "name" : "Grace Hopper", "awards" : 4, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1926-08-27T04:00:00Z"), "contribs" : [ "OOP", "Simula" ], "name" : "Kristen Nygaard", "awards" : 3, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1931-10-12T04:00:00Z"), "contribs" : [ "OOP", "Simula" ], "name" : "Ole-Johan Dahl", "awards" : 3, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1956-01-31T05:00:00Z"), "contribs" : [ "Python" ], "name" : "Guido van Rossum", "awards" : 2, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1941-09-09T04:00:00Z"), "contribs" : [ "UNIX", "C" ], "name" : "Dennis Ritchie", "awards" : 3, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1965-04-14T04:00:00Z"), "contribs" : [ "Ruby" ], "name" : "Matz Matsumoto", "awards" : 1, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "birth" : ISODate("1955-05-19T04:00:00Z"), "contribs" : [ "Java" ], "name" : "James Gosling", "awards" : 2, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }
{ "contribs" : [ "Scala" ], "name" : "Martin Odersky", "awards" : 0, "reportDate" : "2020-06-05", "reportBy" : "hellouser123", "reportNumber" : 1 }

Iterate the Returned Cursor

The find() method returns a cursor to the results.

In mongosh, if the returned cursor is not assigned to a variable using the var keyword, the cursor is automatically iterated to access up to the first 20 documents that match the query. You can set the DBQuery.shellBatchSize variable to change the number of automatically iterated documents.

To manually iterate over the results, assign the returned cursor to a variable with the var keyword, as shown in the following sections.

With Variable Name

The following example uses the variable myCursor to iterate over the cursor and print the matching documents:

var myCursor = db.bios.find( );

myCursor

With next() Method

The following example uses the cursor method next() to access the documents:

var myCursor = db.bios.find( );

var myDocument = myCursor.hasNext() ? myCursor.next() : null;

if (myDocument) {
    var myName = myDocument.name;
    print (tojson(myName));
}

To print, you can also use the printjson() method instead of print(tojson()):

if (myDocument) {
   var myName = myDocument.name;
   printjson(myName);
}

With forEach() Method

The following example uses the cursor method forEach() to iterate the cursor and access the documents:

var myCursor = db.bios.find( );

myCursor.forEach(printjson);

Modify the Cursor Behavior

mongosh and the drivers provide several cursor methods that call on the cursor returned by the find() method to modify its behavior.

Order Documents in the Result Set

The sort() method orders the documents in the result set. The following operation returns documents in the bios collection sorted in ascending order by the name field:

db.bios.find().sort( { name: 1 } )

sort() corresponds to the ORDER BY statement in SQL.

Limit the Number of Documents to Return

The limit() method limits the number of documents in the result set. The following operation returns at most 5 documents in the bios collection:

db.bios.find().limit( 5 )

limit() corresponds to the LIMIT statement in SQL.

Set the Starting Point of the Result Set

The skip() method controls the starting point of the results set. The following operation skips the first 5 documents in the bios collection and returns all remaining documents:

db.bios.find().skip( 5 )

Specify Collation

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

The collation() method specifies the collation for the db.collection.find() operation.

db.bios.find( { "name.last": "hopper" } ).collation( { locale: "en_US", strength: 1 } )

Combine Cursor Methods

The following statements chain cursor methods limit() and sort():

db.bios.find().sort( { name: 1 } ).limit( 5 )
db.bios.find().limit( 5 ).sort( { name: 1 } )

The two statements are equivalent; i.e. the order in which you chain the limit() and the sort() methods is not significant. Both statements return the first five documents, as determined by the ascending sort order on ‘name’.

Use Variables in let Option

You can specify query options to modify query behavior and indicate how results are returned.

For example, to define variables that you can access elsewhere in the find method, use the let option. To filter results using a variable, you must access the variable within the $expr operator.

Create a collection cakeFlavors:

db.cakeFlavors.insertMany( [
   { _id: 1, flavor: "chocolate" },
   { _id: 2, flavor: "strawberry" },
   { _id: 3, flavor: "cherry" }
] )

The following example defines a targetFlavor variable in let and uses the variable to retrieve the chocolate cake flavor:

db.cakeFlavors.find(
   { $expr: { $eq: [ "$flavor", "$$targetFlavor" ] } },
   { _id: 0 },
   { let : { targetFlavor: "chocolate" }
} )

Output:

[ { flavor: 'chocolate' } ]

To see all available query options, see FindOptions.