REST Resource: projects.databases

संसाधन: डेटाबेस

Cloud Firestore डेटाबेस.

JSON के काेड में दिखाना 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "cmekConfig": {
    object (CmekConfig)
  },
  "etag": string
}
फ़ील्ड
name

string

डेटाबेस के संसाधन का नाम. फ़ॉर्मैट: projects/{project}/databases/{database}
uid

string

सिर्फ़ आउटपुट के लिए. इस डेटाबेस के लिए सिस्टम से जनरेट किया गया UUID4.
createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जिस पर इस डेटाबेस को बनाया गया था. साल 2016 से पहले बनाए गए डेटाबेस, createTime को पॉप्युलेट नहीं करते हैं.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब इस डेटाबेस को हाल ही में अपडेट किया गया था. ध्यान दें कि इसमें सिर्फ़ डेटाबेस संसाधन के अपडेट शामिल हैं, न कि डेटाबेस में शामिल डेटा के.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
locationId

string

डेटाबेस की लोकेशन. जिन जगहों पर यह सुविधा उपलब्ध है उनकी सूची https://cloud.google.com/firestore/docs/locations पर दी गई है.
type

enum (DatabaseType)

डेटाबेस का टाइप. चुनने का तरीका जानने के लिए, https://cloud.google.com/datastore/docs/firestore-or-datastore पर जाएं.
concurrencyMode

enum (ConcurrencyMode)

इस डेटाबेस के लिए, एक साथ काम करने वाला कंट्रोल मोड का इस्तेमाल किया जाता है.
versionRetentionPeriod

string (Duration format)

सिर्फ़ आउटपुट के लिए. वह अवधि जिसके दौरान डेटा के पिछले वर्शन, डेटाबेस में बनाए रखे जाते हैं.

इस विंडो में कोई भी read या query readTime के बारे में बता सकता है और उस समय डेटाबेस की स्थिति की जानकारी देगा.

अगर पीआईटीआर की सुविधा चालू है, तो डेटा के रखरखाव की समयसीमा सात दिनों की होती है. अगर ऐसा नहीं है, तो डेटा का रखरखाव एक घंटे तक किया जाएगा.

सेकंड में दी गई अवधि, जिसमें नौ भिन्नांक हो सकते हैं. साथ ही, यह 's' पर खत्म होता है. उदाहरण: "3.5s".
earliestVersionTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह शुरुआती टाइमस्टैंप जब डेटा के पुराने वर्शन को डेटाबेस से पढ़ा जा सकता है. ऊपर [versionLocationPeriod] देखें. इस फ़ील्ड में now - versionRetentionPeriod जानकारी अपने-आप भर जाती है.

यह वैल्यू लगातार अपडेट होती रहती है और क्वेरी करते ही पुरानी हो जाती है. अगर डेटा को वापस पाने के लिए इस वैल्यू का इस्तेमाल किया जा रहा है, तो वैल्यू के लिए क्वेरी किए जाने के समय से लेकर डेटा वापस पाने की प्रक्रिया शुरू होने तक का समय ध्यान में रखें.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

इस डेटाबेस पर PITR की सुविधा चालू करनी है या नहीं.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

इस डेटाबेस के लिए App Engine इंटिग्रेशन मोड.
keyPrefix

string

सिर्फ़ आउटपुट के लिए. इस डेटाबेस के लिए मुख्य प्रीफ़िक्स. इस keyPreFix का इस्तेमाल प्रोजेक्ट आईडी ("~") के साथ मिलकर, ऐप्लिकेशन आईडी बनाने के लिए किया जाता है. यह आईडी, Google App Engine की पहली जनरेशन के रनटाइम में Cloud Datastore API से मिलता है.

इस मामले में, यह वैल्यू खाली हो सकती है. इस स्थिति में, यूआरएल-एन्कोडेड कुंजी के लिए इस्तेमाल किया जाने वाला appid, projectId है. उदाहरण के लिए, v~foo के बजाय foo.
deleteProtectionState

enum (DeleteProtectionState)

डेटाबेस के लिए डेटा मिटाने से जुड़ी सुरक्षा की स्थिति.
cmekConfig

object (CmekConfig)

ज़रूरी नहीं. मौजूदगी से पता चलता है कि इस डेटाबेस के लिए सीएमईके चालू है.
etag

string

इस चेकसम का हिसाब, अन्य फ़ील्ड की वैल्यू के आधार पर सर्वर करता है. इसे अपडेट करने और मिटाने के अनुरोध पर भेजा जा सकता है. इससे यह पक्का होता है कि आगे बढ़ने से पहले, क्लाइंट के पास अप-टू-डेट वैल्यू है.

डेटाबेस प्रकार

डेटाबेस का टाइप. चुनने का तरीका जानने के लिए, https://cloud.google.com/datastore/docs/firestore-or-datastore पर जाएं.

मोड में बदलाव सिर्फ़ तब किए जा सकते हैं, जब डेटाबेस खाली हो.

एनम्स
DATABASE_TYPE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. इस वैल्यू का इस्तेमाल तब किया जाता है, जब डेटाबेस का टाइप शामिल नहीं किया जाता है.
FIRESTORE_NATIVE Firestore नेटिव मोड
DATASTORE_MODE डेटास्टोर मोड में Firestore.

ConcurrencyMode

लेन-देन के लिए, एक साथ कई काम करने के कंट्रोल मोड का टाइप.

एनम्स
CONCURRENCY_MODE_UNSPECIFIED इस्तेमाल नहीं किया गया.
OPTIMISTIC डिफ़ॉल्ट रूप से, आशावादी एक साथ कई काम करने के तरीके को कंट्रोल करने वाली सुविधा का इस्तेमाल करें. यह मोड, Cloud Firestore डेटाबेस के लिए उपलब्ध है.
PESSIMISTIC

डिफ़ॉल्ट रूप से, निराशावादी कॉन्करंसी कंट्रोल का इस्तेमाल करें. यह मोड, Cloud Firestore डेटाबेस के लिए उपलब्ध है.

यह Cloud Firestore के लिए डिफ़ॉल्ट सेटिंग है.
OPTIMISTIC_WITH_ENTITY_GROUPS

डिफ़ॉल्ट रूप से, इकाई ग्रुप के साथ ऑप्टिमिस्टिक कंकरंसी कंट्रोल का इस्तेमाल करें.

Cloud Datastore के लिए सिर्फ़ यही मोड उपलब्ध है.

यह मोड, डेटास्टोर मोड वाले Cloud Firestore के लिए भी उपलब्ध है. हालांकि, इसका सुझाव नहीं दिया जाता.

PointInTimeRecoveryEnabledment

पॉइंट इन टाइम रिकवरी की सुविधा को चालू करना.

एनम्स
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED इस्तेमाल नहीं किया गया.
POINT_IN_TIME_RECOVERY_ENABLED

पिछले सात दिनों के डेटा के चुनिंदा वर्शन पर रीड की सुविधा काम करती है:

  • पिछले घंटे के किसी भी टाइमस्टैंप के हिसाब से पढ़ता है
  • एक घंटे के स्नैपशॉट के आधार पर, एक घंटे के अंदर और सात दिन में पढ़ता है

कौनसे वर्शन काम करते हैं, यह तय करने के लिए versionRetentionPeriod और earliestVersionTime का इस्तेमाल किया जा सकता है.
POINT_IN_TIME_RECOVERY_DISABLED पिछले एक घंटे के डेटा के किसी भी वर्शन पर रीड की सुविधा मौजूद है.

App घटनाओं के नमूने के तौर पर,

App Engine इंटिग्रेशन मोड का टाइप.

एनम्स
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED इस्तेमाल नहीं किया गया.
ENABLED अगर App Engine का ऐप्लिकेशन उसी क्षेत्र में है जिसमें यह डेटाबेस है, तो App Engine कॉन्फ़िगरेशन इस डेटाबेस पर असर डालेगा. इसमें ऐप्लिकेशन और डेटाबेस को बंद करने के साथ-साथ, डेटाबेस में लिखने की सुविधा को बंद करना भी शामिल है.
DISABLED

अनुरोध को पूरा करने के लिए, इस डेटाबेस की क्षमता पर App Engine का कोई असर नहीं पड़ता.

यह Firestore API की मदद से बनाए गए डेटाबेस के लिए डिफ़ॉल्ट सेटिंग है.

DeleteProtectionState

डेटाबेस की सुरक्षा को मिटाने की स्थिति.

एनम्स
DELETE_PROTECTION_STATE_UNSPECIFIED डिफ़ॉल्ट वैल्यू. सुरक्षा के किस टाइप को मिटाया जाएगा, इसकी जानकारी नहीं दी गई
DELETE_PROTECTION_DISABLED सुरक्षा मिटाने की सुविधा बंद है
DELETE_PROTECTION_ENABLED सुरक्षा मिटाने की सुविधा चालू है

CmekConfig

Firestore डेटाबेस के लिए CMEK (ग्राहक की ओर से मैनेज की जाने वाली एन्क्रिप्ट (सुरक्षित) करने की कुंजी) कॉन्फ़िगरेशन. अगर यह मौजूद नहीं है, तो डेटाबेस को डिफ़ॉल्ट Google एन्क्रिप्शन कुंजी से सुरक्षित किया जाता है.

JSON के काेड में दिखाना 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
फ़ील्ड
kmsKeyName

string

ज़रूरी है. डेटा एन्क्रिप्ट (सुरक्षित) करने के लिए, सिर्फ़ उन कुंजियों का इस्तेमाल किया जा सकता है जो इस डेटाबेस की जगह पर हैं.

Firestore के नाम5 एक से ज़्यादा इलाके के लिए, यह हमें क्लाउड केएमएस (एक से ज़्यादा इलाकों वाले) के हिसाब से तय करता है. Firestore के यूरो3 वाले कई इलाकों के लिए, यह क्लाउड केएमएस मल्टी-रीजनल यूरोप के बराबर है. https://cloud.google.com/kms/docs/locations पर जाएं.

सही फ़ॉर्मैट projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} है.
activeKeyVersion[]

string

सिर्फ़ आउटपुट के लिए. फ़िलहाल, KMS के मुख्य वर्शन इस्तेमाल किए जा रहे हैं. डेटा सुरक्षित करने वाली कुंजी का नया वर्शन बनाने के दौरान, इस्तेमाल किए जाने वाले कई कुंजी वर्शन हो सकते हैं.

सही फ़ॉर्मैट projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} है.

तरीके

create

 डेटाबेस बनाएं.

delete

 डेटाबेस को मिटाता है.

exportDocuments

 Google Cloud Firestore से सभी या उनके सबसेट की कॉपी को Google Cloud Storage जैसे किसी दूसरे स्टोरेज सिस्टम में एक्सपोर्ट करता है.

get

 डेटाबेस के बारे में जानकारी मिलती है.

importDocuments

 Google Cloud Firestore में दस्तावेज़ इंपोर्ट करता है.

list

 प्रोजेक्ट के सभी डेटाबेस की सूची बनाएं.

patch

 डेटाबेस को अपडेट करता है.

restore

 मौजूदा बैकअप से डेटा वापस करके नया डेटाबेस बनाता है.