proto_docs/google/firestore/admin/v1/index.rb in google-cloud-firestore-admin-v1-0.8.0 vs proto_docs/google/firestore/admin/v1/index.rb in google-cloud-firestore-admin-v1-0.9.0
- old
+ new
@@ -37,20 +37,23 @@
# 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.
+ # @!attribute [rw] api_scope
+ # @return [::Google::Cloud::Firestore::Admin::V1::Index::ApiScope]
+ # The API scope supported by this index.
# @!attribute [rw] fields
# @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>]
# The fields supported by this index.
#
- # For composite indexes, this is always 2 or more 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 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.
# @!attribute [rw] state
# @return [::Google::Cloud::Firestore::Admin::V1::Index::State]
@@ -113,9 +116,24 @@
# Indexes with a collection group query scope specified allow queries
# against all collections that has the collection id specified by the
# index.
COLLECTION_GROUP = 2
+
+ # Include all the collections's ancestor in the index. Only available for
+ # Datastore Mode databases.
+ COLLECTION_RECURSIVE = 3
+ end
+
+ # API Scope defines the APIs (Firestore Native, or Firestore in
+ # Datastore Mode) that are supported for queries.
+ module ApiScope
+ # The index can only be used by the Firestore Native query API.
+ # This is the default.
+ ANY_API = 0
+
+ # The index can only be used by the Firestore in Datastore Mode query API.
+ DATASTORE_MODE_API = 1
end
# The state of an index. During index creation, an index will be in the
# `CREATING` state. If the index is created successfully, it will transition
# to the `READY` state. If the index creation encounters a problem, the index