ydb-platform / ydb-java-dialects

The official YDB Dialects for Java ORM frameworks and migration tools.

YDB Dialects for Java ORM frameworks and migration tools

This repository contains dialects required for using Java-based Object-Relational Mapper (ORM) frameworks and popular migration tools for Yandex Database (YDB). It allows Java applications to interact with YDB using popular ORM libraries such as Hibernate, Spring Data, and JOOQ, as well as migration tools like Flyway and Liquibase.

Supports ORM Frameworks

• Hibernate 5: Hibernate Dialect for YDB, for earlier versions (5.*). Designed to use YDB features while providing a familiar experience for Hibernate users. For more information, please visit the appropriate module.
• Hibernate 6+: Hibernate Dialect for YDB is designed to leverage features of YDB while providing a familiar experience to Hibernate users. For more information, please visit the appropriate module.
• JOOQ: Small JOOQ dialect is designed to be used for code generation For more information, please visit the appropriate module.

Supports migration tools

• Liquibase: For more information, please visit the module.
• Flyway: For more information, please visit the module.

Each module is developed independently, and the release process is separate from the others.

Each module has its own README.md file, which describes the integration process and various limitations, as well as CHANGELOG.md, which describes the releases.

Connect to YDB

• Local or remote Docker (anonymous authentication):
  jdbc:ydb:grpc://localhost:2136/local
• Self-hosted cluster:
  jdbc:ydb:grpcs://<host>:2135/Root/testdb?secureConnectionCertificate=file:~/myca.cer
• Connect with token to the cloud instance:
  jdbc:ydb:grpcs://<host>:2135/path/to/database?token=file:~/my_token
• Connect with service account to the cloud instance:
  jdbc:ydb:grpcs://<host>:2135/path/to/database?saFile=file:~/sa_key.json

Contributing

We welcome contributions from the community. Please see our contributing guidelines before making a pull request.

License

This repository is licensed under the Apache 2.0 License.

Support

For any questions or issues with the ORM Java Dialects for YDB, please open an issue on the GitHub issue tracker.

Enjoy using ORM Java Dialects with YDB!

ydb-java-dialects's Issues

Integration tests of the main functionality

feat: update ci action, added check spring-data-jpa integration

feat: Flyway Dialect

flyway

Roadmap to 1.0.0 version

• #70
• #72
• #106
• #107
• #112
• Test distributed lock
• #113
• #115
• #117
• ydb-platform/ydb-java-examples#31
• #119

feat: Liquibase dialect README.md

feat: liquibase integration tests

feat: [Liquibase] stress test liquibase update in concurrency execution

feat: hibernate-[v6 / v5]: full testing dialect

1. create schema
2. validate schema
3. CRUD
4. Support @ManyToMany, @ManyToOne, @OneToMany, @OneToOne
5. current_timestamp() ...

feat: ci for modules hibernate-dialect [v5, v6]

[BUG]: Hibernate 5 / 6 don't support LocalDateTime

fix type format in changeset `insert` or `loadData` from CSV files

Implement distributed locking via a Flyaway log table.

Github Actions CI and Publish

feat: [Liquibase]: Support an unsigned integer

feat: liquibase CI Maven tests & release.

feat:hibernate-v5: ORDER BY ?

feat: [Hibernate 5 / 6] support json / jsonDocument type

• JsonDocument
• Json
• Interval
• Uint8, Uint16, Uint32, Uint64

[BUG]: exclusion org.slf4j:slf4j-simple from liquibase-ydb-dialect

feat: Liquibase release 1.0.0 - production version

• #96
• Insert changeset using CAST .. AS
• #94
• #99
• #73
• #103
• #104

dev: [Spring Data JDBC] Integration tests

feat:hibernate-v6: support LIMIT ? OFFSET ?

Support LIMIT ? ( OFFSET ? )

Maybe use LimitOffsetLimitHandler.INSTANCE for override LimitHandler getLimitHandler()

dev: [Spring Data JDBC] README.md

dev: liquibase dialect documentation en / ru in ydb.tech

feat: liquibase support generate-changelog

Prepare README: Add auth info

feat: InsertGenerator support all types

feat: Liquibase support loadUpdateDate & loadData

• Support InsertOrUpdateSqlStatement
• loadUpdateDate & loadData with YDB Types

dev: [Spring Data JDBC] Github action to run tests in a module

[BUG]: Fix NullPointerException from csv file

Stress test `liquibase update` in CI

feat: Kotlin Exposed YDB Dialect

Useful links:

1. JetBrains ORM Framework Exposed
2. YDB JDBC Driver using 2.0.5
3. YDB Types - https://ydb.tech/docs/en/yql/reference/types

Preparation:

brew docker install
brew install colima

sudo ln -sf  ~/.colima/docker.sock /var/run/docker.sock

Roadmap:

1. Fork this repository
2. module name is kotlin-exposed-dialect, artifactId is kotlin-exposed-ydb-dialect, groupId tech.ydb.dialects
3. Example Database dialect - https://github.com/JetBrains/Exposed/blob/main/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/vendors/OracleDialect.kt
4. package maybe create tech.ydb.exposed.sql.
5. Register dialect TransactionManager.registerDialect("mydialect")
6. override org.jetbrains.exposed.sql.vendors.DataTypeProvider.kt
7. Full integration tests.
8. README.md
9. Integration test example - hibernate-dialect.

feat: Spring Data JDBC Dialect

feat: support hibernate dialect v6

1. Create a new Java class that will implement YDB Hibernate dialect. Extend org.hibernate.dialect.Dialect for YQL
2. Override methods - change the usage of SQL functions, phrases, data types, and other YDB details.
3. Test the custom dialect
4. Usage example, README.md

Support clean and baseline command

Scan select * from DATABASECHANGELOG table

dev: add a description to the README file for auth with the database server using Hibernate

feat:hibernate-v5: support LIMIT ? OFFSET ?

dev: Added README.md, NOTICE.md, CODE_OF_CONDUCT.md

dev: hibernate doc en / ru in ydb.tech

feat: [Liquibase] support CAST .. AS YdbType in insert changeset

Spring Boot example with Liquibase

feat: Liquibase Dialect

https://contribute.liquibase.com/code/

• Initial module liquibase + started develop (create YdbDatabase.java + CreateIndexGeneratorYdb.java) #32
• CreateTable sql generator #33
• Support StandardLockService (may be use coordination service in future) #36
• Support YDB Types (e.g CHAR change to Text, integer change to Int32) #34
• SqlGenerators (for all SqlStatements from liquibase-core) to be implemented: #37

1. YDB doesn't support AddAutoIncrementStatement. - SOLVED [AddAutoIncrementGenerator - database.supportsAutoIncrement() return false]
2. YDB doesn't support AddCheckConstraintStatement. - SOLVED [supports(AddCheckConstraintStatement var1, Database var2) return false]
3. YDB supports AddColumnStatement. - AddColumnGeneratorYdb.class with custom validation - SOLVED
4. YDB doesn't support AddDefaultValueStatement. SOLVED [throw validationError]
5. YDB doesn't support AddForeignKeyConstraintStatement. SOLVED [throw validationError]
6. YDB doesn't support AddPrimaryKeyStatement. SOLVED [throw validationError]
7. YDB doesn't support AddUniqueConstraintStatement. SOLVED [throw validationError]
8. YDB doesn't support AlterSequenceStatement. SOLVED [ydbDatabase.supportsSequences() == false <--> ok]
9. Dummy SQL generator for BatchDmlExecutablePreparedStatement provided by liquibase-core. OK
10. ClearDatabaseChangeLogTableStatement. - OK [DELETE FROM TABLE - valid YQL]
11. CommentStatement. - OK [-- comment - valid YQL]
12. CopyRowsStatement - OK [INSERT INTO TABLE(A, B) SELECT A, B FROM A - valid YQL]
13. CreateIndexGenerator - SOLVED (create YdbDatabase.java + CreateIndexGeneratorYdb.java) #32
14. CreateSequenceStatement - OK [ydbDatabase.supportsSequences() == false <--> ok]
15. YDB doesn't support CreateProcedureStatement - SOLVED [throw validationError]
16. DeleteStatement - OK [DELET FROM TABLE WHERE A = 1 - valid YQL]
17. DropIndexStatement - SOLVED [DropIndexGeneratorYdb]
18. RenameTableStatement - SOLVED [RenameTableGeneratorYdb]
19. YDB doesn't support RenameColumnStatement brrrr. - SOLVED [throw validationError]
20. YDB doesn't support DropPrimaryKeyStatement. - [throw validationError]
21. YDB doesn't support GetViewDefinitionStatement. - [throw validationError]

• #39
• #45
• #49
• #50

dev: [Spring Data JDBC] Github action for publish to maven repository

feat: added README.md for hibernate dialects

Integration test + impl YdbJdbcTemplate for custom preparedStatement

feat: hibernate-dialect: Spring Data JPA integration example

feat: Contribute Liquibase YdbDatabase to liquibase-core

dev: [Spring Data JDBC] Dialect implementation and support

Initial flyway-dialect module

feat: support hibernate dialect v5

1. Create a new Java class that will implement YDB Hibernate dialect. Extend org.hibernate.dialect.Dialect for YQL
2. Override methods - change the usage of SQL functions, phrases, data types, and other YDB details.
3. Test the custom dialect
4. Usage example, README.md

feat: [Spring Data JDBC] init commit, add necessary dependencies