Merge remote-tracking branch 'upstream/main' into main-perf

Author: theigl

.github/dependabot.yml

@@ -14,3 +14,7 @@ updates:
       - gradle-plugin-portal
     schedule:
       interval: "weekly"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily

.github/workflows/contributor-build.yml

@@ -51,7 +51,7 @@ jobs:
 # Running with HANA requires at least 8GB memory just for the database, which we don't have on GH Actions runners
 #          - rdbms: hana
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           persist-credentials: false
       - name: Reclaim Disk Space
@@ -61,7 +61,7 @@ jobs:
           RDBMS: ${{ matrix.rdbms }}
         run: ci/database-start.sh
       - name: Set up Java 11
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
           java-version: '11'
@@ -70,7 +70,7 @@ jobs:
         run: echo "yearmonth=$(/bin/date -u "+%Y-%m")" >> $GITHUB_OUTPUT
         shell: bash
       - name: Cache Maven local repository
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         id: cache-maven
         with:
           path: |
@@ -85,7 +85,7 @@ jobs:
         run: ./ci/build-github.sh
         shell: bash
       - name: Upload test reports (if Gradle failed)
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: test-reports-java11-${{ matrix.rdbms }}

ci/jpa-3.1-tck.Jenkinsfile

@@ -21,8 +21,8 @@ pipeline {
     }
     parameters {
         choice(name: 'IMAGE_JDK', choices: ['jdk11'], description: 'The JDK base image version to use for the TCK image.')
-        string(name: 'TCK_VERSION', defaultValue: '3.1.1', description: 'The version of the Jakarta JPA TCK i.e. `2.2.0` or `3.0.1`')
-        string(name: 'TCK_SHA', defaultValue: 'b954b39440b331eb4584187d2d8245f82c4d2aa8b02d2e04bd42498a5751312b', description: 'The SHA256 of the Jakarta JPA TCK that is distributed under https://download.eclipse.org/jakartaee/persistence/3.1/jakarta-persistence-tck-${TCK_VERSION}.zip.sha256')
+        string(name: 'TCK_VERSION', defaultValue: '3.1.2', description: 'The version of the Jakarta JPA TCK i.e. `2.2.0` or `3.0.1`')
+        string(name: 'TCK_SHA', defaultValue: '618a9fcdb0f897cda71227ed57d035ae1dc40fc392318809a734ffc6968e43ff', description: 'The SHA256 of the Jakarta JPA TCK that is distributed under https://download.eclipse.org/jakartaee/persistence/3.1/jakarta-persistence-tck-${TCK_VERSION}.zip.sha256')
         booleanParam(name: 'NO_SLEEP', defaultValue: true, description: 'Whether the NO_SLEEP patch should be applied to speed up the TCK execution')
 	}
     stages {

design/doc-query-expressions.adoc

@@ -31,7 +31,7 @@ Assuming bi-directionality, we have 2 `Association` refs:
 
 
 
-There is a single ForeignKeyDescriptor instance for this FK in our metamodel, with 2 Sides:
+There is a single `ForeignKeyDescriptor` instance for this FK in our metamodel, with 2 Sides:
 
 ```
 ForeignKeyDescriptor (

design/doc-temporal.adoc

@@ -30,10 +30,11 @@ The actual tree nodes are defined in the `org.hibernate.sql.ast.tree` package.
 
 == Building SQL AST
 
-There are 2 main producers of SQL AST atm:
+There are 3 main producers of SQL AST:
 
-* SQM translation - see `org.hibernate.query.sqm.sql`
-* metamodel-based loading - see `org.hibernate.loader.internal.MetamodelSelectBuilderProcess`
+SQM:: Translation of HQL and criteria queries. See `org.hibernate.query.sqm.sql`
+Loading:: SQL generated for persistence-context events to load entities and collections.  This includes `Session#find`, `Session#get`, `Session#lock`, ...  See `org.hibernate.loader.internal.MetamodelSelectBuilderProcess`
+Mutations:: SQL generated for persistence-context flush events to write entity and collection state to the database.  See `org.hibernate.persister.entity.mutation` and `org.hibernate.persister.collection.mutation`
 
 
 == Translating SQL AST

design/working/fk.adoc renamed to design/fk.adoc

@@ -37,7 +37,7 @@ from the removal of deprecated stuff.  There are a few one-off changes that brea
 source compatibility; these are covered in the link:{migration-guide-url}[migration guide].
 
 One specific change to note is that many of these contracts have been better defined with type
-parameters.  Theses were inconsistently and sometimes poorly defined in previous versions.
+parameters.  Theses were inconsistently (and sometimes poorly) defined in previous versions.
 
 Quite a few SPI contracts have changed to support many of the topics discussed here as well as in
 the link:{migration-guide-url}[migration guide].  Many will also be the subject of the mentioned
@@ -267,4 +267,4 @@ For additional details, see:
 - the link:{migration-guide-url}[Migration Guide]
 - the https://hibernate.org/orm/releases/6.0/[release page].
 
-To get in touch, use the usual channels as discussed on the https://hibernate.org/community/[website].
+To get in touch, use the usual channels as discussed on the https://hibernate.org/community/[website].

design/sql-ast.adoc

@@ -769,6 +769,33 @@ EOF
 
 }
 
+tidb() {
+  tidb_5_1
+}
+
+tidb_5_1() {
+    $CONTAINER_CLI rm -f tidb || true
+    $CONTAINER_CLI run --name tidb -p4000:4000 -d docker.io/pingcap/tidb:v5.1.4
+    # Give the container some time to start
+    OUTPUT=
+    n=0
+    until [ "$n" -ge 5 ]
+    do
+        OUTPUT=$($CONTAINER_CLI logs tidb 2>&1)
+        if [[ $OUTPUT == *"server is running"* ]]; then
+          break;
+        fi
+        n=$((n+1))
+        echo "Waiting for TiDB to start..."
+        sleep 3
+    done
+    if [ "$n" -ge 5 ]; then
+      echo "TiDB failed to start and configure after 15 seconds"
+    else
+      echo "TiDB successfully started"
+    fi
+}
+
 if [ -z ${1} ]; then
     echo "No db name provided"
     echo "Provide one of:"
@@ -804,6 +831,8 @@ if [ -z ${1} ]; then
     echo -e "\tpostgresql_10"
     echo -e "\tpostgresql_9_5"
     echo -e "\tsybase"
+    echo -e "\ttidb"
+    echo -e "\ttidb_5_1"
 else
     ${1}
 fi

design/working/6.0-posts.adoc

@@ -105,7 +105,6 @@ asciidoctorj {
 	options logDocuments: true
 }
 
-
 // Topical Guides ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 task renderTopicalGuides(type: AsciidoctorTask, group: 'Documentation') {task->
@@ -160,6 +159,10 @@ task renderUserGuide(type: AsciidoctorTask, group: 'Documentation') {task->
 	tasks.buildDocs.dependsOn task
 	tasks.buildDocsForPublishing.dependsOn task
 
+	dependsOn ':hibernate-core:collectConfigProperties'
+	dependsOn ':hibernate-envers:collectConfigProperties'
+	dependsOn ':hibernate-jcache:collectConfigProperties'
+
     sourceDir = file( 'src/main/asciidoc/userguide' )
     sources {
         include 'Hibernate_User_Guide.adoc'

docker_db.sh

@@ -0,0 +1,5 @@
+== List of all available configuration properties
+
+include::../../../../target/config-properties/hibernate-core.asciidoc[opts=optional]
+include::../../../../target/config-properties/hibernate-envers.asciidoc[opts=optional]
+include::../../../../target/config-properties/hibernate-jcache.asciidoc[opts=optional]

documentation/documentation.gradle

@@ -3,6 +3,8 @@ Vlad Mihalcea, Steve Ebersole, Andrea Boriero, Gunnar Morling, Gail Badner, Chri
 :toc2:
 :toclevels: 3
 :sectanchors:
+:root-project-dir: ../../../../../../..
+
 
 include::Preface.adoc[]
 
@@ -42,5 +44,6 @@ include::appendices/Legacy_DomainModel.adoc[]
 include::appendices/LegacyBasicTypeResolution.adoc[]
 include::appendices/Legacy_Native_Queries.adoc[]
 
+include::ConfigPropertyList.adoc[]
 include::Bibliography.adoc[]
 

documentation/src/main/asciidoc/userguide/ConfigPropertyList.adoc

@@ -1184,6 +1184,13 @@ The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibern
 
 See the <<chapters/domain/embeddables.adoc#embeddable-Parent,`@Parent` mapping>> section for more info.
 
+[[annotations-hibernate-partition-key]]
+==== `@PartitionKey`
+
+The https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/annotations/PartitionKey.html[`@PartitionKey`] annotation is used to identify a field of an entity that holds the partition key of a table.
+
+See the <<chapters/domain/embeddables.adoc#embeddable-Parent,`@PartitionKey` mapping>> section for more info.
+
 [[annotations-hibernate-persister]]
 ==== `@Persister`
 

documentation/src/main/asciidoc/userguide/Hibernate_User_Guide.adoc

@@ -270,13 +270,23 @@ Assuming `hibernate.globally_quoted_identifiers` is `true`, this allows the glob
 Specifies whether to automatically quote any names that are deemed keywords.
 
 ==== Time zone storage
-`*hibernate.timezone.default_storage*` (e.g. `COLUMN`, `NATIVE`, `AUTO` or `NORMALIZE` (default value))::
+`*hibernate.timezone.default_storage*` (e.g. `COLUMN`, `NATIVE`, `NORMALIZE`, `NORMALIZE_UTC`, `AUTO` or `DEFAULT` (default value))::
 Global setting for configuring the default storage for the time zone information for time zone based types.
 +
-`NORMALIZE`::: Does not store the time zone information, and instead normalizes timestamps to UTC
-`COLUMN`::: Stores the time zone information in a separate column; works in conjunction with `@TimeZoneColumn`
-`NATIVE`::: Stores the time zone information by using the `with time zone` type. Error if `Dialect#getTimeZoneSupport()` is not `NATIVE`
+`NORMALIZE`:::
+Legacy behavior (Hibernate ORM 5).
++
+Does not store the time zone information, and instead:
++
+* when persisting to the database, normalizes JDBC timestamps to the
+<<jdbc-time-zone,JDBC timezone>> or to the JVM default time zone if not set.
+* when reading back from the database, sets the offset or zone
+of `OffsetDateTime`/`ZonedDateTime` values to the JVM default time zone.
+`NORMALIZE_UTC`::: Does not store the time zone information, and instead normalizes timestamps to UTC.
+`COLUMN`::: Stores the time zone information in a separate column; works in conjunction with `@TimeZoneColumn`.
+`NATIVE`::: Stores the time zone information by using the `with time zone` type. Error if `Dialect#getTimeZoneSupport()` is not `NATIVE`.
 `AUTO`::: Stores the time zone information either with `NATIVE` if `Dialect#getTimeZoneSupport()` is `NATIVE`, otherwise uses the `COLUMN` strategy.
+`DEFAULT`::: Stores the time zone information either with `NATIVE` if `Dialect#getTimeZoneSupport()` is `NATIVE`, otherwise uses the `NORMALIZE_UTC` strategy.
 +
 The default value is given by the {@link org.hibernate.annotations.TimeZoneStorageType#NORMALIZE},
 meaning that time zone information is not stored by default, but timestamps are normalized instead.
@@ -374,7 +384,9 @@ Enable nationalized character support on all string / clob based attribute ( str
 `*hibernate.jdbc.lob.non_contextual_creation*` (e.g. `true` or `false` (default value))::
 Should we not use contextual LOB creation (aka based on `java.sql.Connection#createBlob()` et al)? The default value for HANA, H2, and PostgreSQL is `true`.
 
-`*hibernate.jdbc.time_zone*` (e.g. A `java.util.TimeZone`, a `java.time.ZoneId` or a `String` representation of a `ZoneId`)::
+[[jdbc-time-zone]]`*hibernate.jdbc.time_zone*` (e.g. A `java.util.TimeZone`, a `java.time.ZoneId` or a `String` representation of a `ZoneId`)::
+The timezone to use in the JDBC driver, which is supposed to match the database timezone.
++
 Unless specified, the JDBC Driver uses the default JVM time zone. If a different time zone is configured via this setting, the JDBC https://docs.oracle.com/javase/8/docs/api/java/sql/PreparedStatement.html#setTimestamp-int-java.sql.Timestamp-java.util.Calendar-[PreparedStatement#setTimestamp] is going to use a `Calendar` instance according to the specified time zone.
 
 `*hibernate.dialect.oracle.prefer_long_raw*` (e.g. `true` or `false` (default value))::
@@ -790,10 +802,7 @@ The default behavior is to allow access unless the `Session` is bootstrapped via
 [[configurations-multi-tenancy]]
 === Multi-tenancy settings
 
-`*hibernate.multiTenancy*` (e.g. `NONE` (default value), `SCHEMA`, `DATABASE`, and `DISCRIMINATOR` (not implemented yet))::
-The multi-tenancy strategy in use.
-
-`*hibernate.multi_tenant_connection_provider*` (e.g. `true` or `false` (default value))::
+`*hibernate.multi_tenant_connection_provider*`::
 Names a https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/engine/jdbc/connections/spi/MultiTenantConnectionProvider.html[`MultiTenantConnectionProvider`] implementation to use. As `MultiTenantConnectionProvider` is also a service, can be configured directly through the https://docs.jboss.org/hibernate/orm/{majorMinorVersion}/javadocs/org/hibernate/boot/registry/StandardServiceRegistryBuilder.html[`StandardServiceRegistryBuilder`].
 
 `*hibernate.tenant_identifier_resolver*`::