REST Resource: projects.databases

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

Cloud Firestore डेटाबेस.

JSON के काेड में दिखाना 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": 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)
  },
  "previousId": string,
  "etag": string
}
फ़ील्ड
name

string

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

string

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

string (Timestamp format)

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

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

string (Timestamp format)

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

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

string (Timestamp format)

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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 से अपने-आप जानकारी भरी गई है.

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

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

enum (PointInTimeRecoveryEnablement)

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

enum (AppEngineIntegrationMode)

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

string

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

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

enum (DeleteProtectionState)

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

object (CmekConfig)

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

string

सिर्फ़ आउटपुट के लिए. डेटाबेस संसाधन का पिछला डेटाबेस आईडी. यह फ़ील्ड सिर्फ़ मिटाए गए डेटाबेस के लिए भरा जाता है.
etag

string

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

डेटाबेस टाइप

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

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

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

कॉनcurrencyमोड

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

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

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

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

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

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

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

PointInTimeRecoveryEnabled

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

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

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

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

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

AppEngineइंटिग्रेशन मोड

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

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

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

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

DeleteProtectionState

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

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

सीमेकेफ़िग

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

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

string

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

Firestore के nam5 एक से ज़्यादा क्षेत्र के लिए, यह अमेरिका के क्लाउड केएमएस मल्टी-क्षेत्र है. Firestore के eur3 मल्टी-रीजन के लिए, यह यूरोप के क्लाउड केएमएस (कई क्षेत्रों वाला इलाका) से मेल खाता है. 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

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