diff --git a/README.md b/README.md index 0b61308..bcf4524 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,28 @@ -A MongoDB Dialect for the Hibernate ORM +# A MongoDB Dialect for the Hibernate ORM -## Build +This project aims to provide a library to seamlessly integrate MongoDB with Hibernate ORM. Hibernate _ORM_ is a powerful **O**bject-**r**elational **m**apping tool. Due to the SQL and JDBC standards, Hibernate ORM could centralize each SQL vendor's idiosyncrasies in the so-called _Hibernate Dialect_. This project will include a document database member in the Hibernate's Dialect family. -## IntelliJ IDEA +## Overview + +MongoDB speaks _MQL_ (**M**ongoDB **Q**uery **L**anguage in JSON format) instead of SQL. This project creates a MongoDB Hibernate Dialect by: + +- create a JDBC adapter using [MongoDB Java Driver](https://www.mongodb.com/docs/drivers/java-drivers/) +- translate Hibernate's internal SQL AST into MQL + +MongoDB Dialect + +## Development + +Java 17 is the JDK version for development. + +Initially Hibernate ORM v6.6 is the dependency version. + +### Build from source + +### Test + +## References + +- [An Introduction to Hibernate 6](https://docs.jboss.org/hibernate/orm/6.6/introduction/html_single/Hibernate_Introduction.html) +- [A Guide to Hibernate Query Language](https://docs.jboss.org/hibernate/orm/6.6/querylanguage/html_single/Hibernate_Query_Language.html) +- [Hibernate User Guide](https://docs.jboss.org/hibernate/orm/6.6/userguide/html_single/Hibernate_User_Guide.html) \ No newline at end of file diff --git a/hibernate-dialects.png b/hibernate-dialects.png new file mode 100644 index 0000000..3bc3633 Binary files /dev/null and b/hibernate-dialects.png differ