documents_collection_ids
Creates, updates, deletes, gets or lists a documents_collection_ids
resource.
Overview
Name | documents_collection_ids |
Type | Resource |
Id | google.firestore.documents_collection_ids |
Fields
The following fields are returned by SELECT
queries:
- list_collection_ids
Successful response
Name | Datatype | Description |
---|---|---|
collectionIds | array | The collection ids. |
nextPageToken | string | A page token that may be used to continue the list. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list_collection_ids | select | projectsId , databasesId , documentsId , documentsId1 | Lists all the collection IDs underneath a document. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
databasesId | string | |
documentsId | string | |
documentsId1 | string | |
projectsId | string |
SELECT
examples
- list_collection_ids
Lists all the collection IDs underneath a document.
SELECT
collectionIds,
nextPageToken
FROM google.firestore.documents_collection_ids
WHERE projectsId = '{{ projectsId }}' -- required
AND databasesId = '{{ databasesId }}' -- required
AND documentsId = '{{ documentsId }}' -- required
AND documentsId1 = '{{ documentsId1 }}' -- required;