Package google.firestore.admin.v1beta2

সূচক

ফায়ারস্টোর অ্যাডমিন

অপারেশনগুলি FirestoreAdmin পরিষেবা দ্বারা তৈরি করা হয়, কিন্তু পরিষেবা google.longrunning.Operations মাধ্যমে অ্যাক্সেস করা হয়৷

সূচক তৈরি করুন

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

একটি যৌগিক সূচক তৈরি করে। এটি একটি google.longrunning.Operation প্রদান করে যা সৃষ্টির স্থিতি ট্র্যাক করতে ব্যবহার করা যেতে পারে। অপারেশনের জন্য মেটাডেটা হবে IndexOperationMetadata টাইপ।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

ডিলিট ইনডেক্স

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

একটি যৌগিক সূচক মুছে দেয়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

নথিপত্র রপ্তানি করুন

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Google ক্লাউড ফায়ারস্টোর থেকে অন্য স্টোরেজ সিস্টেমে, যেমন Google ক্লাউড স্টোরেজ থেকে সমস্ত নথির একটি অনুলিপি বা একটি উপসেট রপ্তানি করে৷ নথির সাম্প্রতিক আপডেটগুলি রপ্তানিতে প্রতিফলিত নাও হতে পারে৷ রপ্তানিটি ব্যাকগ্রাউন্ডে ঘটে এবং এর অগ্রগতি তৈরি করা অপারেশন রিসোর্সের মাধ্যমে পর্যবেক্ষণ ও পরিচালনা করা যেতে পারে। একটি রপ্তানির আউটপুট শুধুমাত্র একবার সংশ্লিষ্ট অপারেশন সম্পন্ন হলে ব্যবহার করা যেতে পারে। যদি একটি রপ্তানি অপারেশন সম্পূর্ণ হওয়ার আগে বাতিল করা হয় তবে এটি Google ক্লাউড স্টোরেজে আংশিক ডেটা রেখে যেতে পারে।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

গেটফিল্ড

rpc GetField( GetFieldRequest ) returns ( Field )

একটি ক্ষেত্রের জন্য মেটাডেটা এবং কনফিগারেশন পায়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

GetIndex

rpc GetIndex( GetIndexRequest ) returns ( Index )

একটি যৌগিক সূচক পায়।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

নথিপত্র আমদানি করুন

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Google ক্লাউড ফায়ারস্টোরে নথি আমদানি করে। একই নামের বিদ্যমান নথিগুলি ওভাররাইট করা হয়েছে৷ আমদানিটি পটভূমিতে ঘটে এবং এর অগ্রগতি তৈরি করা অপারেশন রিসোর্সের মাধ্যমে নিরীক্ষণ ও পরিচালনা করা যেতে পারে। যদি একটি ImportDocuments অপারেশন বাতিল করা হয়, তাহলে এটি সম্ভব যে ডেটার একটি উপসেট ইতিমধ্যেই Cloud Firestore-এ আমদানি করা হয়েছে৷

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

তালিকাক্ষেত্র

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

এই ডাটাবেসের জন্য ক্ষেত্র কনফিগারেশন এবং মেটাডেটা তালিকাভুক্ত করে।

বর্তমানে, FirestoreAdmin.ListFields শুধুমাত্র তালিকার ক্ষেত্রগুলিকে সমর্থন করে যেগুলি স্পষ্টভাবে ওভাররাইড করা হয়েছে৷ এই ক্যোয়ারী ইস্যু করতে, indexConfig.usesAncestorConfig:false এ ফিল্টার সেট সহ FirestoreAdmin.ListFields এ কল করুন।

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

তালিকা ইনডেক্স

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

যৌগিক সূচী তালিকা.

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

আপডেট ফিল্ড

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

একটি ক্ষেত্র কনফিগারেশন আপডেট করে। বর্তমানে, ফিল্ড আপডেট শুধুমাত্র একক ক্ষেত্র সূচক কনফিগারেশনে প্রযোজ্য। যাইহোক, FirestoreAdmin.UpdateField এ কল করার জন্য একটি ফিল্ড মাস্ক প্রদান করা উচিত যাতে কলকারী জানেন না এমন কোনও কনফিগারেশন পরিবর্তন করা এড়াতে। ফিল্ড মাস্কটি এইভাবে নির্দিষ্ট করা উচিত: { paths: "index_config" }

এই কলটি একটি google.longrunning.Operation প্রদান করে যা ফিল্ড আপডেটের স্থিতি ট্র্যাক করতে ব্যবহার করা যেতে পারে। অপারেশনের জন্য মেটাডেটা হবে FieldOperationMetadata টাইপ।

ডাটাবেসের জন্য ডিফল্ট ক্ষেত্র সেটিংস কনফিগার করতে, সম্পদের নাম সহ বিশেষ Field ব্যবহার করুন: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*

অনুমোদনের সুযোগ

নিম্নলিখিত OAuth সুযোগগুলির মধ্যে একটি প্রয়োজন:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

আরও তথ্যের জন্য, প্রমাণীকরণ ওভারভিউ দেখুন।

IndexRequest তৈরি করুন

FirestoreAdmin.CreateIndex এর জন্য অনুরোধ।

ক্ষেত্র
parent

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

কম্পোজিট সূচক তৈরি করতে হবে।

ডিলিট ইনডেক্স রিকোয়েস্ট

FirestoreAdmin.DeleteIndex এর জন্য অনুরোধ।

ক্ষেত্র
name

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

রপ্তানি নথি মেটাডেটা

FirestoreAdmin.ExportDocuments থেকে google.longrunning.Operation ফলাফলের জন্য মেটাডেটা।

ক্ষেত্র
start_time

Timestamp

যে সময় এই অপারেশন শুরু হয়।

end_time

Timestamp

এই অপারেশন শেষ সময়. অপারেশন এখনও চলমান থাকলে আনসেট করা হবে।

operation_state

OperationState

রপ্তানি কার্যক্রমের অবস্থা।

progress_documents

Progress

অগ্রগতি, নথিতে, এই অপারেশন.

progress_bytes

Progress

এই অপারেশনের অগ্রগতি, বাইটে।

collection_ids[]

string

কোন সংগ্রহ আইডি রপ্তানি করা হচ্ছে.

output_uri_prefix

string

যেখানে সত্তা রপ্তানি করা হচ্ছে।

রপ্তানি নথি অনুরোধ

FirestoreAdmin.ExportDocuments এর জন্য অনুরোধ।

ক্ষেত্র
name

string

রপ্তানি করার জন্য ডাটাবেস। ফর্মের হওয়া উচিত: projects/{project_id}/databases/{database_id}

collection_ids[]

string

কোন কালেকশন আইডি এক্সপোর্ট করতে হবে। অনির্দিষ্ট মানে সমস্ত সংগ্রহ।

output_uri_prefix

string

আউটপুট URI. বর্তমানে শুধুমাত্র ফর্মের Google ক্লাউড স্টোরেজ URI সমর্থন করে: gs://BUCKET_NAME[/NAMESPACE_PATH] , যেখানে BUCKET_NAME হল Google ক্লাউড স্টোরেজ বাকেটের নাম এবং NAMESPACE_PATH হল একটি ঐচ্ছিক Google ক্লাউড স্টোরেজ নামস্থান পাথ৷ একটি নাম নির্বাচন করার সময়, Google ক্লাউড স্টোরেজ নামকরণের নির্দেশিকাগুলি বিবেচনা করতে ভুলবেন না: https://cloud.google.com/storage/docs/naming । যদি URI একটি বালতি হয় (একটি নামস্থান পাথ ছাড়া), তাহলে শুরুর সময়ের উপর ভিত্তি করে একটি উপসর্গ তৈরি করা হবে।

রপ্তানি নথি প্রতিক্রিয়া

google.longrunning.Operation প্রতিক্রিয়া ফিল্ডে ফিরে এসেছে।

ক্ষেত্র
output_uri_prefix

string

আউটপুট ফাইলের অবস্থান। অপারেশন সফলভাবে শেষ হওয়ার পরে এটি ক্লাউড ফায়ারস্টোরে (এই প্রকল্প বা অন্য প্রকল্প) একটি আমদানি শুরু করতে ব্যবহার করা যেতে পারে।

মাঠ

ডাটাবেসের একটি একক ক্ষেত্র প্রতিনিধিত্ব করে।

ক্ষেত্রগুলিকে তাদের "সংগ্রহ গোষ্ঠী" দ্বারা গোষ্ঠীভুক্ত করা হয়, যা একই আইডি সহ ডাটাবেসের সমস্ত সংগ্রহকে উপস্থাপন করে।

ক্ষেত্র
name

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

একটি ক্ষেত্র পাথ একটি সাধারণ ক্ষেত্রের নাম হতে পারে, যেমন address বা map_value-এর মধ্যে ক্ষেত্রগুলির পথ, যেমন address.city , বা একটি বিশেষ ক্ষেত্রের পথ। একমাত্র বৈধ বিশেষ ক্ষেত্র হল * , যা যেকোনো ক্ষেত্রের প্রতিনিধিত্ব করে।

ক্ষেত্র পাথ (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: * , . , ``` (backtick), [ , ]`, সেইসাথে যেকোনো ascii প্রতীকী অক্ষর।

উদাহরণ: (দ্রষ্টব্য: এখানে মন্তব্যগুলি মার্কডাউন সিনট্যাক্সে লেখা হয়েছে, তাই একটি কোড ব্লককে উপস্থাপন করার জন্য ব্যাকটিক্সের একটি অতিরিক্ত স্তর রয়েছে) \ address.city` ঠিকানা.city represents a field named , in the field , not the map key . `*` *` represents a field named , কোনো ক্ষেত্র নয়।

একটি বিশেষ Field সমস্ত ক্ষেত্রের জন্য ডিফল্ট সূচীকরণ সেটিংস ধারণ করে। এই ক্ষেত্রের সম্পদের নাম হল: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* এই Field সংজ্ঞায়িত সূচীগুলি এমন সমস্ত ক্ষেত্রে প্রয়োগ করা হবে যেগুলির নিজস্ব Field সূচক কনফিগারেশন নেই৷

index_config

IndexConfig

এই ক্ষেত্রের জন্য সূচক কনফিগারেশন. যদি সেট না করা হয়, ফিল্ড ইন্ডেক্সিং ancestor_field দ্বারা সংজ্ঞায়িত কনফিগারেশনে ফিরে যাবে। স্পষ্টভাবে এই ক্ষেত্রের জন্য সমস্ত সূচী অপসারণ করতে, সূচীগুলির একটি খালি তালিকা সহ একটি সূচক কনফিগার নির্দিষ্ট করুন৷

IndexConfig

এই ক্ষেত্রের জন্য সূচক কনফিগারেশন.

ক্ষেত্র
indexes[]

Index

এই ক্ষেত্রের জন্য সূচী সমর্থিত.

uses_ancestor_config

bool

শুধুমাত্র আউটপুট। সত্য হলে, Field সূচী কনফিগারেশন ancestor_field দ্বারা নির্দিষ্ট করা কনফিগারেশন থেকে সেট করা হয়। মিথ্যা হলে, Field সূচক কনফিগারেশন স্পষ্টভাবে সংজ্ঞায়িত করা হয়।

ancestor_field

string

শুধুমাত্র আউটপুট। Field সম্পদের নাম উল্লেখ করে যেখান থেকে এই ক্ষেত্রের সূচী কনফিগারেশন সেট করা হয় (যখন uses_ancestor_config সত্য হয়), অথবা যেখান থেকে এটি সেট করা হবে যদি এই ক্ষেত্রের কোনো সূচক কনফিগারেশন না থাকে (যখন uses_ancestor_config মিথ্যা হয়)।

reverting

bool

শুধুমাত্র আউটপুট সত্য হলে, Field সূচী কনফিগারেশন প্রত্যাবর্তনের প্রক্রিয়াধীন রয়েছে। একবার সম্পূর্ণ হলে, ইনডেক্স কনফিগারেশনটি ancestor_field দ্বারা নির্দিষ্ট ক্ষেত্রের মতো একই অবস্থায় স্থানান্তরিত হবে, যেখানে uses_ancestor_config true হবে এবং reverting false হবে।

ফিল্ড অপারেশন মেটাডেটা

FirestoreAdmin.UpdateField থেকে google.longrunning.Operation ফলাফলের জন্য মেটাডেটা।

ক্ষেত্র
start_time

Timestamp

যে সময় এই অপারেশন শুরু হয়।

end_time

Timestamp

এই অপারেশন শেষ সময়. অপারেশন এখনও চলমান থাকলে আনসেট করা হবে।

field

string

এই অপারেশন কাজ করছে যে ক্ষেত্রের সম্পদ. যেমন: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas[]

IndexConfigDelta

IndexConfigDelta এর একটি তালিকা, যা এই অপারেশনের উদ্দেশ্য বর্ণনা করে।

state

OperationState

অপারেশনের অবস্থা।

document_progress

Progress

অগ্রগতি, নথিতে, এই অপারেশন.

bytes_progress

Progress

এই অপারেশনের অগ্রগতি, বাইটে।

IndexConfigDelta

একটি সূচক কনফিগারেশন পরিবর্তন সম্পর্কে তথ্য।

ক্ষেত্র
change_type

ChangeType

সূচক কিভাবে পরিবর্তিত হচ্ছে তা উল্লেখ করে।

index

Index

সূচক পরিবর্তন করা হচ্ছে।

ধরন পরিবর্তন করুন

সূচক কিভাবে পরিবর্তিত হচ্ছে তা উল্লেখ করে।

এনামস
CHANGE_TYPE_UNSPECIFIED পরিবর্তনের ধরন নির্দিষ্ট বা জানা নেই।
ADD একক ক্ষেত্র সূচক যোগ করা হচ্ছে।
REMOVE একক ক্ষেত্র সূচক সরানো হচ্ছে।

GetFieldRequest

FirestoreAdmin.GetField এর জন্য অনুরোধ।

ক্ষেত্র
name

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

FirestoreAdmin.GetIndex এর জন্য অনুরোধ।

ক্ষেত্র
name

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ডকুমেন্টস মেটাডেটা আমদানি করুন

FirestoreAdmin.ImportDocuments থেকে google.longrunning.Operation ফলাফলের জন্য মেটাডেটা।

ক্ষেত্র
start_time

Timestamp

যে সময় এই অপারেশন শুরু হয়।

end_time

Timestamp

এই অপারেশন শেষ সময়. অপারেশন এখনও চলমান থাকলে আনসেট করা হবে।

operation_state

OperationState

আমদানি কার্যক্রমের অবস্থা।

progress_documents

Progress

অগ্রগতি, নথিতে, এই অপারেশন.

progress_bytes

Progress

এই অপারেশনের অগ্রগতি, বাইটে।

collection_ids[]

string

কোন সংগ্রহ আইডি আমদানি করা হচ্ছে.

input_uri_prefix

string

নথি আমদানি করা হচ্ছে অবস্থান.

ডকুমেন্টস অনুরোধ আমদানি করুন

FirestoreAdmin.ImportDocuments এর জন্য অনুরোধ।

ক্ষেত্র
name

string

ডাটাবেস আমদানি করতে। ফর্মের হওয়া উচিত: projects/{project_id}/databases/{database_id}

collection_ids[]

string

কোন কালেকশন আইডি আমদানি করতে হবে। অনির্দিষ্ট মানে আমদানিতে অন্তর্ভুক্ত সমস্ত সংগ্রহ।

input_uri_prefix

string

এক্সপোর্ট করা ফাইলের অবস্থান। এটি অবশ্যই সফলভাবে সম্পন্ন হয়েছে এমন একটি রপ্তানি থেকে ExportDocumentsResponse-এর output_uri_prefix এর সাথে মেলে। দেখুন: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix

সূচক

ক্লাউড ফায়ারস্টোর সূচীগুলি একটি ডাটাবেসের নথিগুলির বিরুদ্ধে সহজ এবং জটিল প্রশ্নগুলি সক্ষম করে৷

ক্ষেত্র
name

string

শুধুমাত্র আউটপুট। এই সূচকের জন্য একটি সার্ভার সংজ্ঞায়িত নাম। যৌগিক সূচীগুলির জন্য এই নামের ফর্মটি হবে: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} একক ক্ষেত্রের সূচীগুলির জন্য, এই ক্ষেত্রটি খালি থাকবে৷

query_scope

QueryScope

একটি সংগ্রহের ক্যোয়ারী স্কোপ নির্দিষ্ট করা সূচীগুলি এমন একটি সংগ্রহের বিরুদ্ধে প্রশ্ন করার অনুমতি দেয় যা একটি নির্দিষ্ট নথির চাইল্ড, কোয়েরির সময় নির্দিষ্ট করা হয় এবং যার একই সংগ্রহ আইডি রয়েছে৷

একটি সংগ্রহ গ্রুপ ক্যোয়ারী স্কোপ নির্দিষ্ট করা সূচীগুলি একটি নির্দিষ্ট নথি থেকে প্রাপ্ত সমস্ত সংগ্রহের বিরুদ্ধে প্রশ্ন করার অনুমতি দেয়, কোয়েরির সময় নির্দিষ্ট করা হয় এবং যেগুলির এই সূচকের মতো একই সংগ্রহ আইডি রয়েছে৷

fields[]

IndexField

এই সূচক দ্বারা সমর্থিত ক্ষেত্র.

যৌগিক সূচীগুলির জন্য, এটি সর্বদা 2 বা তার বেশি ক্ষেত্র। শেষ ক্ষেত্র এন্ট্রি সর্বদা ক্ষেত্রের পথের জন্য হয় __name__ । যদি, সৃষ্টির সময়, __name__ শেষ ক্ষেত্র হিসাবে নির্দিষ্ট করা না থাকে, তাহলে এটি স্বয়ংক্রিয়ভাবে সংজ্ঞায়িত শেষ ক্ষেত্রের মত একই দিক দিয়ে যুক্ত হবে। যদি একটি যৌগিক সূচকের চূড়ান্ত ক্ষেত্রটি দিকনির্দেশনামূলক না হয়, তাহলে __name__ ক্রমবর্ধমান ক্রমানুসারে হবে (যদি না স্পষ্টভাবে নির্দিষ্ট করা হয়)।

একক ক্ষেত্রের সূচীগুলির জন্য, এটি সর্বদা সংশ্লিষ্ট ক্ষেত্রের ক্ষেত্রের পথের সমান একটি ক্ষেত্র পাথ সহ ঠিক একটি এন্ট্রি হবে।

state

State

শুধুমাত্র আউটপুট। সূচকের পরিবেশন অবস্থা।

ইনডেক্সফিল্ড

একটি সূচক একটি ক্ষেত্র. ক্ষেত্র_পথ বর্ণনা করে কোন ক্ষেত্রটি সূচীকৃত হয়েছে, মান_মোড বর্ণনা করে যে কীভাবে ক্ষেত্রের মান সূচীকৃত হয়।

ক্ষেত্র
field_path

string

নাম হতে পারে। একক ক্ষেত্রের সূচীগুলির জন্য, এটি অবশ্যই ক্ষেত্রের নামের সাথে মেলে বা বাদ দেওয়া হতে পারে৷

ইউনিয়ন ক্ষেত্র value_mode । কিভাবে ক্ষেত্রের মান সূচক করা হয়। value_mode নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:
order

Order

নির্দেশ করে যে এই ক্ষেত্রটি নির্দিষ্ট ক্রম অনুসারে অর্ডার করা বা =, <, <=, >, >= ব্যবহার করে তুলনা করা সমর্থন করে।

array_config

ArrayConfig

নির্দেশ করে যে এই ক্ষেত্রটি array_value s-এ ক্রিয়াকলাপ সমর্থন করে।

ArrayConfig

সমর্থিত অ্যারের মান কনফিগারেশন।

এনামস
ARRAY_CONFIG_UNSPECIFIED সূচক অতিরিক্ত অ্যারে প্রশ্ন সমর্থন করে না.
CONTAINS সূচক অ্যারে কন্টেনমেন্ট প্রশ্ন সমর্থন করে।

অর্ডার

সমর্থিত আদেশ.

এনামস
ORDER_UNSPECIFIED অর্ডার অনির্দিষ্ট. একটি বৈধ বিকল্প নয়.
ASCENDING ক্ষেত্রটি ক্রমবর্ধমান ক্ষেত্রের মান দ্বারা সাজানো হয়।
DESCENDING ক্ষেত্রটি ক্ষেত্রটির মান অবতরণ করে সাজানো হয়।

কোয়েরিস্কোপ

ক্যোয়ারী স্কোপ একটি কোয়েরি চালানোর সুযোগকে সংজ্ঞায়িত করে। এটি একটি StructuredQuery এর ক্ষেত্র from নির্দিষ্ট করা হয়েছে।

এনামস
QUERY_SCOPE_UNSPECIFIED ক্যোয়ারী সুযোগ অনির্দিষ্ট. একটি বৈধ বিকল্প নয়.
COLLECTION একটি সংগ্রহের ক্যোয়ারী স্কোপ নির্দিষ্ট করা সূচীগুলি এমন একটি সংগ্রহের বিরুদ্ধে প্রশ্নের অনুমতি দেয় যা একটি নির্দিষ্ট নথির চাইল্ড, কোয়েরির সময় নির্দিষ্ট করা হয় এবং যেটি সূচক দ্বারা নির্দিষ্ট করা সংগ্রহ আইডি রয়েছে৷
COLLECTION_GROUP একটি সংগ্রহ গ্রুপ ক্যোয়ারী স্কোপ নির্দিষ্ট করা সূচীগুলি সূচী দ্বারা নির্দিষ্ট করা সংগ্রহ আইডি আছে এমন সমস্ত সংগ্রহের বিরুদ্ধে প্রশ্নের অনুমতি দেয়৷

অবস্থা

একটি সূচকের অবস্থা। সূচক তৈরির সময়, একটি সূচক CREATING অবস্থায় থাকবে। সূচী সফলভাবে তৈরি করা হলে, এটি READY অবস্থায় স্থানান্তরিত হবে। যদি সূচক তৈরিতে কোনো সমস্যার সম্মুখীন হয়, তাহলে সূচকটি NEEDS_REPAIR অবস্থায় স্থানান্তরিত হবে।

এনামস
STATE_UNSPECIFIED রাষ্ট্র অনির্দিষ্ট।
CREATING সূচক তৈরি করা হচ্ছে। সূচকের জন্য একটি সক্রিয় দীর্ঘমেয়াদী অপারেশন আছে। একটি নথি লেখার সময় সূচক আপডেট করা হয়। কিছু সূচক ডেটা বিদ্যমান থাকতে পারে।
READY সূচক ব্যবহার করার জন্য প্রস্তুত. একটি নথি লেখার সময় সূচক আপডেট করা হয়। এটি প্রযোজ্য সমস্ত সঞ্চিত নথি থেকে সূচকটি সম্পূর্ণরূপে জনবহুল।
NEEDS_REPAIR সূচক তৈরি করা হচ্ছে, কিন্তু কিছু ভুল হয়েছে। সূচকের জন্য কোন সক্রিয় দীর্ঘমেয়াদী ক্রিয়াকলাপ নেই, এবং অতি সম্প্রতি সমাপ্ত দীর্ঘ-চলমান অপারেশন ব্যর্থ হয়েছে৷ একটি নথি লেখার সময় সূচক আপডেট করা হয় না। কিছু সূচক ডেটা বিদ্যমান থাকতে পারে। google.longrunning.Operations API ব্যবহার করুন কেন এই সূচীটি তৈরি করার জন্য সর্বশেষ প্রচেষ্টা ব্যর্থ হয়েছে তা নির্ধারণ করতে, তারপর সূচী পুনরায় তৈরি করুন৷

IndexOperationMetadata

FirestoreAdmin.CreateIndex থেকে google.longrunning.Operation ফলাফলের জন্য মেটাডেটা।

ক্ষেত্র
start_time

Timestamp

যে সময় এই অপারেশন শুরু হয়।

end_time

Timestamp

এই অপারেশন শেষ সময়. অপারেশন এখনও চলমান থাকলে আনসেট করা হবে।

index

string

সূচক সম্পদ যে এই অপারেশন কাজ করছে. যেমন: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

state

OperationState

অপারেশনের অবস্থা।

progress_documents

Progress

অগ্রগতি, নথিতে, এই অপারেশন.

progress_bytes

Progress

এই অপারেশনের অগ্রগতি, বাইটে।

ListFieldsRequest

FirestoreAdmin.ListFields এর জন্য অনুরোধ।

ক্ষেত্র
parent

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

তালিকার ফলাফলে প্রয়োগ করার জন্য ফিল্টার। বর্তমানে, FirestoreAdmin.ListFields শুধুমাত্র তালিকার ক্ষেত্রগুলিকে সমর্থন করে যেগুলি স্পষ্টভাবে ওভাররাইড করা হয়েছে৷ এই ক্যোয়ারী ইস্যু করতে, indexConfig.usesAncestorConfig:false এ ফিল্টার সেট সহ FirestoreAdmin.ListFields এ কল করুন।

page_size

int32

ফলাফলের সংখ্যা।

page_token

string

একটি পৃষ্ঠা টোকেন, FirestoreAdmin.ListFields এ পূর্ববর্তী কল থেকে ফিরে এসেছে, যা ফলাফলের পরবর্তী পৃষ্ঠা পেতে ব্যবহার করা যেতে পারে।

তালিকাক্ষেত্র প্রতিক্রিয়া

FirestoreAdmin.ListFields এর প্রতিক্রিয়া।

ক্ষেত্র
fields[]

Field

অনুরোধ করা ক্ষেত্র.

next_page_token

string

একটি পৃষ্ঠা টোকেন যা ফলাফলের অন্য পৃষ্ঠার অনুরোধ করতে ব্যবহার করা যেতে পারে। ফাঁকা থাকলে, এটি শেষ পৃষ্ঠা।

তালিকা ইনডেক্সের অনুরোধ

FirestoreAdmin.ListIndexes এর জন্য অনুরোধ।

ক্ষেত্র
parent

string

ফর্ম projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

তালিকার ফলাফলে প্রয়োগ করার জন্য ফিল্টার।

page_size

int32

ফলাফলের সংখ্যা।

page_token

string

একটি পৃষ্ঠা টোকেন, FirestoreAdmin.ListIndexes এ পূর্ববর্তী কল থেকে ফিরে এসেছে, যা ফলাফলের পরবর্তী পৃষ্ঠা পেতে ব্যবহার করা যেতে পারে।

তালিকা সূচক প্রতিক্রিয়া

FirestoreAdmin.ListIndexes এর প্রতিক্রিয়া।

ক্ষেত্র
indexes[]

Index

অনুরোধ করা সূচক.

next_page_token

string

একটি পৃষ্ঠা টোকেন যা ফলাফলের অন্য পৃষ্ঠার অনুরোধ করতে ব্যবহার করা যেতে পারে। ফাঁকা থাকলে, এটি শেষ পৃষ্ঠা।

অপারেশন স্টেট

অপারেশনের অবস্থা বর্ণনা করে।

এনামস
OPERATION_STATE_UNSPECIFIED অনির্দিষ্ট।
INITIALIZING অনুরোধ প্রক্রিয়াকরণের জন্য প্রস্তুত করা হচ্ছে.
PROCESSING অনুরোধ সক্রিয়ভাবে প্রক্রিয়া করা হচ্ছে.
CANCELLING ব্যবহারকারীর অপারেশনে google.longrunning.Operations.CancelOperation কল করার পরে অনুরোধটি বাতিল হওয়ার প্রক্রিয়াধীন রয়েছে৷
FINALIZING অনুরোধ প্রক্রিয়া করা হয়েছে এবং এটি চূড়ান্ত পর্যায়ে রয়েছে।
SUCCESSFUL অনুরোধ সফলভাবে সম্পন্ন হয়েছে.
FAILED অনুরোধটি প্রক্রিয়া করা শেষ হয়েছে, কিন্তু একটি ত্রুটির সম্মুখীন হয়েছে৷
CANCELLED ব্যবহারকারী google.longrunning.Operations.CancelOperation কল করার পরে অনুরোধটি বাতিল করা শেষ হয়েছে৷

অগ্রগতি

অপারেশনের অগ্রগতি বর্ণনা করে। কাজের একক জেনেরিক এবং যেখানে Progress ব্যবহার করা হয় তার উপর ভিত্তি করে ব্যাখ্যা করা আবশ্যক।

ক্ষেত্র
estimated_work

int64

কাজের পরিমাণ আনুমানিক।

completed_work

int64

কাজ সম্পন্ন করা পরিমাণ.

ফিল্ড রিকোয়েস্ট আপডেট করুন

FirestoreAdmin.UpdateField এর জন্য অনুরোধ।

ক্ষেত্র
field

Field

ক্ষেত্র আপডেট করা হবে.

update_mask

FieldMask

একটি মুখোশ, ক্ষেত্রের আপেক্ষিক। নির্দিষ্ট করা হলে, শুধুমাত্র এই field_mask দ্বারা নির্দিষ্ট কনফিগারেশন ক্ষেত্রে আপডেট করা হবে।