API Reference

Description

The "Update" endpoint allows you to update the provided geometries.

Proto Definition


service BGSearch {
     rpc Update (UpdateArgs) returns (UpdateResult) {}
}

Input Message

Name: UpdateArgs

AttributeTypeDescription
collectionstringThe name of the collection.
IndexedGeometrygeometriesThe new Geometries and the payload to update.
message UpdateArgs {
  string collection = 1;
  repeated IndexedGeometry geometries = 2;
}

Output Message

Name: UpdateResult

AttributeTypeDescription
num_updateduint64The number of entries that are updated.
message UpdateResult {
  uint64 num_updated = 1;
}

Status Code

  • 5: NOT_FOUND if a collection with the provided name does not exist.