feat: simple app spring data jdbc

jdbc/pom.xml

@@ -51,6 +51,7 @@
                 <module>spring-flyway-app</module>
                 <module>spring-liquibase-app</module>
                 <module>shedlock</module>
+                <module>spring-data-jdbc</module>
             </modules>
         </profile>
     </profiles>

jdbc/spring-data-jdbc/pom.xml

@@ -0,0 +1,155 @@
+<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>tech.ydb.jdbc.examples</groupId>
+        <artifactId>ydb-jdbc-examples</artifactId>
+        <version>1.1.0-SNAPSHOT</version>
+    </parent>
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-dependencies</artifactId>
+                <version>3.2.1</version>
+                <scope>import</scope>
+                <type>pom</type>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+    <artifactId>spring-data-jdbc</artifactId>
+    <name>Spring Data JDBC Example</name>
+    <description>Basic example for Spring Boot JDBC</description>
+    <properties>
+        <maven.compiler.release>17</maven.compiler.release>
+        <kotlin.version>1.9.22</kotlin.version>
+        <spring.data.jdbc.ydb.version>0.9.1</spring.data.jdbc.ydb.version>
+        <spring.boot.version>3.2.1</spring.boot.version>
+        <flyway.version>10.7.1</flyway.version>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.data</groupId>
+            <artifactId>spring-data-jdbc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-autoconfigure</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.flywaydb</groupId>
+            <artifactId>flyway-core</artifactId>
+            <version>${flyway.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>tech.ydb.dialects</groupId>
+            <artifactId>flyway-ydb-dialect</artifactId>
+            <version>1.0.0-RC0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-jdbc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains.kotlin</groupId>
+            <artifactId>kotlin-reflect</artifactId>
+            <version>${kotlin.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains.kotlin</groupId>
+            <artifactId>kotlin-stdlib</artifactId>
+            <version>${kotlin.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>tech.ydb.dialects</groupId>
+            <artifactId>spring-data-jdbc-ydb</artifactId>
+            <version>${spring.data.jdbc.ydb.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>tech.ydb.jdbc</groupId>
+            <artifactId>ydb-jdbc-driver</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.github.javafaker</groupId>
+            <artifactId>javafaker</artifactId>
+            <version>1.0.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains.kotlinx</groupId>
+            <artifactId>kotlinx-coroutines-core</artifactId>
+            <version>1.7.3</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>${spring.boot.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>tech.ydb.test</groupId>
+            <artifactId>ydb-junit5-support</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <build>
+        <sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
+        <testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <configuration>
+                    <environmentVariables>
+                        <TESTCONTAINERS_REUSE_ENABLE>true</TESTCONTAINERS_REUSE_ENABLE>
+                    </environmentVariables>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <version>${spring.boot.version}</version>
+            </plugin>
+            <plugin>
+                <groupId>org.jetbrains.kotlin</groupId>
+                <artifactId>kotlin-maven-plugin</artifactId>
+                <version>${kotlin.version}</version>
+                <executions>
+                    <execution>
+                        <id>compile</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>test-compile</id>
+                        <goals>
+                            <goal>test-compile</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <args>
+                        <arg>-Xjsr305=strict</arg>
+                    </args>
+                    <compilerPlugins>
+                        <plugin>spring</plugin>
+                        <plugin>jpa</plugin>
+                    </compilerPlugins>
+                </configuration>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.jetbrains.kotlin</groupId>
+                        <artifactId>kotlin-maven-allopen</artifactId>
+                        <version>${kotlin.version}</version>
+                    </dependency>
+                    <dependency>
+                        <groupId>org.jetbrains.kotlin</groupId>
+                        <artifactId>kotlin-maven-noarg</artifactId>
+                        <version>${kotlin.version}</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
+        </plugins>
+    </build>
+</project>

jdbc/spring-data-jdbc/src/main/kotlin/tech/ydb/jdbc/simple/SimpleUserRepository.kt

@@ -0,0 +1,99 @@
+package tech.ydb.jdbc.simple
+
+import org.springframework.data.domain.Limit
+import org.springframework.data.domain.Pageable
+import org.springframework.data.domain.Slice
+import org.springframework.data.domain.Sort
+import org.springframework.data.jdbc.repository.query.Query
+import org.springframework.data.repository.ListCrudRepository
+import tech.ydb.data.repository.ViewIndex
+
+/**
+ * Simple repository interface for {@link User} instances. The interface is used to declare the so-called query methods,
+ * i.e. methods to retrieve single entities or collections of them.
+ */
+interface SimpleUserRepository : ListCrudRepository<User, Long> {
+
+    /**
+     * Uses {@link Optional} as return and parameter type.
+     *
+     * @param username
+     */
+    @ViewIndex(indexName = "username_index")
+    fun findByUsername(username: String): User?
+
+    /**
+     * Find all users with the given lastname. This method will be translated into a query by constructing it directly
+     * from the method name as there is no other query declared.
+     *
+     * @param lastname
+     */
+    fun findByLastname(lastname: String): List<User>
+
+    /**
+     * Find at most the number of users defined via maxResults with the given lastname.
+     * This method will be translated into a query by constructing it directly from the method name as there is no other
+     * query declared.
+     *
+     * @param lastname
+     * @param maxResults the maximum number of results returned.
+     */
+
+    fun findByLastname(lastname: String, maxResults: Limit): List<User>
+
+    /**
+     * Returns at most the number of users defined via {@link Limit} with the given firstname. This method will be
+     * translated into a query using the one declared in the {@link Query} annotation declared one.
+     *
+     * @param firstname
+     * @param maxResults the maximum number of results returned.
+     */
+    fun findByFirstname(firstname: String, maxResults: Limit): List<User>
+
+    /**
+     * Returns all users with the given name as first- or lastname. This makes the query to method relation much more
+     * refactoring-safe as the order of the method parameters is completely irrelevant.
+     *
+     * @param name
+     */
+    @Query("select * from Users u where u.firstname = :name or u.lastname = :name")
+    fun findByFirstnameOrLastname(name: String): List<User>
+
+    /**
+     * Returns a {@link Slice} counting a maximum number of {@link Pageable#getPageSize()} users matching given criteria
+     * starting at {@link Pageable#getOffset()} without prior count of the total number of elements available.
+     *
+     * @param lastname
+     * @param page
+     */
+    fun findByLastnameOrderByUsernameAsc(lastname: String, page: Pageable): Slice<User>
+
+    /**
+     * Return the first 2 users ordered by their lastname asc.
+     *
+     * <pre>
+     * Example for findFirstK / findTopK functionality.
+     * </pre>
+     */
+    fun findFirst2ByOrderByLastnameAsc(): List<User>
+
+    /**
+     * Return the first 2 users ordered by the given {@code sort} definition.
+     *
+     * <pre>
+     * This variant is very flexible because one can ask for the first K results when a ASC ordering
+     * is used as well as for the last K results when a DESC ordering is used.
+     * </pre>
+     *
+     * @param sort
+     */
+    fun findTop2By(sort: Sort): List<User>
+
+    /**
+     * Return all the users with the given firstname or lastname. Makes use of SpEL (Spring Expression Language).
+     *
+     * @param user
+     */
+    @Query("select * from Users u where u.firstname = :#{#user.firstname} or u.lastname = :#{#user.lastname}")
+    fun findByFirstnameOrLastname(user: User): Iterable<User>
+}

jdbc/spring-data-jdbc/src/main/kotlin/tech/ydb/jdbc/simple/User.kt

@@ -0,0 +1,53 @@
+package tech.ydb.jdbc.simple
+
+import org.springframework.data.annotation.Id
+import org.springframework.data.annotation.Transient
+import org.springframework.data.domain.Persistable
+import org.springframework.data.relational.core.mapping.Table
+import org.springframework.data.util.ProxyUtils
+import java.util.concurrent.ThreadLocalRandom
+
+@Table(name = "Users")
+class User : Persistable<Long> {
+
+    @Id
+    var id: Long = ThreadLocalRandom.current().nextLong()
+
+    lateinit var username: String
+
+    lateinit var firstname: String
+
+    lateinit var lastname: String
+
+    @Transient
+    var new = true
+
+    override fun equals(other: Any?): Boolean {
+        if (null == other) {
+            return false
+        }
+
+        if (this === other) {
+            return true
+        }
+
+        if (javaClass != ProxyUtils.getUserClass(other)) {
+            return false
+        }
+
+        val that: User = other as User
+
+        return this.id == that.id
+    }
+
+    override fun hashCode(): Int {
+        var hashCode = 17
+
+        hashCode += id.hashCode() * 31
+
+        return hashCode
+    }
+
+    override fun getId() = id
+    override fun isNew() = new
+}

jdbc/spring-data-jdbc/src/main/kotlin/tech/ydb/jdbc/simple/UserApplication.kt

@@ -0,0 +1,11 @@
+package tech.ydb.jdbc.simple
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories
+
+/**
+ * @author Kirill Kurdyukov
+ */
+@EnableJdbcRepositories
+@SpringBootApplication
+class UserApplication

jdbc/spring-data-jdbc/src/main/resources/application-ydb.properties

@@ -0,0 +1,4 @@
+spring.datasource.driver-class-name=tech.ydb.jdbc.YdbDriver
+spring.datasource.url=jdbc:ydb:grpc://localhost:2136/local
+
+logging.level.org.springframework.jdbc.core.JdbcTemplate=debug

jdbc/spring-data-jdbc/src/test/kotlin/tech/ydb/jdbc/YdbDockerTest.kt

@@ -0,0 +1,29 @@
+package tech.ydb.jdbc
+
+import org.junit.jupiter.api.extension.RegisterExtension
+import org.springframework.test.context.ActiveProfiles
+import org.springframework.test.context.DynamicPropertyRegistry
+import org.springframework.test.context.DynamicPropertySource
+import tech.ydb.test.junit5.YdbHelperExtension
+
+/**
+ * @author Kirill Kurdyukov
+ */
+@ActiveProfiles("test", "ydb")
+abstract class YdbDockerTest {
+
+    companion object {
+        @JvmField
+        @RegisterExtension
+        val ydb = YdbHelperExtension()
+
+        @JvmStatic
+        @DynamicPropertySource
+        fun propertySource(registry: DynamicPropertyRegistry) {
+            registry.add("spring.datasource.url") {
+                "jdbc:ydb:${if (ydb.useTls()) "grpcs://" else "grpc://"}" +
+                        "${ydb.endpoint()}${ydb.database()}${ydb.authToken()?.let { "?token=$it" } ?: ""}"
+            }
+        }
+    }
+}