Method: googleapis.firestore.v1.projects.databases.documents.list

Lists documents.

Arguments

Parameters
collectionId

string

Required. The collection ID, relative to parent, to list. For example: chatrooms or messages.
parent

string

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
mask.fieldPaths

string

The list of field paths in the mask. See Document.fields for a field path syntax reference.
orderBy

string

The order to sort results by. For example: priority desc, name.
pageSize

integer (int32 format)

The maximum number of documents to return.
pageToken

string

The next_page_token value returned from a previous List request, if any.
readTime

string (Timestamp format)

Reads documents as they were at the given time. This may not be older than 270 seconds.
showMissing

boolean

If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with show_missing may not specify where or order_by.
transaction

string (bytes format)

Reads documents in a transaction.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of ListDocumentsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- list:
    call: googleapis.firestore.v1.projects.databases.documents.list
    args:
        collectionId: ...
        parent: ...
        mask:
            fieldPaths: ...
        orderBy: ...
        pageSize: ...
        pageToken: ...
        readTime: ...
        showMissing: ...
        transaction: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.firestore.v1.projects.databases.documents.list",
      "args": {
        "collectionId": "...",
        "parent": "...",
        "mask": {
          "fieldPaths": "..."
        },
        "orderBy": "...",
        "pageSize": "...",
        "pageToken": "...",
        "readTime": "...",
        "showMissing": "...",
        "transaction": "..."
      },
      "result": "listResult"
    }
  }
]