จัดการดัชนี

MongoDB API

ใช้เมธอด createIndex() เพื่อสร้างดัชนี เช่น

•   db.restaurants.createIndex({"cuisine" : 1})
    

•   db.restaurants.createIndex({"cuisine" : 1}, {sparse: true})
    

• การสร้างดัชนีด้วย db.runCommand() ยังรองรับดัชนีอย่างน้อย 1 รายการด้วย

    db.runCommand({"createIndexes":"restaurant", "index": [{"key": {"cuisine":1}, {"name": "cuisine_index"}]})
    

โปรดทราบข้อจำกัดต่อไปนี้

• คุณสร้างดัชนีได้เพียง 1 รายการต่อคำขอ ไม่รองรับ db.collection.createIndexes()
• บันทึกการตรวจสอบสำหรับการสร้างดัชนีด้วย MongoDB API จะใช้ชื่อเมธอด google.firestore.admin.v1.FirestoreAdmin.CreateIndex
• ดูตัวเลือกดัชนีที่รองรับได้ที่ดัชนีและพร็อพเพอร์ตี้ดัชนี

Firebase คอนโซล

1. ในFirebaseคอนโซล ให้ไปที่หน้าฐานข้อมูล Firestore

   ไปที่ฐานข้อมูล Firestore

2. เลือกฐานข้อมูลจากรายการฐานข้อมูล
3. ในแท็บดัชนี ให้คลิกสร้างดัชนี
4. ป้อนรหัสคอลเล็กชัน
5. เพิ่มเส้นทางฟิลด์อย่างน้อย 1 รายการ แล้วเลือกตัวเลือกดัชนีสำหรับแต่ละรายการ
6. เลือกตัวเลือกการแสดงฟิลด์ ไม่ว่าจะเป็นแบบไม่กระจัดกระจายหรือแบบกระจัดกระจาย
7. คุณเลือกตั้งค่าตัวเลือกดัชนีแบบหลายคีย์ได้ (ไม่บังคับ)
8. คลิกสร้าง
9. ดัชนีใหม่จะแสดงในรายการดัชนีและ Cloud Firestoreเริ่มสร้างดัชนี เมื่อสร้างดัชนีแล้ว คุณจะเห็นเครื่องหมายถูกสีเขียวข้างดัชนี หากไม่ได้สร้างดัชนี โปรดดูสาเหตุที่เป็นไปได้ในข้อผิดพลาดในการสร้างดัชนี

gcloud CLI

หากต้องการสร้างดัชนี ให้ใช้คำสั่ง gcloud firestore indexes composite create ตั้งค่า api-scope เป็น mongodb-compatible-api

gcloud firestore indexes composite create \
--database='DATABASE_ID' \
--collection-group=COLLECTION \
--field-config=FIELD_CONFIGURATION \
--query-scope=collection-group \
--density=dense \
--api-scope=mongodb-compatible-api

แทนที่ค่าต่อไปนี้

• DATABASE_ID: รหัสฐานข้อมูล
• COLLECTION: ชื่อคอลเล็กชัน
• FIELD_CONFIGURATION: การกำหนดค่าฟิลด์ สำหรับแต่ละช่อง ให้เพิ่ม --field-config=field-path= เช่น

      --field-config=field-path=user-id,order=descending \
      --field-config=field-path=score,order=descending
      

  ดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดค่าช่องเหล่านี้ได้ที่ --field-config

หากต้องการสร้างดัชนีแบบกระจาย ให้ตั้งค่า --density=sparse-any

หากต้องการสร้างดัชนีแบบหลายคีย์ ให้เพิ่มแฟล็ก --multikey

หากต้องการสร้างดัชนีที่ไม่ซ้ำกัน ให้เพิ่มแฟล็ก --unique

Terraform

ใช้แหล่งข้อมูล google_firestore_index และตั้งค่า api_scope เป็น MONGODB_COMPATIBLE_API และ query_scope เป็น COLLECTION_GROUP

resource "google_firestore_index" "index" {
  database    = "DATABASE_ID"
  collection  = "COLLECTION"
  api_scope   = "MONGODB_COMPATIBLE_API"
  query_scope = "COLLECTION_GROUP"

  // You can include multiple field blocks
  fields {
    field_path = "FIELD_PATH"
    order      = "ORDER"
  }

  // Optional
  multikey = true
  density  = "DENSITY"
}

แทนที่ค่าต่อไปนี้

• DATABASE_ID: รหัสฐานข้อมูลสำหรับฐานข้อมูลที่คุณเลือก
• COLLECTION: ชื่อของคอลเล็กชันที่จะจัดทำดัชนี
• FIELD_PATH: ชื่อของช่องที่จะจัดทำดัชนี
• ORDER: ASCENDING หรือ DESCENDING
• DENSITY: SPARSE_ANY หรือ DENSE

MongoDB API

ใช้เมธอด createIndex() เพื่อสร้างดัชนีข้อความ ในตัวอย่างต่อไปนี้ เมื่อเขียนเอกสารไปยังคอลเล็กชัน cities ที่มีการป้อนข้อมูลในฟิลด์ country หรือ food ระบบจะจัดทำดัชนีฟิลด์เหล่านี้เพื่อวัตถุประสงค์ในการค้นหา

db.cities.createIndex({"country": "text", "food": "text"})

ฟิลด์ต้องเป็นสตริงหรืออาร์เรย์ของสตริงจึงจะทำดัชนีได้ ดัชนีอาร์เรย์จะไม่ได้รับการจัดทำดัชนีสำหรับการค้นหา ดังนั้น การจัดทำดัชนี a.1.b จะจัดทำดัชนี something ใน {a: {1: {b: something}}} แต่จะไม่จัดทำดัชนีใน {a: [one, {b: something}]}

นอกจากนี้ คุณยังสร้างดัชนีด้วย db.runCommand() ได้ด้วย คุณมีดัชนีข้อความได้เพียง 1 รายการต่อคอลเล็กชัน แต่สร้างดัชนีหลายรายการที่มีประเภทต่างกันใน 1 db.runCommand() ได้ ตัวอย่างต่อไปนี้ใช้ db.runCommand() เพื่อสร้างดัชนีข้อความ

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text" },
      name: "country_text_food_text"
    }
  ]
})

ระบุภาษาเริ่มต้น

นอกจากนี้ คุณยังระบุภาษาเริ่มต้นหรือเส้นทางฟิลด์ในเอกสารที่จะมีภาษาเริ่มต้นได้ด้วย

ในตัวอย่างต่อไปนี้ เราจะระบุ myLanguageField เป็น language_override เมื่อเอกสารในคอลเล็กชัน cities มีช่องชื่อ myLanguageField ระบบจะใช้ค่าของช่องนั้น เพื่อกำหนดภาษาสำหรับการจัดทำดัชนีช่อง country สำหรับเอกสารนั้น โดยเฉพาะ ค่าดังกล่าวจะลบล้างภาษาเริ่มต้นของ french

db.cities.createIndex({"country": "text"}, {"default_language": "french", "language_override": "myLanguageField"})

• คุณป้อนภาษาเป็นชื่อแบบยาว (english) หรือรหัสภาษา ISO แบบ 2 ตัวอักษร (en) ก็ได้
• หากไม่ได้ตั้งค่าภาษาเริ่มต้น Cloud Firestore จะมีค่าเริ่มต้นเป็นภาษาอังกฤษ
• ฟิลด์การลบล้างภาษาต้องเป็นฟิลด์ระดับบนสุด หากไม่ได้ตั้งค่าไว้ ช่องการลบล้างภาษาจะมีค่าเริ่มต้นเป็น language
• หากคุณตั้งค่าภาษาเริ่มต้นเป็นอักขระ null Cloud Firestore จะไม่ใช้ฟิลด์ใดเป็นค่าลบล้างภาษา

แบ่งพาร์ติชันดัชนีข้อความ

นอกจากนี้ คุณยังแบ่งพาร์ติชันดัชนีโดยใช้ฟิลด์เพื่อให้กรองการค้นหาตามค่าฟิลด์ที่เฉพาะเจาะจงได้ด้วย การกำหนดค่านี้ช่วยให้คุณเรียกใช้คำค้นหาที่มีประสิทธิภาพมากขึ้นได้ หากต้องการกรองฟิลด์ที่เฉพาะเจาะจงในดัชนีที่คุณกำลังค้นหาอยู่เสมอ

หากต้องการสร้างดัชนีที่มีพาร์ติชัน ให้กําหนดค่าฟิลด์ firestoreOptions ดังนี้

db.runCommand({
  createIndexes: "cities",
  indexes: [
    {
      key: { "country": "text", "food": "text"},
      name: "country_text_food_text"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

สถานที่:

• PARTITIONED_FIELD คือชื่อของฟิลด์ที่ใช้สำหรับ การแบ่งพาร์ติชัน ค่านี้ต้องเป็นสตริงและต้องอ้างอิงถึงฟิลด์ระดับบนสุด เมื่อเรียกใช้การค้นหาเทียบกับดัชนีที่แบ่งพาร์ติชัน คุณจะกรองผลลัพธ์ตามค่าของฟิลด์นี้ได้ เช่น คุณสามารถแบ่งพาร์ติชันดัชนีโดยใช้ city หากมีการกำหนดฟิลด์ city ในดัชนีข้อความ ผู้ใช้จะค้นหาเมืองที่เฉพาะเจาะจงได้

  พาร์ติชันต้องเป็นฟิลด์เดียวเท่านั้น หากแบ่งพาร์ติชันดัชนี คุณจะ เรียกใช้ได้เฉพาะการค้นหาที่ระบุช่องที่แบ่งพาร์ติชัน

ข้อจำกัด

• คุณสร้างดัชนีได้เพียง 1 รายการต่อคำขอ
• บันทึกการตรวจสอบสำหรับการสร้างดัชนีด้วย MongoDB API จะใช้ชื่อเมธอด google.firestore.admin.v1.FirestoreAdmin.CreateIndex
• ดูตัวเลือกดัชนีที่รองรับได้ที่ดัชนีและพร็อพเพอร์ตี้ ดัชนี

Firebase คอนโซล

1. ในFirebase คอนโซล ให้ไปที่หน้าฐานข้อมูล Firestore

   ไปที่ฐานข้อมูล Firestore

2. เลือกฐานข้อมูลจากรายการฐานข้อมูล

3. ในแท็บดัชนี ให้คลิกสร้างดัชนี

4. ป้อนรหัสคอลเล็กชัน

5. เพิ่มเส้นทางฟิลด์อย่างน้อย 1 รายการ แล้วเลือกตัวเลือกดัชนีสำหรับแต่ละรายการ

6. คลิกสร้าง

7. ดัชนีใหม่จะแสดงในรายการดัชนี และการดำเนินการที่เข้ากันได้กับ MongoDB จะเริ่มสร้างดัชนี เมื่อสร้างดัชนีแล้ว คุณจะเห็นเครื่องหมายถูกสีเขียวข้างดัชนี หากไม่ได้สร้างดัชนี โปรดดูข้อผิดพลาดในการสร้างดัชนีเพื่อดูสาเหตุที่อาจเกิดขึ้น

MongoDB API

ใช้วิธี createIndex() เพื่อสร้างดัชนี เช่น

db.restaurants.createIndex({"location" : "2dsphere", "region": "2dsphere"})

ระบบยังรองรับการสร้างดัชนีด้วย db.runCommand() โดยมีดัชนีได้สูงสุด 1 รายการ

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
    }
  ]
})

แบ่งพาร์ติชันดัชนี 2dsphere

นอกจากนี้ คุณยังแบ่งพาร์ติชันดัชนีโดยใช้ฟิลด์เพื่อให้กรองการค้นหาตามค่าฟิลด์ที่เฉพาะเจาะจงได้ด้วย การกำหนดค่านี้ช่วยให้คุณเรียกใช้คำค้นหาที่มีประสิทธิภาพมากขึ้นได้ หากต้องการกรองฟิลด์ที่เฉพาะเจาะจงในดัชนีที่คุณกำลังค้นหาอยู่เสมอ

หากต้องการสร้างดัชนีที่มีพาร์ติชัน ให้กําหนดค่าฟิลด์ firestoreOptions ดังนี้

db.runCommand({
  createIndexes: "restaurants",
  indexes: [
    {
      key: { "location": "2dsphere", "region": "2dsphere" },
      name: "location_2dsphere_region_2dsphere"
      firestoreOptions: {"customPartitionFields": ["PARTITIONED_FIELD"]
    }
  ]
})

สถานที่:

• PARTITIONED_FIELD คือชื่อของฟิลด์ที่ใช้สำหรับ การแบ่งพาร์ติชัน เมื่อเรียกใช้การค้นหาเทียบกับดัชนีที่แบ่งพาร์ติชัน คุณจะกรองผลลัพธ์ตามค่าของฟิลด์นี้ได้ เช่น หากดัชนีมีฟิลด์ region สำหรับสถานที่ตั้งระดับภูมิภาค คุณสามารถแบ่งพาร์ติชันดัชนีโดยใช้ region เพื่อให้ผู้ใช้ค้นหาร้านอาหารในภูมิภาคของตนได้

  หากแบ่งพาร์ติชันดัชนี คุณจะเรียกใช้ได้เฉพาะการค้นหาที่มีการระบุฟิลด์ที่แบ่งพาร์ติชัน

ข้อจำกัด

• คุณสร้างดัชนีได้เพียง 1 รายการต่อคำขอ
• บันทึกการตรวจสอบสำหรับการสร้างดัชนีด้วย MongoDB API จะใช้ชื่อเมธอด google.firestore.admin.v1.FirestoreAdmin.CreateIndex
• ดูตัวเลือกดัชนีที่รองรับได้ที่ดัชนีและพร็อพเพอร์ตี้ ดัชนี

Firebase คอนโซล

1. ในFirebase คอนโซล ให้ไปที่หน้าฐานข้อมูล Firestore

   ไปที่ฐานข้อมูล Firestore

2. เลือกฐานข้อมูลจากรายการฐานข้อมูล

3. ในแท็บดัชนี ให้คลิกสร้างดัชนี

4. ป้อนรหัสคอลเล็กชัน

5. เพิ่มเส้นทางฟิลด์อย่างน้อย 1 รายการ แล้วเลือกตัวเลือกดัชนีสำหรับแต่ละรายการ

6. คลิกสร้าง

7. ดัชนีใหม่จะแสดงในรายการดัชนี และการดำเนินการที่เข้ากันได้กับ MongoDB จะเริ่มสร้างดัชนี เมื่อสร้างดัชนีแล้ว คุณจะเห็นเครื่องหมายถูกสีเขียวข้างดัชนี หากไม่ได้สร้างดัชนี โปรดดูข้อผิดพลาดในการสร้างดัชนีเพื่อดูสาเหตุที่อาจเกิดขึ้น

MongoDB API

ใช้เมธอด dropIndex() เพื่อลบดัชนี เช่น

ลบดัชนีโดยใช้ชื่อดัชนี

db.restaurants.dropIndex("cuisine_index")

ลบดัชนีโดยใช้คำจำกัดความดัชนี

db.restaurants.dropIndex({"cuisine" : 1})

Firebase คอนโซล

1. ในFirebaseคอนโซล ให้ไปที่หน้าฐานข้อมูล Firestore

   ไปที่ฐานข้อมูล Firestore

2. เลือกฐานข้อมูลจากรายการฐานข้อมูล
3. คลิกแท็บดัชนี
4. ในรายการดัชนี ให้เลือกลบจากปุ่มเพิ่มเติม more_vert สำหรับดัชนีที่ต้องการลบ
5. คลิกลบดัชนี

gcloud CLI

1. หากต้องการค้นหาชื่อดัชนี ให้ใช้คำสั่ง gcloud firestore indexes composite list

   gcloud firestore indexes composite list \
   --database='DATABASE_ID'

   แทนที่ DATABASE_ID ด้วยรหัสฐานข้อมูล

2. หากต้องการลบดัชนี ให้ใช้คำสั่ง gcloud firestore indexes composite delete

   gcloud firestore indexes composite delete INDEX_NAME \
   --database='DATABASE_ID'

   แทนที่ค่าต่อไปนี้

   • INDEX_NAME: ชื่อดัชนี
   • DATABASE_ID: รหัสฐานข้อมูล