Compartilhar via


find

O find comando no Azure DocumentDB é usado para consultar documentos em uma coleção. Esse comando é fundamental para operações de recuperação de dados e pode ser personalizado com filtros, projeções e opções de consulta para ajustar os resultados.

Sintaxe

A sintaxe básica para o find comando é:

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

Parâmetros

Parâmetro Description
query Um documento que especifica os critérios para que os documentos sejam recuperados
projection (Opcional) Um documento que especifica os campos nos documentos correspondentes a serem retornados no conjunto de resultados
options (Opcional) Um documento que especifica as opções de comportamento e resultados da consulta

Exemplo(s)

Considere este documento de exemplo da coleção de repositórios no banco de dados StoreData.

{
    "_id": "0fcc0bf0-ed18-4ab8-b558-9848e18058f4",
    "name": "First Up Consultants | Beverage Shop - Satterfieldmouth",
    "location": {
        "lat": -89.2384,
        "lon": -46.4012
    },
    "staff": {
        "totalStaff": {
            "fullTime": 8,
            "partTime": 20
        }
    },
    "sales": {
        "totalSales": 75670,
        "salesByCategory": [
            {
                "categoryName": "Wine Accessories",
                "totalSales": 34440
            },
            {
                "categoryName": "Bitters",
                "totalSales": 39496
            },
            {
                "categoryName": "Rum",
                "totalSales": 1734
            }
        ]
    },
    "promotionEvents": [
        {
            "eventName": "Unbeatable Bargain Bash",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 6,
                    "Day": 23
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 7,
                    "Day": 2
                }
            },
            "discounts": [
                {
                    "categoryName": "Whiskey",
                    "discountPercentage": 7
                },
                {
                    "categoryName": "Bitters",
                    "discountPercentage": 15
                },
                {
                    "categoryName": "Brandy",
                    "discountPercentage": 8
                },
                {
                    "categoryName": "Sports Drinks",
                    "discountPercentage": 22
                },
                {
                    "categoryName": "Vodka",
                    "discountPercentage": 19
                }
            ]
        },
        {
            "eventName": "Steal of a Deal Days",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 9,
                    "Day": 21
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 9,
                    "Day": 29
                }
            },
            "discounts": [
                {
                    "categoryName": "Organic Wine",
                    "discountPercentage": 19
                },
                {
                    "categoryName": "White Wine",
                    "discountPercentage": 20
                },
                {
                    "categoryName": "Sparkling Wine",
                    "discountPercentage": 19
                },
                {
                    "categoryName": "Whiskey",
                    "discountPercentage": 17
                },
                {
                    "categoryName": "Vodka",
                    "discountPercentage": 23
                }
            ]
        }
    ]
}

Exemplo 1: recuperar todos os documentos

O comando find() sem filtros de consulta retorna todos os documentos da coleção.

db.stores.find()

Exemplo 2: recuperar documentos com filtros de consulta

Recupere documentos usando um filtro na propriedade name.

db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"})

Exemplo 3: recuperar documentos com filtros de consulta em objetos

Recupere documentos usando filtros de consulta nos campos lat e lon dentro do objeto de localização.

db.stores.find({"location.lat": 13.5236, "location.lon": -82.5707})

Quando a notação dot (.) não é usada para referenciar campos dentro de um objeto, o filtro de consulta deve corresponder exatamente ao objeto inteiro, incluindo a ordem dos campos.

db.stores.find({"location": {"lat": 13.5236, "lon": -82.5707}})

Exemplo 4: recuperar documentos com filtros de consulta em matrizes

Recupere documentos da matriz promotionEvents em que o eventName é "Grand Bargain Gala".

db.stores.find({"promotionEvents.eventName": "Grand Bargain Gala"})

Recupere documentos da matriz "descontos", que está aninhada na matriz promotionEvents em que a categoriaName é "Tapetes de Área".

db.stores.find({"promotionEvents.discounts.categoryName": "Area Rugs"})

Projeções

O segundo documento no comando localizar especifica a lista de campos a serem projetados na resposta.

Incluir um campo específico ou vários campos na resposta

Um valor inteiro diferente de zero ou um valor booliano de true inclui o campo na resposta.

db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"}, {"location": 1, "sales": 1})
db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"}, {"location": true, "sales": true})
db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"}, {"location": 1, "sales": true})
db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"}, {"location": 1, "sales": -5})

Todas as quatro consultas são equivalentes e especificam a inclusão dos campos "local" e "vendas" na resposta do servidor.

{
    "_id": "b5c9f932-4efa-49fd-86ba-b35624d80d95",
    "location": {
        "lat": 13.5236,
        "lon": -82.5707
    },
    "sales": {
        "totalSales": 35346,
        "salesByCategory": [
            {
                "categoryName": "Rulers",
                "totalSales": 35346
            }
        ]
    }
}

Excluir um campo específico ou vários campos na resposta

Um valor inteiro de zero ou um valor booliano de false exclui o campo especificado da resposta da consulta.

db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"}, {"promotionEvents": 0, "location": 0, "sales": 0})
db.stores.find({"name": "Fourth Coffee | Stationery Haven - New Franco"}, {"promotionEvents": false, "location": false, "sales": false})

Ambas as consultas são equivalentes e retornam a seguinte resposta:

{
    "_id": "b5c9f932-4efa-49fd-86ba-b35624d80d95",
    "name": "Fourth Coffee | Stationery Haven - New Franco",
    "staff": {
        "totalStaff": {
            "fullTime": 17,
            "partTime": 5
        }
    }
}

Observação

Por padrão, o campo _id é incluído na resposta do servidor. O documento de projeção não pode conter cláusulas de inclusão e exclusão. No entanto, o campo _id é a única exceção a essa regra e pode ser excluído juntamente com uma lista de campos a serem incluídos e vice-versa.

Projetar o primeiro elemento em uma matriz que corresponda aos critérios de filtro de consulta

O comando "arrayFieldName".$ projeta apenas a primeira ocorrência de um objeto em uma matriz que corresponde aos filtros de consulta especificados.

db.stores.find({"promotionEvents.eventName": "Grand Bargain Gala"}, {"promotionEvents.$": true})

Um dos documentos retornados mostra apenas o primeiro elemento na matriz promotionEvents que tem o nome do evento "Grand Bargain Gala" ao excluir todos os outros elementos na matriz.

{
    "_id": "d7fe6fb9-57e8-471a-b8d2-714e3579a415",
    "promotionEvents": [
        {
            "eventName": "Grand Bargain Gala",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024,
                    "Month": 3,
                    "Day": 25
                },
                "endDate": {
                    "Year": 2024,
                    "Month": 4,
                    "Day": 1
                }
            },
            "discounts": [
                {
                    "categoryName": "Area Rugs",
                    "discountPercentage": 7
                },
                {
                    "categoryName": "Vinyl Flooring",
                    "discountPercentage": 12
                }
            ]
        }
    ]
}

Elementos específicos do projeto em uma matriz que correspondem aos critérios de filtro de consulta

Essa consulta projeta a propriedade eventName e a propriedade Year aninhada dentro da matriz promotionEvents.

db.stores.find({"promotionEvents.eventName": "Grand Bargain Gala"}, {"promotionEvents.eventName": true, "promotionEvents.promotionalDates.startDate.Year": true})

Um dos documentos retornados mostra os elementos de matriz especificados projetados na resposta.

{
    "_id": "d7fe6fb9-57e8-471a-b8d2-714e3579a415",
    "promotionEvents": [
        {
            "eventName": "Grand Bargain Gala",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024
                }
            }
        },
        {
            "eventName": "Grand Bargain Bash",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024
                }
            }
        },
        {
            "eventName": "Epic Bargain Bash",
            "promotionalDates": {
                "startDate": {
                    "Year": 2024
                }
            }
        }
    ]
}