Skip to main content

documents_collection_ids

Creates, updates, deletes, gets or lists a documents_collection_ids resource.

Overview

Namedocuments_collection_ids
TypeResource
Idgoogle.firestore.documents_collection_ids

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
collectionIdsarrayThe collection ids.
nextPageTokenstringA page token that may be used to continue the list.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_collection_idsselectprojectsId, databasesId, documentsId, documentsId1Lists 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.

NameDatatypeDescription
databasesIdstring
documentsIdstring
documentsId1string
projectsIdstring

SELECT examples

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;