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
+9
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,8 +128,10 @@ <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 MONGODB_COMPATIBLE_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.
134
+
"shardCount": 42, # Optional. The number of shards for the index.
132
135
"state": "A String", # Output only. The serving state of the index.
133
136
},
134
137
],
@@ -167,6 +170,7 @@ <h3>Method Details</h3>
167
170
"indexes": [ # The indexes supported for this field.
168
171
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
169
172
"apiScope": "A String", # The API scope supported by this index.
173
+
"density": "A String", # Immutable. The density configuration of the index.
170
174
"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
175
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
172
176
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -179,8 +183,10 @@ <h3>Method Details</h3>
179
183
},
180
184
},
181
185
],
186
+
"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 MONGODB_COMPATIBLE_API ApiScope.
182
187
"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
188
"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.
189
+
"shardCount": 42, # Optional. The number of shards for the index.
184
190
"state": "A String", # Output only. The serving state of the index.
185
191
},
186
192
],
@@ -226,6 +232,7 @@ <h3>Method Details</h3>
226
232
"indexes": [ # The indexes supported for this field.
227
233
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
228
234
"apiScope": "A String", # The API scope supported by this index.
235
+
"density": "A String", # Immutable. The density configuration of the index.
229
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.
230
237
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
231
238
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -238,8 +245,10 @@ <h3>Method Details</h3>
238
245
},
239
246
},
240
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 MONGODB_COMPATIBLE_API ApiScope.
241
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.
242
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.
251
+
"shardCount": 42, # Optional. The number of shards for the index.
243
252
"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
+9
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,8 +122,10 @@ <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 MONGODB_COMPATIBLE_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.
128
+
"shardCount": 42, # Optional. The number of shards for the index.
126
129
"state": "A String", # Output only. The serving state of the index.
127
130
}
128
131
@@ -189,6 +192,7 @@ <h3>Method Details</h3>
189
192
190
193
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
191
194
"apiScope": "A String", # The API scope supported by this index.
195
+
"density": "A String", # Immutable. The density configuration of the index.
192
196
"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
197
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
194
198
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -201,8 +205,10 @@ <h3>Method Details</h3>
201
205
},
202
206
},
203
207
],
208
+
"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 MONGODB_COMPATIBLE_API ApiScope.
204
209
"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
210
"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.
211
+
"shardCount": 42, # Optional. The number of shards for the index.
206
212
"state": "A String", # Output only. The serving state of the index.
207
213
}</pre>
208
214
</div>
@@ -228,6 +234,7 @@ <h3>Method Details</h3>
228
234
"indexes": [ # The requested indexes.
229
235
{ # Cloud Firestore indexes enable simple and complex queries against documents in a database.
230
236
"apiScope": "A String", # The API scope supported by this index.
237
+
"density": "A String", # Immutable. The density configuration of the index.
231
238
"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
239
{ # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
233
240
"arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s.
@@ -240,8 +247,10 @@ <h3>Method Details</h3>
240
247
},
241
248
},
242
249
],
250
+
"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 MONGODB_COMPATIBLE_API ApiScope.
243
251
"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
252
"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.
253
+
"shardCount": 42, # Optional. The number of shards for the index.
245
254
"state": "A String", # Output only. The serving state of the index.
0 commit comments