REST Resource: projects.databases.collectionGroups.fields

Resource: Kolom

Menampilkan satu kolom dalam database.

Kolom dikelompokkan menurut "Grup Koleksi", yang mewakili semua koleksi dalam database dengan ID yang sama.

Representasi JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Kolom
name

string

Wajib. Nama kolom formulir projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Jalur kolom dapat berupa nama kolom sederhana, misalnya address atau jalur ke kolom dalam mapValue , misalnya address.city, atau jalur kolom khusus. Satu-satunya kolom khusus yang valid adalah *, yang mewakili kolom apa pun.

Jalur kolom dapat dikutip menggunakan (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),[,]`, serta semua karakter simbol ASCII.

Contoh: (Catatan: Komentar di sini ditulis dalam sintaksis markdown, sehingga ada lapisan tanda kutip terbalik tambahan untuk mewakili blok kode) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, bukan kolom apa pun.

Field khusus berisi setelan pengindeksan default untuk semua kolom. Nama resource kolom ini adalah: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indeks yang ditentukan dalam Field ini akan diterapkan ke semua kolom yang tidak memiliki konfigurasi indeks Field sendiri.
indexConfig

object (IndexConfig)

Konfigurasi indeks untuk kolom ini. Jika tidak disetel, pengindeksan kolom akan dikembalikan ke konfigurasi yang ditentukan oleh ancestorField. Untuk menghapus semua indeks untuk kolom ini secara eksplisit, tentukan konfigurasi indeks dengan daftar indeks kosong.
ttlConfig

object (TtlConfig)

Konfigurasi TTL untuk Field ini. Menyetel atau membatalkan setelan ini akan mengaktifkan atau menonaktifkan TTL untuk dokumen yang memiliki Field ini.

IndexConfig

Konfigurasi indeks untuk kolom ini.

Representasi JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Kolom
indexes[]

object (Index)

Indeks yang didukung untuk kolom ini.
usesAncestorConfig

boolean

Hanya output. Jika benar, konfigurasi indeks Field akan disetel dari konfigurasi yang ditentukan oleh ancestorField. Jika salah, konfigurasi indeks Field akan ditentukan secara eksplisit.
ancestorField

string

Hanya output. Menentukan nama resource Field yang digunakan untuk menetapkan konfigurasi indeks kolom ini (jika usesAncestorConfig bernilai benar), atau dari mana konfigurasi tersebut akan ditetapkan jika kolom ini tidak memiliki konfigurasi indeks (jika usesAncestorConfig bernilai salah).
reverting

boolean

Hanya output Saat benar, konfigurasi indeks Field sedang dalam proses dikembalikan. Setelah selesai, konfigurasi indeks akan bertransisi ke status yang sama dengan kolom yang ditentukan oleh ancestorField, di mana pada titik usesAncestorConfig akan menjadi true dan reverting akan menjadi false.

TtlConfig

Konfigurasi TTL (time-to-live) untuk dokumen yang telah menetapkan Field ini.

Penyimpanan nilai stempel waktu ke kolom yang mendukung TTL akan diperlakukan sebagai waktu habis masa berlaku absolut dokumen. Nilai stempel waktu di masa lalu menunjukkan bahwa dokumen memenuhi syarat untuk segera berakhir masa berlakunya. Menggunakan jenis data lainnya atau membiarkan kolom tidak ada akan menonaktifkan akhir masa berlaku untuk setiap dokumen.

Representasi JSON 
{
  "state": enum (State)
}
Kolom
state

enum (State)

Hanya output. Status konfigurasi TTL.

Negara Bagian

Status penerapan konfigurasi TTL ke semua dokumen.

Enum
STATE_UNSPECIFIED Status tidak ditentukan atau tidak diketahui.
CREATING TTL sedang diterapkan. Ada operasi aktif yang berjalan lama untuk melacak perubahan. Dokumen yang baru ditulis akan memiliki TTL yang diterapkan sesuai permintaan. TTL yang diminta pada dokumen yang ada masih diproses. Ketika TTL pada semua dokumen yang ada telah diproses, status akan dipindahkan ke 'ACTIVE'.
ACTIVE TTL aktif untuk semua dokumen.
NEEDS_REPAIR Konfigurasi TTL tidak dapat diaktifkan untuk semua dokumen yang ada. Dokumen yang baru ditulis akan tetap menerapkan TTL. LRO yang ditampilkan saat terakhir kali mencoba mengaktifkan TTL untuk Field ini gagal, dan mungkin memiliki detail selengkapnya.

Metode

get

 Mendapatkan metadata dan konfigurasi untuk Kolom.

list

 Mencantumkan konfigurasi kolom dan metadata untuk database ini.

patch

 Memperbarui konfigurasi kolom.