Description
The "Remove" endpoint allows you to remove an entry from a collection provided the id.
Proto Definition
service BGSearch {
rpc Remove (RemoveArgs) returns (RemoveResult) {}
}
Input Message
Name: RemoveArgs
Attribute | Type | Description |
---|---|---|
collection | string | The name of the collection. |
id | GeometryID | The id to be removed. |
message RemoveArgs {
string collection = 1;
repeated GeometryID ids = 2;
}
Output Message
Name: RemoveResult
Attribute | Type | Description |
---|---|---|
num_removed | uint64 | The number of entries that were removed from the collection. |
message RemoveResult {
uint64 num_removed = 1;
}
Status Code
5: NOT_FOUND
if a collection with the provided name does not exist.