Add short names for MongoDialect/MongoConnectionProvider

XMLWordPrintableJSON

    • Type: New Feature
    • Resolution: Fixed
    • Priority: Major - P3
    • 1.0.0
    • Affects Version/s: None
    • Component/s: Configuration
    • None
    • 3
    • None
    • Needed
    • Hide

      Complexity: Simple (one config-snippet update)

      Get Started: the dialect can be configured by Hibernate short name (hibernate.dialect=MongoDB) instead of a fully-qualified class name; the dialect and jdbc packages are now internal, so update any config snippets referencing the FQCNs. (The connection provider has no short name - see HIBERNATE-171 for how it is configured/auto-inferred.)

      Show
      Complexity: Simple (one config-snippet update) Get Started: the dialect can be configured by Hibernate short name ( hibernate.dialect=MongoDB ) instead of a fully-qualified class name; the dialect and jdbc packages are now internal, so update any config snippets referencing the FQCNs. (The connection provider has no short name - see HIBERNATE-171 for how it is configured/auto-inferred.)
    • None
    • None
    • None
    • None
    • None
    • None

      See https://docs.jboss.org/hibernate/orm/6.6/integrationguide/html_single/Hibernate_Integration_Guide.html#_strategyselector for more details.

      The short names we decide on, will be part of our API, and should follow the usual Hibernate ORM conventions for such names (I wasn't able to quickly find out what they are.

      Note that there is a linked PoC for this ticket

      We should also make the com.mongodb.hibernate.dialect, com.mongodb.hibernate.jdbc packages internal, and remove the corresponding exclude statements from build.gradle.kts. This means that we will have to move the API documentation from MongoDialect, MongoConnectionProvider somewhere.

      The overview API page (see -overview at https://docs.oracle.com/en/java/javase/17/docs/specs/man/javadoc.html#standard-doclet-options) may have been the ideal place, but I was unable to make it work even when running javadoc manually. Another place is the module API documentation, which we can totally use as HIBERNATE-52 has been done.

            Assignee:
            Jeffrey Yemin
            Reporter:
            Valentin Kavalenka
            Almas Abdrazak
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: