Get Indexe
firestore.get_indexe
ActionDatabases & warehousesconnection required
Calls firestore v1 GET /v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/indexes/{indexesId}.
Gets a composite index.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Firestore
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
database Database name or id. | string | Yes | — | — | — |
collection_group Collection group name or id. | string | Yes | — | — | — |
indexe Indexe name or id. | string | Yes | — | — | — |
Output
One shape.
result
Extra keys beyond the ones listed can appear.
| Field | Type | Example |
|---|---|---|
apiScope | string | — |
density | string | — |
fields | array | — |
multikey | boolean | — |
name | string | — |
queryScope | string | — |
searchIndexOptions | object | — |
shardCount | integer | — |
state | string | — |
unique | boolean | — |
{
"apiScope": "",
"density": "",
"fields": [],
"multikey": false,
"name": "",
"queryScope": "",
"searchIndexOptions": {},
"shardCount": 0,
"state": "",
"unique": false
}See Get Indexe run in a workflow.
In a technical demo we add the Google Firestore connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.