Implement UUIDv7 value generator (#28)

Author: nscuro

.checkstyle/header

@@ -1,5 +1,5 @@
 /*
- * This file is part of versatile.
+ * This file is part of datanucleus-postgresql.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

plugin/pom.xml

@@ -24,6 +24,11 @@
             <artifactId>datanucleus-rdbms</artifactId>
             <scope>provided</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.uuid</groupId>
+            <artifactId>java-uuid-generator</artifactId>
+        </dependency>
     </dependencies>
 
     <build>

plugin/src/main/java/io/github/nscuro/datanucleus/postgresql/method/AbstractJsonbMethod.java

@@ -1,5 +1,5 @@
 /*
- * This file is part of versatile.
+ * This file is part of datanucleus-postgresql.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

plugin/src/main/java/io/github/nscuro/datanucleus/postgresql/method/JsonbContainsMethod.java

@@ -1,5 +1,5 @@
 /*
- * This file is part of versatile.
+ * This file is part of datanucleus-postgresql.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

plugin/src/main/java/io/github/nscuro/datanucleus/postgresql/method/Operators.java

@@ -1,5 +1,5 @@
 /*
- * This file is part of versatile.
+ * This file is part of datanucleus-postgresql.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

plugin/src/main/java/io/github/nscuro/datanucleus/postgresql/valuegenerator/UUIDv7Generator.java

@@ -0,0 +1,48 @@
+/*
+ * This file is part of datanucleus-postgresql.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright (c) Niklas Düster. All Rights Reserved.
+ */
+package io.github.nscuro.datanucleus.postgresql.valuegenerator;
+
+import com.fasterxml.uuid.Generators;
+import com.fasterxml.uuid.impl.TimeBasedEpochRandomGenerator;
+import org.datanucleus.store.StoreManager;
+import org.datanucleus.store.valuegenerator.AbstractGenerator;
+import org.datanucleus.store.valuegenerator.ValueGenerationBlock;
+
+import java.util.Properties;
+
+public class UUIDv7Generator extends AbstractGenerator<String> {
+
+    private final TimeBasedEpochRandomGenerator generator;
+
+    public UUIDv7Generator(final StoreManager storeMgr, final String name, final Properties ignored) {
+        super(storeMgr, name);
+        this.generator = Generators.timeBasedEpochRandomGenerator();
+    }
+
+    @Override
+    protected ValueGenerationBlock<String> reserveBlock(final long size) {
+        final var ids = new String[(int) size];
+        for (int i = 0; i < size; i++) {
+            ids[i] = generator.generate().toString();
+        }
+
+        return new ValueGenerationBlock<>(ids);
+    }
+
+}

plugin/src/main/resources/plugin.xml

@@ -3,4 +3,8 @@
     <extension point="org.datanucleus.store.rdbms.sql_method">
         <sql-method class="java.lang.String" method="jsonbContains" evaluator="io.github.nscuro.datanucleus.postgresql.method.JsonbContainsMethod"/>
     </extension>
+
+    <extension point="org.datanucleus.store_valuegenerator">
+        <valuegenerator name="uuid-v7" class-name="io.github.nscuro.datanucleus.postgresql.valuegenerator.UUIDv7Generator" datastore="rdbms"/>
+    </extension>
 </plugin>

pom.xml

@@ -69,6 +69,7 @@
         <lib.datanucleus-core.version>6.0.9</lib.datanucleus-core.version>
         <lib.datanucleus-javax-jdo.version>3.2.1</lib.datanucleus-javax-jdo.version>
         <lib.datanucleus-rdbms.version>6.0.9</lib.datanucleus-rdbms.version>
+        <lib.java-uuid-generator.version>5.1.0</lib.java-uuid-generator.version>
         <lib.junit-jupiter.version>5.11.3</lib.junit-jupiter.version>
         <lib.postgresql.version>42.7.4</lib.postgresql.version>
         <lib.slf4j.version>2.0.16</lib.slf4j.version>
@@ -108,6 +109,12 @@
                 <version>${lib.datanucleus-javax-jdo.version}</version>
             </dependency>
 
+            <dependency>
+                <groupId>com.fasterxml.uuid</groupId>
+                <artifactId>java-uuid-generator</artifactId>
+                <version>${lib.java-uuid-generator.version}</version>
+            </dependency>
+
             <dependency>
                 <groupId>org.postgresql</groupId>
                 <artifactId>postgresql</artifactId>

test/src/main/java/io/github/nscuro/datanucleus/postgresql/test/model/Person.java

@@ -1,5 +1,5 @@
 /*
- * This file is part of versatile.
+ * This file is part of datanucleus-postgresql.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 import javax.jdo.annotations.PersistenceCapable;
 import javax.jdo.annotations.Persistent;
 import javax.jdo.annotations.PrimaryKey;
+import java.util.UUID;
 
 @PersistenceCapable
 public class Person {
@@ -42,6 +43,9 @@ public class Person {
     })
     private String properties;
 
+    @Persistent(customValueStrategy = "uuid-v7")
+    private UUID uuid;
+
     public long getId() {
         return id;
     }
@@ -66,4 +70,12 @@ public void setProperties(final String properties) {
         this.properties = properties;
     }
 
+    public UUID getUuid() {
+        return uuid;
+    }
+
+    public void setUuid(final UUID uuid) {
+        this.uuid = uuid;
+    }
+
 }

test/src/main/resources/schema.sql

@@ -2,4 +2,5 @@ create table if not exists "PERSON" (
   "ID" int primary key generated always as identity
 , "NAME" text
 , "PROPERTIES" jsonb
+, "UUID" TEXT
 );