Index
FirestoreAdmin
(interface)CreateDatabaseRequest
(message)CreateIndexRequest
(message)Database
(message)Database.AppEngineIntegrationMode
(enum)Database.ConcurrencyMode
(enum)Database.DatabaseType
(enum)DeleteIndexRequest
(message)ExportDocumentsMetadata
(message)ExportDocumentsRequest
(message)ExportDocumentsResponse
(message)Field
(message)Field.IndexConfig
(message)Field.TtlConfig
(message)Field.TtlConfig.State
(enum)FieldOperationMetadata
(message)FieldOperationMetadata.IndexConfigDelta
(message)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)FieldOperationMetadata.TtlConfigDelta
(message)FieldOperationMetadata.TtlConfigDelta.ChangeType
(enum)GetDatabaseRequest
(message)GetFieldRequest
(message)GetIndexRequest
(message)ImportDocumentsMetadata
(message)ImportDocumentsRequest
(message)Index
(message)Index.IndexField
(message)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(message)ListDatabasesRequest
(message)ListDatabasesResponse
(message)ListFieldsRequest
(message)ListFieldsResponse
(message)ListIndexesRequest
(message)ListIndexesResponse
(message)LocationMetadata
(message)OperationState
(enum)Progress
(message)UpdateDatabaseMetadata
(message)UpdateDatabaseRequest
(message)UpdateFieldRequest
(message)
FirestoreAdmin
The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.
The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.
An Operation that is done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true
.
Operations are created by service FirestoreAdmin
, but are accessed via service google.longrunning.Operations
.
CreateDatabase |
---|
Create a database.
|
CreateIndex |
---|
Creates a composite index. This returns a
|
DeleteIndex |
---|
Deletes a composite index.
|
ExportDocuments |
---|
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
|
GetDatabase |
---|
Gets information about a database.
|
GetField |
---|
Gets the metadata and configuration for a Field.
|
GetIndex |
---|
Gets a composite index.
|
ImportDocuments |
---|
Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
|
ListDatabases |
---|
List all the databases in the project.
|
ListFields |
---|
Lists the field configuration and metadata for this database. Currently,
|
ListIndexes |
---|
Lists composite indexes.
|
UpdateDatabase |
---|
Updates a database.
|
UpdateField |
---|
Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to This call returns a To configure the default field settings for the database, use the special
|
CreateDatabaseRequest
The request for FirestoreAdmin.CreateDatabase
.
Fields | |
---|---|
parent |
Required. A parent name of the form |
database |
Required. The Database to create. |
database_id |
Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)". |
CreateIndexRequest
The request for FirestoreAdmin.CreateIndex
.
Fields | |
---|---|
parent |
Required. A parent name of the form |
index |
Required. The composite index to create. |
Database
A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a database_id
of '(default)'.
Fields | |
---|---|
name |
The resource name of the Database. Format: |
uid |
Output only. The system-generated UUID4 for this Database. |
create_time |
Output only. The timestamp at which this database was created. |
update_time |
Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. |
location_id |
The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations. |
type |
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. |
concurrency_mode |
The concurrency control mode to use for this database. |
app_engine_integration_mode |
The App Engine integration mode to use for this database. |
key_prefix |
Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id (" This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). |
etag |
This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
AppEngineIntegrationMode
The type of App Engine integration mode.
Enums | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
Not used. |
ENABLED |
If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database. |
DISABLED |
App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API. |
ConcurrencyMode
The type of concurrency control mode for transactions.
Enums | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
Not used. |
OPTIMISTIC |
Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases. |
PESSIMISTIC |
Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended. |
DatabaseType
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
Mode changes are only allowed if the database is empty.
Enums | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
The default value. This value is used if the database type is omitted. |
FIRESTORE_NATIVE |
Firestore Native Mode |
DATASTORE_MODE |
Firestore in Datastore Mode. |
DeleteIndexRequest
The request for FirestoreAdmin.DeleteIndex
.
Fields | |
---|---|
name |
Required. A name of the form |
ExportDocumentsMetadata
Metadata for google.longrunning.Operation
results from FirestoreAdmin.ExportDocuments
.
Fields | |
---|---|
start_time |
The time this operation started. |
end_time |
The time this operation completed. Will be unset if operation still in progress. |
operation_state |
The state of the export operation. |
progress_documents |
The progress, in documents, of this operation. |
progress_bytes |
The progress, in bytes, of this operation. |
collection_ids[] |
Which collection ids are being exported. |
output_uri_prefix |
Where the documents are being exported to. |
namespace_ids[] |
Which namespace ids are being exported. |
ExportDocumentsRequest
The request for FirestoreAdmin.ExportDocuments
.
Fields | |
---|---|
name |
Required. Database to export. Should be of the form: |
collection_ids[] |
Which collection ids to export. Unspecified means all collections. |
output_uri_prefix |
The output URI. Currently only supports Google Cloud Storage URIs of the form: |
namespace_ids[] |
An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. |
ExportDocumentsResponse
Returned in the google.longrunning.Operation
response field.
Fields | |
---|---|
output_uri_prefix |
Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully. |
Field
Represents a single field in the database.
Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
Fields | |
---|---|
name |
Required. A field name of the form A field path may be a simple field name, e.g. Field paths may be quoted using Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) A special |
index_config |
The index configuration for this field. If unset, field indexing will revert to the configuration defined by the |
ttl_config |
The TTL configuration for this |
IndexConfig
The index configuration for this field.
Fields | |
---|---|
indexes[] |
The indexes supported for this field. |
uses_ancestor_config |
Output only. When true, the |
ancestor_field |
Output only. Specifies the resource name of the |
reverting |
Output only When true, the |
TtlConfig
The TTL (time-to-live) configuration for documents that have this Field
set.
Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document.
Fields | |
---|---|
state |
Output only. The state of the TTL configuration. |
State
The state of applying the TTL configuration to all documents.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state is unspecified or unknown. |
CREATING |
The TTL is being applied. There is an active long-running operation to track the change. Newly written documents will have TTLs applied as requested. Requested TTLs on existing documents are still being processed. When TTLs on all existing documents have been processed, the state will move to 'ACTIVE'. |
ACTIVE |
The TTL is active for all documents. |
NEEDS_REPAIR |
The TTL configuration could not be enabled for all existing documents. Newly written documents will continue to have their TTL applied. The LRO returned when last attempting to enable TTL for this Field has failed, and may have more details. |
FieldOperationMetadata
Metadata for google.longrunning.Operation
results from FirestoreAdmin.UpdateField
.
Fields | |
---|---|
start_time |
The time this operation started. |
end_time |
The time this operation completed. Will be unset if operation still in progress. |
field |
The field resource that this operation is acting on. For example: |
index_config_deltas[] |
A list of |
state |
The state of the operation. |
progress_documents |
The progress, in documents, of this operation. |
progress_bytes |
The progress, in bytes, of this operation. |
ttl_config_delta |
Describes the deltas of TTL configuration. |
IndexConfigDelta
Information about an index configuration change.
Fields | |
---|---|
change_type |
Specifies how the index is changing. |
index |
The index being changed. |
ChangeType
Specifies how the index is changing.
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
The type of change is not specified or known. |
ADD |
The single field index is being added. |
REMOVE |
The single field index is being removed. |
TtlConfigDelta
Information about an TTL configuration change.
Fields | |
---|---|
change_type |
Specifies how the TTL configuration is changing. |
ChangeType
Specifies how the TTL config is changing.
Enums | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
The type of change is not specified or known. |
ADD |
The TTL config is being added. |
REMOVE |
The TTL config is being removed. |
GetDatabaseRequest
The request for FirestoreAdmin.GetDatabase
.
Fields | |
---|---|
name |
Required. A name of the form |
GetFieldRequest
The request for FirestoreAdmin.GetField
.
Fields | |
---|---|
name |
Required. A name of the form |
GetIndexRequest
The request for FirestoreAdmin.GetIndex
.
Fields | |
---|---|
name |
Required. A name of the form |
ImportDocumentsMetadata
Metadata for google.longrunning.Operation
results from FirestoreAdmin.ImportDocuments
.
Fields | |
---|---|
start_time |
The time this operation started. |
end_time |
The time this operation completed. Will be unset if operation still in progress. |
operation_state |
The state of the import operation. |
progress_documents |
The progress, in documents, of this operation. |
progress_bytes |
The progress, in bytes, of this operation. |
collection_ids[] |
Which collection ids are being imported. |
input_uri_prefix |
The location of the documents being imported. |
namespace_ids[] |
Which namespace ids are being imported. |
ImportDocumentsRequest
The request for FirestoreAdmin.ImportDocuments
.
Fields | |
---|---|
name |
Required. Database to import into. Should be of the form: |
collection_ids[] |
Which collection ids to import. Unspecified means all collections included in the import. |
input_uri_prefix |
Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: |
namespace_ids[] |
An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. |
Index
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Fields | |
---|---|
name |
Output only. A server defined name for this index. The form of this name for composite indexes will be: |
query_scope |
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. |
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 For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. |
state |
Output only. The serving state of the index. |
IndexField
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Fields | |
---|---|
field_path |
Can be name. For single field indexes, this must match the name of the field or may be omitted. |
Union field value_mode . How the field value is indexed. value_mode can be only one of the following: |
|
order |
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. |
array_config |
Indicates that this field supports operations on |
ArrayConfig
The supported array value configurations.
Enums | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
The index does not support additional array queries. |
CONTAINS |
The index supports array containment queries. |
Order
The supported orderings.
Enums | |
---|---|
ORDER_UNSPECIFIED |
The ordering is unspecified. Not a valid option. |
ASCENDING |
The field is ordered by ascending field value. |
DESCENDING |
The field is ordered by descending field value. |
QueryScope
Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from
field.
Enums | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
The query scope is unspecified. Not a valid option. |
COLLECTION |
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 collection id specified by the index. |
COLLECTION_GROUP |
Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index. |
State
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 will transition to the NEEDS_REPAIR
state.
Enums | |
---|---|
STATE_UNSPECIFIED |
The state is unspecified. |
CREATING |
The index is being created. There is an active long-running operation for the index. The index is updated when writing a document. Some index data may exist. |
READY |
The index is ready to be used. The index is updated when writing a document. The index is fully populated from all stored documents it applies to. |
NEEDS_REPAIR |
The index was being created, but something went wrong. There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing a document. Some index data may exist. Use the google.longrunning.Operations API to determine why the operation that last attempted to create this index failed, then re-create the index. |
IndexOperationMetadata
Metadata for google.longrunning.Operation
results from FirestoreAdmin.CreateIndex
.
Fields | |
---|---|
start_time |
The time this operation started. |
end_time |
The time this operation completed. Will be unset if operation still in progress. |
index |
The index resource that this operation is acting on. For example: |
state |
The state of the operation. |
progress_documents |
The progress, in documents, of this operation. |
progress_bytes |
The progress, in bytes, of this operation. |
ListDatabasesRequest
A request to list the Firestore Databases in all locations for a project.
Fields | |
---|---|
parent |
Required. A parent name of the form |
ListDatabasesResponse
The list of databases for a project.
Fields | |
---|---|
databases[] |
The databases in the project. |
ListFieldsRequest
The request for FirestoreAdmin.ListFields
.
Fields | |
---|---|
parent |
Required. A parent name of the form |
filter |
The filter to apply to list results. Currently, |
page_size |
The number of results to return. |
page_token |
A page token, returned from a previous call to |
ListFieldsResponse
The response for FirestoreAdmin.ListFields
.
Fields | |
---|---|
fields[] |
The requested fields. |
next_page_token |
A page token that may be used to request another page of results. If blank, this is the last page. |
ListIndexesRequest
The request for FirestoreAdmin.ListIndexes
.
Fields | |
---|---|
parent |
Required. A parent name of the form |
filter |
The filter to apply to list results. |
page_size |
The number of results to return. |
page_token |
A page token, returned from a previous call to |
ListIndexesResponse
The response for FirestoreAdmin.ListIndexes
.
Fields | |
---|---|
indexes[] |
The requested indexes. |
next_page_token |
A page token that may be used to request another page of results. If blank, this is the last page. |
LocationMetadata
The metadata message for google.cloud.location.Location.metadata
.
OperationState
Describes the state of the operation.
Enums | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Unspecified. |
INITIALIZING |
Request is being prepared for processing. |
PROCESSING |
Request is actively being processed. |
CANCELLING |
Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation. |
FINALIZING |
Request has been processed and is in its finalization stage. |
SUCCESSFUL |
Request has completed successfully. |
FAILED |
Request has finished being processed, but encountered an error. |
CANCELLED |
Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation. |
Progress
Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress
is used.
Fields | |
---|---|
estimated_work |
The amount of work estimated. |
completed_work |
The amount of work completed. |
UpdateDatabaseMetadata
Metadata related to the update database operation.
UpdateDatabaseRequest
The request for FirestoreAdmin.UpdateDatabase
.
Fields | |
---|---|
database |
Required. The database to update. |
update_mask |
The list of fields to be updated. |
UpdateFieldRequest
The request for FirestoreAdmin.UpdateField
.
Fields | |
---|---|
field |
Required. The field to be updated. |
update_mask |
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. |