Поддержка YDB в Jimmer ORM

jimmer-dialect/README.md

@@ -0,0 +1,34 @@
+# YDB Dialect for Jimmer
+
+## Overview
+
+This project contains a custom Jimmer dialect
+for a simple integration between Jimmer ORM and Yandex Database (YDB).
+For more thorough integration it is recommended to use the YqlClientBuilder class 
+for a custom JSqlClient.
+
+
+### Features
+
+- Custom type mappings to utilize YDB's data types.
+- Support for YDB-specific features and functions.
+- Transaction modes and isolation levels.
+- YDB keyset pagination.
+
+## Getting Started
+
+### Requirements
+
+To use this Hibernate YDB Dialect, you'll need:
+
+- Java 17 or above.
+- Jimmer version 0.9.117
+- [YDB JDBC Driver](https://github.com/ydb-platform/ydb-jdbc-driver)
+- Access to a YDB Database instance
+
+## Usage
+
+```java
+DataSource dataSource = new DriverManagerDataSource("jdbc:ydb:grpc://localhost:2136/local");
+YqlClient yqlClient = getYqlClient(dataSource);
+```

jimmer-dialect/pom.xml

@@ -0,0 +1,111 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+         http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>jimmer.ydb</groupId>
+    <artifactId>jimmer-ydb-dialect</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <name>YDB dialect for Jimmer ORM</name>
+
+    <properties>
+        <jimmer.version>0.9.117</jimmer.version>
+        <spring.version>7.0.2</spring.version>
+        <jmh.version>1.37</jmh.version>
+        <maven.compiler.release>17</maven.compiler.release>
+    </properties>
+
+    <dependencies>
+        <!-- https://mvnrepository.com/artifact/org.babyfish.jimmer/jimmer-sql -->
+        <dependency>
+            <groupId>org.babyfish.jimmer</groupId>
+            <artifactId>jimmer-sql</artifactId>
+            <version>${jimmer.version}</version>
+        </dependency>
+        <!-- Source: https://mvnrepository.com/artifact/com.fasterxml.jackson.datatype/jackson-datatype-jsr310 -->
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>
+            <artifactId>jackson-datatype-jsr310</artifactId>
+            <version>2.21.0</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.11.4</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/tech.ydb.jdbc/ydb-jdbc-driver -->
+        <dependency>
+            <groupId>tech.ydb.jdbc</groupId>
+            <artifactId>ydb-jdbc-driver</artifactId>
+            <version>2.3.20</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-jdbc</artifactId>
+            <version>${spring.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- Source: https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>2.0.17</version>
+            <scope>compile</scope>
+        </dependency>
+        <!-- Source: https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-slf4j2-impl -->
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j2-impl</artifactId>
+            <version>2.25.3</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- Source: https://mvnrepository.com/artifact/tech.ydb.test/ydb-junit5-support -->
+        <dependency>
+            <groupId>tech.ydb.test</groupId>
+            <artifactId>ydb-junit5-support</artifactId>
+            <version>2.3.29</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- Source: https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-core -->
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-core</artifactId>
+            <version>${jmh.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <!-- Source: https://mvnrepository.com/artifact/org.openjdk.jmh/jmh-generator-annprocess -->
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-generator-annprocess</artifactId>
+            <version>${jmh.version}</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.10.1</version>
+                <configuration>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>org.babyfish.jimmer</groupId>
+                            <artifactId>jimmer-apt</artifactId>
+                            <version>${jimmer.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                    <compilerArgs>
+                        <arg>-parameters</arg>
+                    </compilerArgs>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

jimmer-dialect/src/main/java/ydb/jimmer/dialect/UuidTransactionCacheOperator.java

@@ -0,0 +1,135 @@
+package ydb.jimmer.dialect;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import org.babyfish.jimmer.jackson.ImmutableModule;
+import org.babyfish.jimmer.meta.ImmutableProp;
+import org.babyfish.jimmer.meta.ImmutableType;
+import org.babyfish.jimmer.sql.cache.TransactionCacheOperator;
+import org.babyfish.jimmer.sql.cache.UsedCache;
+import org.babyfish.jimmer.sql.exception.ExecutionException;
+
+import java.sql.PreparedStatement;
+import java.sql.SQLException;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.UUID;
+
+/**
+ * Uses UUID for the ids in the {@link #TABLE_NAME} SQL table.
+ */
+public class UuidTransactionCacheOperator extends TransactionCacheOperator {
+    public static final String TABLE_NAME = "JIMMER_TRANS_CACHE_OPERATOR";
+
+    private static final String ID = "ID";
+
+    private static final String IMMUTABLE_TYPE = "IMMUTABLE_TYPE";
+
+    private static final String IMMUTABLE_PROP = "IMMUTABLE_PROP";
+
+    private static final String CACHE_KEY = "CACHE_KEY";
+
+    private static final String REASON = "REASON";
+
+    private static final String INSERT_WITH_UUID =
+            "insert into " +
+                    TABLE_NAME + "(" +
+                    ID +
+                    ", " +
+                    IMMUTABLE_TYPE +
+                    ", " +
+                    IMMUTABLE_PROP +
+                    ", " +
+                    CACHE_KEY +
+                    ", " +
+                    REASON +
+                    ") values(?, ?, ?, ?, ?)";
+
+    private final ObjectMapper mapper;
+
+    private final int batchSize;
+
+    public UuidTransactionCacheOperator() {
+        this(null, 32);
+    }
+
+    public UuidTransactionCacheOperator(int batchSize) {
+        this(null, batchSize);
+    }
+
+    public UuidTransactionCacheOperator(ObjectMapper mapper) {
+        this(mapper, 32);
+    }
+
+    public UuidTransactionCacheOperator(ObjectMapper mapper, int batchSize) {
+        super(mapper, batchSize);
+
+        if (batchSize < 1) {
+            throw new IllegalArgumentException("`batchSize` cannot be less than 1");
+        }
+        this.mapper = mapper != null ?
+                mapper :
+                new ObjectMapper()
+                        .registerModule(new JavaTimeModule())
+                        .registerModule(new ImmutableModule());
+        this.batchSize = batchSize;
+    }
+
+    @Override
+    public void delete(UsedCache<Object, ?> cache, Object key, Object reason) {
+        if (reason != null && !(reason instanceof String)) {
+            throw new IllegalArgumentException(
+                    "The cache deletion reason can only be null or string when trigger type is `TRANSACTION_ONLY`"
+            );
+        }
+        save(cache.type(), cache.prop(), Collections.singleton(key), (String) reason);
+    }
+
+    @Override
+    public void deleteAll(UsedCache<Object, ?> cache, Collection<Object> keys, Object reason) {
+        if (keys.isEmpty()) {
+            return;
+        }
+        if (reason != null && !(reason instanceof String)) {
+            throw new IllegalArgumentException(
+                    "The cache deletion reason can only be null or string when trigger type is `TRANSACTION_ONLY`"
+            );
+        }
+        save(cache.type(), cache.prop(), keys, (String) reason);
+    }
+
+    private void save(
+            ImmutableType type,
+            ImmutableProp prop,
+            Collection<Object> keys,
+            String reason
+    ) {
+        sqlClient().getConnectionManager().execute(con -> {
+            try {
+                try (PreparedStatement stmt = con.prepareStatement(INSERT_WITH_UUID)) {
+                    int count = 0;
+                    for (Object key : keys) {
+                        stmt.setString(1, UUID.randomUUID().toString());
+                        stmt.setString(2, type != null ? type.toString() : null);
+                        stmt.setString(3, prop != null ? prop.toString() : null);
+                        stmt.setString(4, mapper.writeValueAsString(key));
+                        stmt.setString(5, reason);
+                        stmt.addBatch();
+
+                        if (++count % batchSize == 0) {
+                            stmt.executeBatch();
+                        }
+                    }
+
+                    if (count % batchSize != 0) {
+                        stmt.executeBatch();
+                    }
+                }
+            } catch (SQLException | JsonProcessingException ex) {
+                throw new ExecutionException("Failed to save delayed cache deletion", ex);
+            }
+            return null;
+        });
+    }
+}