REST Resource: projects.databases.indexes

সম্পদ: সূচক

একটি সূচক সংজ্ঞা।

JSON প্রতিনিধিত্ব
{
  "name": string,
  "collectionId": string,
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
ক্ষেত্র
name

string

সূচকের সম্পদের নাম। শুধুমাত্র আউটপুট।

collectionId

string

এই সূচকটি যে সংগ্রহের আইডিতে প্রযোজ্য। প্রয়োজন।

fields[]

object ( IndexField )

সূচী ক্ষেত্র.

state

enum ( State )

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

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

একটি সূচকের ক্ষেত্র।

JSON প্রতিনিধিত্ব
{
  "fieldPath": string,
  "mode": enum (Mode)
}
ক্ষেত্র
fieldPath

string

মাঠের পথ। [google.firestore.v1beta1.Document.fields][fields] দ্বারা বর্ণিত ফিল্ড পাথ স্পেসিফিকেশনের সাথে মিলতে হবে। বিশেষ ক্ষেত্রের পথ __name__ নিজে থেকে বা একটি পথের শেষে ব্যবহার করা যেতে পারে। __type__ শুধুমাত্র পথের শেষে ব্যবহার করা যেতে পারে।

mode

enum ( Mode )

ক্ষেত্রের মোড.

মোড

মোড নির্ধারণ করে কিভাবে একটি ক্ষেত্র সূচিত করা হয়।

Enums
MODE_UNSPECIFIED মোড অনির্দিষ্ট.
ASCENDING ক্ষেত্রের মানগুলিকে ইন্ডেক্স করা হয় যাতে ক্রমবর্ধমান ক্রমানুসারে সমর্থন করা যায় এবং <, >, <=, >=, এবং = দ্বারা অনুসন্ধান করা যায়।
DESCENDING ক্ষেত্রের মানগুলিকে সূচিত করা হয় যাতে অবরোহ ক্রমে অনুক্রম সমর্থন করা যায় এবং <, >, <=, >=, এবং = দ্বারা অনুসন্ধান করা যায়।
ARRAY_CONTAINS ARRAY_CONTAINS ক্যোয়ারী ব্যবহার করে সদস্যতা সমর্থন করার জন্য ক্ষেত্রের অ্যারের মানগুলিকে সূচিত করা হয়েছে৷

অবস্থা

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

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

পদ্ধতি

create

নির্দিষ্ট সূচক তৈরি করে।

delete

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

get

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

list

নির্দিষ্ট ফিল্টারগুলির সাথে মেলে এমন সূচীগুলি তালিকাভুক্ত করে৷