API Reference

Description

The type IDType is used to specify the type of the identifier at the time of creating a collection. The identifier type can be provided by the user, or be generated by bg-search in an automatically incremented fashion (64-bit unsigned integer in both cases). When you are inserting into a collection with IDType of ID_TYPE_AUTO_INC, you should leave the id field of the GeometryID unset. Otherwise, you will get an error.

Proto Definition

enum IDType {
  ID_TYPE_UNSPECIFIED = 0;
  ID_TYPE_PROVIDED_U64 = 1;
  ID_TYPE_AUTO_INC = 4;
  reserved 2, 3;
  reserved "ID_TYPE_PROVIDED_UUID", "ID_TYPE_ASSIGNED_UUID";
}