FirestoreDatabase
| Property | Value |
|---|---|
| Google Cloud Service Name | Firestore |
| Google Cloud Service Documentation | /firestore/docs/ |
| Google Cloud REST Resource Name | v1.projects.databases |
| Google Cloud REST Resource Documentation | /firestore/docs/reference/rest/v1/projects.databases |
| Config Connector Resource Short Names | firestoredatabase |
| Config Connector Service Name | firestore.googleapis.com |
| Config Connector Resource Fully Qualified Name | firestoredatabases.firestore.cnrm.cloud.google.com |
| Can Be Referenced by IAMPolicy/IAMPolicyMember | No |
| Config Connector Default Average Reconcile Interval In Seconds | 600 |
Custom Resource Definition Properties
Spec
Schema
concurrencyMode: string
locationID: string
pointInTimeRecoveryEnablement: string
projectRef:
external: string
kind: string
name: string
namespace: string
resourceID: string
| Fields | |
|---|---|
|
Optional |
The concurrency control mode to use for this database. See https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases#concurrencymode for more info. |
|
Optional |
The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. |
|
Optional |
Whether to enable the PITR feature on this database. See https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases#pointintimerecoveryenablement for more info. |
|
Required* |
Immutable. The Project that this resource belongs to. |
|
Optional |
The `projectID` field of a project, when not managed by Config Connector. |
|
Optional |
The kind of the Project resource; optional but must be `Project` if provided. |
|
Optional |
The `name` field of a `Project` resource. |
|
Optional |
The `namespace` field of a `Project` resource. |
|
Optional |
The FirestoreDatabase name. If not given, the metadata.name will be used. |
* Field is required when parent field is specified
Status
Schema
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
externalRef: string
observedGeneration: integer
observedState:
createTime: string
earliestVersionTime: string
etag: string
keyPrefix: string
uid: string
updateTime: string
versionRetentionPeriod: string
| Fields | |
|---|---|
conditions |
Conditions represent the latest available observations of the object's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
externalRef |
A unique specifier for the FirestoreDatabase resource in GCP. |
observedGeneration |
ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. |
observedState |
ObservedState is the state of the resource as most recently observed in GCP. |
observedState.createTime |
Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. |
observedState.earliestVersionTime |
Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. |
observedState.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. |
observedState.keyPrefix |
Output only. The key_prefix for this database. This key_prefix is used, in
combination with the project id (" |
observedState.uid |
Output only. The system-generated UUID4 for this Database. |
observedState.updateTime |
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. |
observedState.versionRetentionPeriod |
Output only. The period during which past versions of data are retained in the database. Any [read][google.firestore.v1.GetDocumentRequest.read_time] or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. |
Sample YAML(s)
Basic FirestoreDatabase
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion: firestore.cnrm.cloud.google.com/v1beta1
kind: FirestoreDatabase
metadata:
name: firestoredatabase-sample
spec:
projectRef:
external: ${PROJECT_NUMBER1}
locationID: us-west2
concurrencyMode: OPTIMISTIC
pointInTimeRecoveryEnablement: POINT_IN_TIME_RECOVERY_ENABLED