You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html
+6
Original file line number
Diff line number
Diff line change
@@ -115,6 +115,7 @@ <h3>Method Details</h3>
115
115
"indexes": [ # The indexes supported for this field.
116
116
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
117
117
"apiScope": "A String", # The API scope supported by this index.
118
+
"density": "A String", # Immutable. The density configuration of the index.
118
119
"fields": [ # The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
119
120
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
120
121
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -127,6 +128,7 @@ <h3>Method Details</h3>
127
128
},
128
129
},
129
130
],
131
+
"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
130
132
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
131
133
"queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.
132
134
"state": "A String", # Output only. The serving state of the index.
@@ -167,6 +169,7 @@ <h3>Method Details</h3>
167
169
"indexes": [ # The indexes supported for this field.
168
170
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
169
171
"apiScope": "A String", # The API scope supported by this index.
172
+
"density": "A String", # Immutable. The density configuration of the index.
170
173
"fields": [ # The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
171
174
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
172
175
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -179,6 +182,7 @@ <h3>Method Details</h3>
179
182
},
180
183
},
181
184
],
185
+
"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
182
186
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
183
187
"queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.
184
188
"state": "A String", # Output only. The serving state of the index.
@@ -226,6 +230,7 @@ <h3>Method Details</h3>
226
230
"indexes": [ # The indexes supported for this field.
227
231
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
228
232
"apiScope": "A String", # The API scope supported by this index.
233
+
"density": "A String", # Immutable. The density configuration of the index.
229
234
"fields": [ # The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
230
235
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
231
236
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -238,6 +243,7 @@ <h3>Method Details</h3>
238
243
},
239
244
},
240
245
],
246
+
"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
241
247
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
242
248
"queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.
243
249
"state": "A String", # Output only. The serving state of the index.
Copy file name to clipboardExpand all lines: docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html
+6
Original file line number
Diff line number
Diff line change
@@ -109,6 +109,7 @@ <h3>Method Details</h3>
109
109
110
110
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
111
111
"apiScope": "A String", # The API scope supported by this index.
112
+
"density": "A String", # Immutable. The density configuration of the index.
112
113
"fields": [ # The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
113
114
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
114
115
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -121,6 +122,7 @@ <h3>Method Details</h3>
121
122
},
122
123
},
123
124
],
125
+
"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
124
126
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
125
127
"queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.
126
128
"state": "A String", # Output only. The serving state of the index.
@@ -189,6 +191,7 @@ <h3>Method Details</h3>
189
191
190
192
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
191
193
"apiScope": "A String", # The API scope supported by this index.
194
+
"density": "A String", # Immutable. The density configuration of the index.
192
195
"fields": [ # The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
193
196
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
194
197
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -201,6 +204,7 @@ <h3>Method Details</h3>
201
204
},
202
205
},
203
206
],
207
+
"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
204
208
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
205
209
"queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.
206
210
"state": "A String", # Output only. The serving state of the index.
@@ -228,6 +232,7 @@ <h3>Method Details</h3>
228
232
"indexes": [ # The requested indexes.
229
233
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
230
234
"apiScope": "A String", # The API scope supported by this index.
235
+
"density": "A String", # Immutable. The density configuration of the index.
231
236
"fields": [ # The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
232
237
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
233
238
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -240,6 +245,7 @@ <h3>Method Details</h3>
240
245
},
241
246
},
242
247
],
248
+
"multikey": True or False, # Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.
243
249
"name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.
244
250
"queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.
245
251
"state": "A String", # Output only. The serving state of the index.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/firestore.v1.json
+25-3
Original file line number
Diff line number
Diff line change
@@ -1711,7 +1711,7 @@
1711
1711
}
1712
1712
}
1713
1713
},
1714
-
"revision": "20241204",
1714
+
"revision": "20250120",
1715
1715
"rootUrl": "https://firestore.googleapis.com/",
1716
1716
"schemas": {
1717
1717
"Aggregation": {
@@ -3150,11 +3150,29 @@
3150
3150
"description": "The API scope supported by this index.",
3151
3151
"enum": [
3152
3152
"ANY_API",
3153
-
"DATASTORE_MODE_API"
3153
+
"DATASTORE_MODE_API",
3154
+
"IGNITE_API"
3154
3155
],
3155
3156
"enumDescriptions": [
3156
3157
"The index can only be used by the Firestore Native query API. This is the default.",
3157
-
"The index can only be used by the Firestore in Datastore Mode query API."
3158
+
"The index can only be used by the Firestore in Datastore Mode query API.",
3159
+
"The index can only be used by Ignite."
3160
+
],
3161
+
"type": "string"
3162
+
},
3163
+
"density": {
3164
+
"description": "Immutable. The density configuration of the index.",
3165
+
"enum": [
3166
+
"DENSITY_UNSPECIFIED",
3167
+
"SPARSE_ALL",
3168
+
"SPARSE_ANY",
3169
+
"DENSE"
3170
+
],
3171
+
"enumDescriptions": [
3172
+
"Unspecified. It will use database default setting. This value is input only.",
3173
+
"In order for an index entry to be added, the document must contain all fields specified in the index. This is the only allowed value for indexes having ApiScope `ANY_API` and `DATASTORE_MODE_API`.",
3174
+
"In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.",
3175
+
"An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries."
3158
3176
],
3159
3177
"type": "string"
3160
3178
},
@@ -3165,6 +3183,10 @@
3165
3183
},
3166
3184
"type": "array"
3167
3185
},
3186
+
"multikey": {
3187
+
"description": "Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to index with IGNITE_API ApiScope.",
3188
+
"type": "boolean"
3189
+
},
3168
3190
"name": {
3169
3191
"description": "Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty.",
0 commit comments