Annotations: add new UUID, update docs for external types #143

Author: greenrobot-team

objectbox/lib/src/annotations.dart

@@ -498,6 +498,13 @@ enum ExternalPropertyType {
   /// Encoding: 1:1 binary representation, little endian (16 bytes)
   int128,
 
+  /// A UUID (Universally Unique Identifier) as defined by RFC 9562.
+  ///
+  /// ObjectBox uses the UUIDv7 scheme (timestamp + random) to create new UUIDs.
+  /// UUIDv7 is a good choice for database keys as it's mostly sequential and
+  /// encodes a timestamp. However, if keys are used externally, consider
+  /// [uuidV4] for better privacy by not exposing any time information.
+  ///
   /// Representing type: ByteVector
   ///
   /// Encoding: 1:1 binary representation (16 bytes)
@@ -510,6 +517,33 @@ enum ExternalPropertyType {
   /// Encoding: 1:1 binary representation (16 bytes)
   decimal128,
 
+  /// UUID represented as a string of 36 characters, e.g.
+  /// "019571b4-80e3-7516-a5c1-5f1053d23fff".
+  ///
+  /// For efficient storage, consider the [uuid] type instead, which occupies
+  /// only 16 bytes (20 bytes less). This type may still be a convenient
+  /// alternative as the string type is widely supported and more
+  /// human-readable. In accordance to standards, new UUIDs generated by
+  /// ObjectBox use lowercase hexadecimal digits.
+  ///
+  /// Representing type: String
+  uuidString,
+
+  /// A UUID (Universally Unique Identifier) as defined by RFC 9562.
+  ///
+  /// ObjectBox uses the UUIDv4 scheme (completely random) to create new UUIDs.
+  ///
+  /// Representing type: ByteVector
+  ///
+  /// Encoding: 1:1 binary representation (16 bytes)
+  uuidV4,
+
+  /// Like [uuidString], but using the UUIDv4 scheme (completely random) to
+  /// create new UUID.
+  ///
+  /// Representing type: String
+  uuidV4String,
+
   /// A key/value map; e.g. corresponds to a JSON object or a MongoDB document
   /// (although not keeping the key order).
   ///
@@ -550,7 +584,7 @@ enum ExternalPropertyType {
   /// A vector (array) of Int128 values.
   int128Vector,
 
-  /// A vector (array) of Int128 values
+  /// A vector (array) of Uuid values
   uuidVector,
 
   /// The 12-byte ObjectId type in MongoDB.