Add UUID logical type support

Author: xiangfu0

README.md

@@ -187,5 +187,35 @@ Check out [Pinot documentation](https://docs.pinot.apache.org/) for a complete d
 - [Pinot Architecture](https://docs.pinot.apache.org/basics/architecture)
 - [Pinot Query Language](https://docs.pinot.apache.org/users/user-guide-query/pinot-query-language)
 
+### UUID Logical Type
+
+Pinot supports a logical `UUID` type for single-value columns. In v1, Pinot stores `UUID` values using the existing
+16-byte `BYTES` representation, while schema definitions and query results use canonical lowercase RFC 4122 strings.
+
+Schema example:
+```json
+{
+  "schemaName": "events",
+  "dimensionFieldSpecs": [
+    {
+      "name": "eventId",
+      "dataType": "UUID"
+    }
+  ]
+}
+```
+
+Query example:
+```sql
+SELECT eventId
+FROM events
+WHERE eventId = CAST('550e8400-e29b-41d4-a716-446655440000' AS UUID)
+```
+
+Migration notes:
+- Existing `BYTES` columns keep returning hex strings. Pinot only renders canonical UUID strings for columns declared as `UUID`.
+- Existing `STRING` or `BYTES` UUID data can be migrated to `UUID` columns without a segment or wire format change in v1.
+- Multi-value UUID columns are not supported in v1.
+
 ## License
 Apache Pinot is under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

pinot-common/src/main/java/org/apache/pinot/common/function/FunctionUtils.java

@@ -23,6 +23,7 @@
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.UUID;
 import javax.annotation.Nullable;
 import org.apache.calcite.rel.type.RelDataType;
 import org.apache.calcite.rel.type.RelDataTypeFactory;
@@ -52,6 +53,7 @@ private FunctionUtils() {
     put(Timestamp.class, PinotDataType.TIMESTAMP);
     put(String.class, PinotDataType.STRING);
     put(byte[].class, PinotDataType.BYTES);
+    put(UUID.class, PinotDataType.UUID);
     put(int[].class, PinotDataType.PRIMITIVE_INT_ARRAY);
     put(long[].class, PinotDataType.PRIMITIVE_LONG_ARRAY);
     put(float[].class, PinotDataType.PRIMITIVE_FLOAT_ARRAY);
@@ -75,6 +77,7 @@ private FunctionUtils() {
     put(Timestamp.class, PinotDataType.TIMESTAMP);
     put(String.class, PinotDataType.STRING);
     put(byte[].class, PinotDataType.BYTES);
+    put(UUID.class, PinotDataType.UUID);
     put(int[].class, PinotDataType.PRIMITIVE_INT_ARRAY);
     put(Integer[].class, PinotDataType.INTEGER_ARRAY);
     put(long[].class, PinotDataType.PRIMITIVE_LONG_ARRAY);
@@ -103,6 +106,7 @@ private FunctionUtils() {
     put(Timestamp.class, DataType.TIMESTAMP);
     put(String.class, DataType.STRING);
     put(byte[].class, DataType.BYTES);
+    put(UUID.class, DataType.UUID);
     put(int[].class, DataType.INT);
     put(long[].class, DataType.LONG);
     put(float[].class, DataType.FLOAT);
@@ -125,6 +129,7 @@ private FunctionUtils() {
     put(Timestamp.class, ColumnDataType.TIMESTAMP);
     put(String.class, ColumnDataType.STRING);
     put(byte[].class, ColumnDataType.BYTES);
+    put(UUID.class, ColumnDataType.UUID);
     put(int[].class, ColumnDataType.INT_ARRAY);
     put(long[].class, ColumnDataType.LONG_ARRAY);
     put(float[].class, ColumnDataType.FLOAT_ARRAY);
@@ -197,6 +202,8 @@ public static RelDataType getRelDataType(RelDataTypeFactory typeFactory, Class<?
       case STRING:
       case JSON:
         return typeFactory.createSqlType(SqlTypeName.VARCHAR);
+      case UUID:
+        return typeFactory.createSqlType(SqlTypeName.UUID);
       case BYTES:
         return typeFactory.createSqlType(SqlTypeName.VARBINARY);
       case INT_ARRAY:

pinot-common/src/main/java/org/apache/pinot/common/function/scalar/StringFunctions.java

@@ -20,16 +20,15 @@
 
 import com.google.common.annotations.VisibleForTesting;
 import java.io.UnsupportedEncodingException;
-import java.nio.ByteBuffer;
 import java.nio.charset.StandardCharsets;
 import java.text.Normalizer;
 import java.util.Base64;
-import java.util.UUID;
 import javax.annotation.Nullable;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.pinot.common.utils.URIUtils;
 import org.apache.pinot.spi.annotations.ScalarFunction;
 import org.apache.pinot.spi.utils.JsonUtils;
+import org.apache.pinot.spi.utils.UuidUtils;
 
 
 /**
@@ -442,12 +441,8 @@ public static String fromAscii(byte[] input) {
   @ScalarFunction
   public static byte[] toUUIDBytes(String input) {
     try {
-      UUID uuid = UUID.fromString(input);
-      ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
-      bb.putLong(uuid.getMostSignificantBits());
-      bb.putLong(uuid.getLeastSignificantBits());
-      return bb.array();
-    } catch (IllegalArgumentException e) {
+      return UuidUtils.toBytes(input);
+    } catch (Exception e) {
       return null;
     }
   }
@@ -459,10 +454,7 @@ public static byte[] toUUIDBytes(String input) {
    */
   @ScalarFunction
   public static String fromUUIDBytes(byte[] input) {
-    ByteBuffer bb = ByteBuffer.wrap(input);
-    long firstLong = bb.getLong();
-    long secondLong = bb.getLong();
-    return new UUID(firstLong, secondLong).toString();
+    return UuidUtils.toString(input);
   }
 
   /**

pinot-common/src/main/java/org/apache/pinot/common/request/context/predicate/BaseInPredicate.java

@@ -25,6 +25,7 @@
 import org.apache.pinot.spi.utils.ByteArray;
 import org.apache.pinot.spi.utils.BytesUtils;
 import org.apache.pinot.spi.utils.TimestampUtils;
+import org.apache.pinot.spi.utils.UuidUtils;
 
 
 /**
@@ -42,6 +43,7 @@ public abstract class BaseInPredicate extends BasePredicate {
   private int[] _booleanValues;
   private long[] _timestampValues;
   private ByteArray[] _bytesValues;
+  private ByteArray[] _uuidValues;
 
   public BaseInPredicate(ExpressionContext lhs, List<String> values) {
     super(lhs);
@@ -155,4 +157,17 @@ public ByteArray[] getBytesValues() {
     }
     return bigDecimalValues;
   }
+
+  public ByteArray[] getUuidValues() {
+    ByteArray[] uuidValues = _uuidValues;
+    if (uuidValues == null) {
+      int numValues = _values.size();
+      uuidValues = new ByteArray[numValues];
+      for (int i = 0; i < numValues; i++) {
+        uuidValues[i] = new ByteArray(UuidUtils.toBytes(_values.get(i)));
+      }
+      _uuidValues = uuidValues;
+    }
+    return uuidValues;
+  }
 }

pinot-common/src/main/java/org/apache/pinot/common/response/encoder/JsonResponseEncoder.java

@@ -220,6 +220,7 @@ private static Object extractValue(DataSchema.ColumnDataType columnDataType, Jso
       case DOUBLE:
         return jsonValue.asDouble();
       case STRING:
+      case UUID:
       case BYTES:
       case TIMESTAMP:
       case JSON:

pinot-common/src/main/java/org/apache/pinot/common/utils/DataSchema.java

@@ -40,6 +40,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.UUID;
 import org.apache.calcite.rel.type.RelDataType;
 import org.apache.calcite.rel.type.RelDataTypeFactory;
 import org.apache.calcite.sql.type.SqlTypeName;
@@ -50,6 +51,7 @@
 import org.apache.pinot.spi.utils.BytesUtils;
 import org.apache.pinot.spi.utils.CommonConstants.NullValuePlaceHolder;
 import org.apache.pinot.spi.utils.EqualityUtils;
+import org.apache.pinot.spi.utils.UuidUtils;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -302,6 +304,12 @@ public RelDataType toType(RelDataTypeFactory typeFactory) {
         return typeFactory.createSqlType(SqlTypeName.VARBINARY);
       }
     },
+    UUID(BYTES, NullValuePlaceHolder.INTERNAL_UUID_BYTES) {
+      @Override
+      public RelDataType toType(RelDataTypeFactory typeFactory) {
+        return typeFactory.createSqlType(SqlTypeName.UUID);
+      }
+    },
     OBJECT(null) {
       @Override
       public RelDataType toType(RelDataTypeFactory typeFactory) {
@@ -452,6 +460,8 @@ public DataType toDataType() {
           return DataType.STRING;
         case JSON:
           return DataType.JSON;
+        case UUID:
+          return DataType.UUID;
         case BYTES:
         case BYTES_ARRAY:
           return DataType.BYTES;
@@ -490,6 +500,8 @@ public Object toInternal(Object value) {
           return ((boolean) value) ? 1 : 0;
         case TIMESTAMP:
           return ((Timestamp) value).getTime();
+        case UUID:
+          return new ByteArray(UuidUtils.toBytes(value));
         case BYTES:
           return new ByteArray((byte[]) value);
         case BOOLEAN_ARRAY:
@@ -505,6 +517,9 @@ public Object toInternal(Object value) {
           if (value instanceof Timestamp) {
             return ((Timestamp) value).getTime();
           }
+          if (value instanceof UUID) {
+            return new ByteArray(UuidUtils.toBytes((UUID) value));
+          }
           if (value instanceof byte[]) {
             return new ByteArray((byte[]) value);
           }
@@ -538,6 +553,8 @@ public Object toExternal(Object value) {
           return ((int) value) == 1;
         case TIMESTAMP:
           return new Timestamp((long) value);
+        case UUID:
+          return UuidUtils.toUUID((ByteArray) value);
         case BYTES:
           return ((ByteArray) value).getBytes();
         case BOOLEAN_ARRAY:
@@ -569,6 +586,8 @@ public Serializable convert(Object value) {
           return ((int) value) == 1;
         case TIMESTAMP:
           return new Timestamp((long) value);
+        case UUID:
+          return UuidUtils.toUUID((ByteArray) value);
         case STRING:
         case JSON:
           return value.toString();
@@ -609,6 +628,8 @@ public Serializable format(Object value) {
         case TIMESTAMP:
           assert value instanceof Timestamp;
           return value.toString();
+        case UUID:
+          return formatUuid(value);
         case BYTES:
           return BytesUtils.toHexString((byte[]) value);
         case TIMESTAMP_ARRAY:
@@ -639,6 +660,8 @@ public Serializable convertAndFormat(Object value) {
           return ((int) value) == 1;
         case TIMESTAMP:
           return new Timestamp((long) value).toString();
+        case UUID:
+          return UuidUtils.toString((ByteArray) value);
         case STRING:
         case JSON:
           return value.toString();
@@ -844,6 +867,8 @@ public static ColumnDataType fromDataTypeSV(DataType dataType) {
           return STRING;
         case JSON:
           return JSON;
+        case UUID:
+          return UUID;
         case BYTES:
           return BYTES;
         case MAP:
@@ -878,6 +903,19 @@ public static ColumnDataType fromDataTypeMV(DataType dataType) {
       }
     }
 
+    private static String formatUuid(Object value) {
+      if (value instanceof UUID) {
+        return ((UUID) value).toString();
+      }
+      if (value instanceof byte[]) {
+        return UuidUtils.toString((byte[]) value);
+      }
+      if (value instanceof ByteArray) {
+        return UuidUtils.toString((ByteArray) value);
+      }
+      return UuidUtils.toString(UuidUtils.toBytes(value));
+    }
+
     public abstract RelDataType toType(RelDataTypeFactory typeFactory);
   }
 }