FieldOperationMetadata

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.UpdateField.

Biểu diễn dưới dạng JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Trường
startTime

string (Timestamp format)

Thời điểm bắt đầu hoạt động này.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Thời gian hoạt động này hoàn tất. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z".

field

string

Tài nguyên trường mà thao tác này đang thực hiện. Ví dụ: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

Danh sách IndexConfigDelta mô tả ý định của thao tác này.

state

enum (OperationState)

Trạng thái của hoạt động.

progressDocuments

object (Progress)

Tiến trình, trong tài liệu, của thao tác này.

progressBytes

object (Progress)

Tiến trình, tính bằng byte, của thao tác này.

ttlConfigDelta

object (TtlConfigDelta)

Mô tả delta của cấu hình TTL.

IndexConfigDelta

Thông tin về việc thay đổi cấu hình chỉ mục.

Biểu diễn dưới dạng JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Trường
changeType

enum (ChangeType)

Chỉ định cách chỉ mục thay đổi.

index

object (Index)

Chỉ mục đang được thay đổi.

Chỉ mục

Chỉ mục trên Cloud Firestore cho phép thực hiện các truy vấn đơn giản và phức tạp dựa trên các tài liệu trong cơ sở dữ liệu.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Trường
name

string

Chỉ có đầu ra. Tên do máy chủ xác định cho chỉ mục này. Dạng tên của tên này đối với chỉ mục kết hợp sẽ là: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Đối với các chỉ mục trường đơn, trường này sẽ trống.

queryScope

enum (QueryScope)

Các chỉ mục có phạm vi truy vấn tập hợp được chỉ định cho phép truy vấn đối với tập hợp là con của tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã nhận dạng tập hợp.

Các chỉ mục có phạm vi truy vấn nhóm tập hợp được chỉ định cho phép truy vấn đối với tất cả các tập hợp bắt nguồn từ một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã nhận dạng tập hợp với chỉ mục này.

apiScope

enum (ApiScope)

Phạm vi API mà chỉ mục này hỗ trợ.

fields[]

object (IndexField)

Các trường mà chỉ mục này hỗ trợ.

Đối với chỉ mục tổng hợp, bạn phải có tối thiểu 2 trường và tối đa là 100 trường. Mục nhập trường cuối cùng luôn dành cho đường dẫn trường __name__. Nếu khi tạo, __name__ không được chỉ định làm trường cuối cùng, thì trường này sẽ tự động được thêm theo cùng hướng với trường cuối cùng được xác định. Nếu trường cuối cùng trong một chỉ mục tổng hợp không có hướng, __name__ sẽ được sắp xếp theo thứ tự TĂNG CƯỜNG (trừ phi có chỉ định rõ ràng).

Đối với các chỉ mục trường đơn, đây sẽ luôn là chính xác một mục nhập có đường dẫn trường bằng đường dẫn trường của trường được liên kết.

state

enum (State)

Chỉ có đầu ra. Trạng thái phân phát của chỉ mục.

Trường chỉ mục

Một trường trong chỉ mục. Trường đường dẫn mô tả trường nào được lập chỉ mục, value_mode mô tả cách giá trị của trường được lập chỉ mục.

Biểu diễn dưới dạng JSON
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
Trường
fieldPath

string

Có thể là name. Đối với các chỉ mục trường đơn, tên này phải khớp với tên của trường, nếu không thì chỉ mục có thể bị bỏ qua.

Trường kết hợp value_mode. Cách Google lập chỉ mục giá trị của trường. value_mode chỉ có thể là một trong những trạng thái sau đây:
order

enum (Order)

Cho biết trường này hỗ trợ sắp xếp thứ tự theo thứ tự đã chỉ định hoặc so sánh bằng =, !=, <, <=, >, >=.

arrayConfig

enum (ArrayConfig)

Cho biết rằng trường này hỗ trợ các thao tác trên arrayValue.

vectorConfig

object (VectorConfig)

Cho biết rằng trường này hỗ trợ các lân cận gần nhất và các phép toán khoảng cách trên vectơ.

VectorConfig

Cấu hình chỉ mục để hỗ trợ các hoạt động tìm kiếm vectơ

Biểu diễn dưới dạng JSON
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
Trường
dimension

integer

Bắt buộc. Kích thước vectơ áp dụng cho cấu hình này.

Chỉ mục thu được sẽ chỉ bao gồm các vectơ của chiều này và có thể dùng để tìm kiếm vectơ có cùng chiều.

Trường kết hợp type. Loại chỉ mục được sử dụng. type chỉ có thể là một trong những trạng thái sau đây:
flat

object (FlatIndex)

Cho biết chỉ mục vectơ là một chỉ số cố định.

Chỉ số phẳng

Loại này không có trường nào.

Chỉ mục lưu trữ các vectơ trong cấu trúc dữ liệu phẳng và hỗ trợ tìm kiếm toàn diện.

TtlConfigDelta

Thông tin về thay đổi cấu hình TTL.

Biểu diễn dưới dạng JSON
{
  "changeType": enum (ChangeType)
}
Trường
changeType

enum (ChangeType)

Chỉ định cách cấu hình TTL thay đổi.