FieldOperationMetadata

Siêu dữ liệu về các kết quả bằng google.longrunning.Operation 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 gian bắt đầu thao tác này.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 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àn tất thao tác này. 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 ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 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à toán tử này đang hoạt động. 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 của hoạt động này (trong các tài liệu).

progressBytes

object (Progress)

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

ttlConfigDelta

object (TtlConfigDelta)

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

IndexConfigDelta

Thông tin về 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 Cloud Firestore hỗ trợ các truy vấn đơn giản và phức tạp đối với 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. Tên này cho chỉ mục tổng hợp sẽ là: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Đối với 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 bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với một tập hợp là phần tử con của 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ã bộ sưu tập.

Các chỉ mục có phạm vi truy vấn nhóm bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với tất cả các bộ sưu tập là 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ã bộ sưu tậ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, yêu cầu tối thiểu là 2 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 vào theo cùng hướng với trường được xác định gần đây nhất. Nếu trường cuối cùng trong chỉ mục tổng hợp không mang tính định hướng, thì __name__ sẽ được sắp xếp theo thứ tự ASCENDING (trừ khi được chỉ định rõ ràng).

Đối với các chỉ mục trường đơn, đây sẽ luôn là một mục nhập có đường dẫn trường bằng với đườ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.

IndexField

Một trường trong chỉ mục. fieldPath 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, giá trị này phải khớp với tên của trường hoặc có thể bị bỏ qua.

Trường 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:
order

enum (Order)

Cho biết rằng trường này hỗ trợ sắp xếp theo thứ tự đã chỉ định hoặc so sánh bằng cách sử dụ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áng giềng 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 thao tác 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ơ mà cấu hình này áp dụng.

Chỉ mục kết quả sẽ chỉ bao gồm các vectơ của kích thước này và có thể được sử dụng cho tìm kiếm vectơ có cùng kích thước.

Trường 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:
flat

object (FlatIndex)

Cho biết chỉ mục vectơ là chỉ mục phẳng.

FlatIndex

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

Chỉ mục lưu trữ vectơ trong cấu trúc dữ liệu phẳng và hỗ trợ tìm kiếm đầy đủ.

TtlConfigDelta

Thông tin về việc 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ỉ rõ cách cấu hình TTL thay đổi.