Insert

Description

The "Insert" endpoint allows you to insert geometries and their associative payload into the provided collection.

Proto Definition


service BGSearch {
rpc Insert (InsertArgs) returns (InsertResult) {}
}

Input Message

Name: InsertArgs

AttributeTypeDescription
collectionstringThe name of the collection.
geometriesIndexedGeometryThe Geometries and payload to be inserted into the collection.
message InsertArgs {
  string collection = 1;
  repeated IndexedGeometry geometries = 2;
}

Output Message

Name: InsertResult

AttributeTypeDescription
inserted_idsGeometryIDIDs that were inserted.
message InsertResult {
  repeated GeometryID inserted_ids = 1;
}

Status Code

  • 5: NOT_FOUND if a collection with the provided name does not exist.
  • 6: ALREADY_EXISTS if the ID of the geometry being inserted already exist.