HHH-16441 - Improve support for @batchsize

HHH-16466 - ARRAY parameter support for multi-key loads
HHH-16509 - Split parameter limit and IN element limit

Author: sebersole

README.adoc

@@ -204,3 +204,19 @@ The following table illustrates a list of commands for various databases that ca
 |`./docker_db.sh cockroachdb`
 |`./gradlew test -Pdb=cockroachdb`
 |===
+
+To stop a container started by `docker`, use the command
+
+[source]
+----
+docker stop $container_name
+----
+
+NOTE:: Substitute `podman` command for `docker` if using `podman`
+
+E.g., to stop the mariadb container
+
+[source]
+----
+docker stop mariadb
+----

hibernate-core/src/main/java/org/hibernate/dialect/DerbyDialect.java

@@ -628,6 +628,14 @@ public boolean supportsUnboundedLobLocatorMaterialization() {
 		return false;
 	}
 
+	@Override
+	public int getInExpressionCountLimit() {
+		// Derby does not have a limit on the number of expressions/parameters per-se (it may, I just
+		// don't know). It does, however, have a limit on the size of the SQL text it will accept as a
+		// PreparedStatement; so let's limit this to a sensible value to avoid that.
+		return 512;
+	}
+
 	@Override
 	public SQLExceptionConversionDelegate buildSQLExceptionConversionDelegate() {
 		return (sqlException, message, sql) -> {

hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java

@@ -108,7 +108,7 @@
 import org.hibernate.internal.util.StringHelper;
 import org.hibernate.internal.util.collections.ArrayHelper;
 import org.hibernate.internal.util.io.StreamCopier;
-import org.hibernate.loader.BatchLoadSizingStrategy;
+import org.hibernate.loader.ast.spi.MultiKeyLoadSizingStrategy;
 import org.hibernate.mapping.Column;
 import org.hibernate.mapping.Constraint;
 import org.hibernate.mapping.ForeignKey;
@@ -177,16 +177,16 @@
 import org.hibernate.type.descriptor.jdbc.ArrayJdbcType;
 import org.hibernate.type.descriptor.jdbc.BlobJdbcType;
 import org.hibernate.type.descriptor.jdbc.ClobJdbcType;
-import org.hibernate.type.descriptor.jdbc.TimeUtcAsOffsetTimeJdbcType;
-import org.hibernate.type.descriptor.jdbc.TimestampUtcAsJdbcTimestampJdbcType;
-import org.hibernate.type.descriptor.jdbc.TimestampUtcAsOffsetDateTimeJdbcType;
 import org.hibernate.type.descriptor.jdbc.JdbcLiteralFormatter;
 import org.hibernate.type.descriptor.jdbc.JdbcType;
 import org.hibernate.type.descriptor.jdbc.LongNVarcharJdbcType;
 import org.hibernate.type.descriptor.jdbc.NCharJdbcType;
 import org.hibernate.type.descriptor.jdbc.NClobJdbcType;
 import org.hibernate.type.descriptor.jdbc.NVarcharJdbcType;
 import org.hibernate.type.descriptor.jdbc.TimeUtcAsJdbcTimeJdbcType;
+import org.hibernate.type.descriptor.jdbc.TimeUtcAsOffsetTimeJdbcType;
+import org.hibernate.type.descriptor.jdbc.TimestampUtcAsJdbcTimestampJdbcType;
+import org.hibernate.type.descriptor.jdbc.TimestampUtcAsOffsetDateTimeJdbcType;
 import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry;
 import org.hibernate.type.descriptor.sql.internal.CapacityDependentDdlType;
 import org.hibernate.type.descriptor.sql.internal.DdlTypeImpl;
@@ -3774,6 +3774,18 @@ public int getInExpressionCountLimit() {
 		return 0;
 	}
 
+	/**
+	 * Return the limit that the underlying database places on the number of parameters
+	 * that can be defined for a PreparedStatement.  If the database defines no such
+	 * limits, simply return zero or a number smaller than zero.  By default, Dialect
+	 * returns the same value as {@link #getInExpressionCountLimit()}.
+	 *
+	 * @return The limit, or a non-positive integer to indicate no limit.
+	 */
+	public int getParameterCountLimit() {
+		return getInExpressionCountLimit();
+	}
+
 	/**
 	 * Must LOB values occur last in inserts and updates?
 	 *
@@ -4008,40 +4020,43 @@ public NameQualifierSupport getNameQualifierSupport() {
 		return null;
 	}
 
-	protected final BatchLoadSizingStrategy STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY =
-			(numberOfKeyColumns, numberOfKeys, inClauseParameterPaddingEnabled) -> {
-		final int paddedSize;
+	/**
+	 * The strategy used to determine the appropriate number of keys
+	 * to load in a single SQL query with multi-key loading.
+	 * @see org.hibernate.Session#byMultipleIds
+	 * @see org.hibernate.Session#byMultipleNaturalId
+	 */
+	public MultiKeyLoadSizingStrategy getMultiKeyLoadSizingStrategy() {
+		return STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY;
+	}
 
-		if ( inClauseParameterPaddingEnabled ) {
-			paddedSize = MathHelper.ceilingPowerOfTwo( numberOfKeys );
-		}
-		else {
-			paddedSize = numberOfKeys;
-		}
+	/**
+	 * The strategy used to determine the appropriate number of keys
+	 * to load in a single SQL query with batch-fetch loading.
+	 *
+	 * @implNote By default, the same as {@linkplain #getMultiKeyLoadSizingStrategy}
+	 *
+	 * @see org.hibernate.annotations.BatchSize
+	 */
+	public MultiKeyLoadSizingStrategy getBatchLoadSizingStrategy() {
+		return getMultiKeyLoadSizingStrategy();
+	}
 
-		// For tuples, there is no limit, so we can just use the power of two padding approach
-		if ( numberOfKeyColumns > 1 ) {
-			return paddedSize;
-		}
-		final int inExpressionCountLimit = getInExpressionCountLimit();
-		if ( inExpressionCountLimit > 0 ) {
-			if ( paddedSize < inExpressionCountLimit ) {
-				return paddedSize;
-			}
-			else if ( numberOfKeys < inExpressionCountLimit ) {
-				return numberOfKeys;
+	protected final MultiKeyLoadSizingStrategy STANDARD_MULTI_KEY_LOAD_SIZING_STRATEGY = (numberOfColumns, numberOfKeys, pad) -> {
+		numberOfKeys = pad ? MathHelper.ceilingPowerOfTwo( numberOfKeys ) : numberOfKeys;
+
+		final long parameterCount = (long) numberOfColumns * numberOfKeys;
+		final int limit = getParameterCountLimit();
+
+		if ( limit > 0 ) {
+			// the Dialect reported a limit -  see if the parameter count exceeds the limit
+			if ( parameterCount >= limit ) {
+				return limit / numberOfColumns;
 			}
-			return getInExpressionCountLimit();
 		}
-		return paddedSize;
-	};
 
-	/**
-	 * The strategy to use for determining batch sizes in batch loading.
-	 */
-	public BatchLoadSizingStrategy getDefaultBatchLoadSizingStrategy() {
-		return STANDARD_DEFAULT_BATCH_LOAD_SIZING_STRATEGY;
-	}
+		return numberOfKeys;
+	};
 
 	/**
 	 * Is JDBC statement warning logging enabled by default?

hibernate-core/src/main/java/org/hibernate/dialect/DialectDelegateWrapper.java

@@ -47,7 +47,7 @@
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.exception.spi.SQLExceptionConversionDelegate;
 import org.hibernate.exception.spi.ViolatedConstraintNameExtractor;
-import org.hibernate.loader.BatchLoadSizingStrategy;
+import org.hibernate.loader.ast.spi.MultiKeyLoadSizingStrategy;
 import org.hibernate.mapping.Column;
 import org.hibernate.mapping.Constraint;
 import org.hibernate.mapping.ForeignKey;
@@ -90,7 +90,6 @@
 import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry;
 import org.hibernate.type.spi.TypeConfiguration;
 
-import jakarta.persistence.GenerationType;
 import jakarta.persistence.TemporalType;
 
 /**
@@ -1155,6 +1154,11 @@ public int getInExpressionCountLimit() {
 		return wrapped.getInExpressionCountLimit();
 	}
 
+	@Override
+	public int getParameterCountLimit() {
+		return wrapped.getParameterCountLimit();
+	}
+
 	@Override
 	public boolean forceLobAsLastValue() {
 		return wrapped.forceLobAsLastValue();
@@ -1241,8 +1245,13 @@ public NameQualifierSupport getNameQualifierSupport() {
 	}
 
 	@Override
-	public BatchLoadSizingStrategy getDefaultBatchLoadSizingStrategy() {
-		return wrapped.getDefaultBatchLoadSizingStrategy();
+	public MultiKeyLoadSizingStrategy getBatchLoadSizingStrategy() {
+		return wrapped.getBatchLoadSizingStrategy();
+	}
+
+	@Override
+	public MultiKeyLoadSizingStrategy getMultiKeyLoadSizingStrategy() {
+		return wrapped.getMultiKeyLoadSizingStrategy();
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/dialect/HSQLSqlAstTranslator.java

@@ -25,6 +25,7 @@
 import org.hibernate.sql.ast.tree.expression.SqlTuple;
 import org.hibernate.sql.ast.tree.expression.Summarization;
 import org.hibernate.sql.ast.tree.predicate.BooleanExpressionPredicate;
+import org.hibernate.sql.ast.tree.predicate.InArrayPredicate;
 import org.hibernate.sql.ast.tree.select.QueryPart;
 import org.hibernate.sql.exec.spi.JdbcOperation;
 import org.hibernate.type.descriptor.jdbc.ArrayJdbcType;
@@ -57,6 +58,15 @@ public void visitBooleanExpressionPredicate(BooleanExpressionPredicate booleanEx
 		}
 	}
 
+	@Override
+	public void visitInArrayPredicate(InArrayPredicate inArrayPredicate) {
+		// column in ( unnest(?) )
+		inArrayPredicate.getTestExpression().accept( this );
+		appendSql( " in (unnest(" );
+		inArrayPredicate.getArrayParameter().accept( this );
+		appendSql( "))" );
+	}
+
 	@Override
 	protected boolean supportsArrayConstructor() {
 		return true;

hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLSqlAstTranslator.java

@@ -18,6 +18,7 @@
 import org.hibernate.sql.ast.tree.expression.Literal;
 import org.hibernate.sql.ast.tree.expression.Summarization;
 import org.hibernate.sql.ast.tree.predicate.BooleanExpressionPredicate;
+import org.hibernate.sql.ast.tree.predicate.InArrayPredicate;
 import org.hibernate.sql.ast.tree.predicate.LikePredicate;
 import org.hibernate.sql.ast.tree.predicate.NullnessPredicate;
 import org.hibernate.sql.ast.tree.select.QueryGroup;
@@ -38,6 +39,19 @@ public PostgreSQLSqlAstTranslator(SessionFactoryImplementor sessionFactory, Stat
 		super( sessionFactory, statement );
 	}
 
+	@Override
+	public void visitInArrayPredicate(InArrayPredicate inArrayPredicate) {
+		inArrayPredicate.getTestExpression().accept( this );
+		appendSql( " = any (" );
+		inArrayPredicate.getArrayParameter().accept( this );
+		appendSql( ")" );
+	}
+
+	@Override
+	protected String getArrayContainsFunction() {
+		return super.getArrayContainsFunction();
+	}
+
 	@Override
 	protected void renderInsertIntoNoColumns(TableInsertStandard tableInsert) {
 		renderIntoIntoAndTable( tableInsert );

hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java

@@ -118,7 +118,13 @@
  */
 public class SQLServerDialect extends AbstractTransactSQLDialect {
 	private final static DatabaseVersion MINIMUM_VERSION = DatabaseVersion.make( 10, 0 );
-	private static final int PARAM_LIST_SIZE_LIMIT = 2100;
+
+	/**
+	 * NOTE : 2100 is the documented limit supposedly - but in my testing, sending
+	 * 2100 parameters fails saying it must be less than 2100.
+	 */
+	private static final int PARAM_LIST_SIZE_LIMIT = 2048;
+
 	// See microsoft.sql.Types.GEOMETRY
 	private static final int GEOMETRY_TYPE_CODE = -157;
 	// See microsoft.sql.Types.GEOGRAPHY

hibernate-core/src/main/java/org/hibernate/dialect/SybaseDialect.java

@@ -74,7 +74,10 @@ public class SybaseDialect extends AbstractTransactSQLDialect {
 	private static final DatabaseVersion MINIMUM_VERSION = DatabaseVersion.make( 16, 0 );
 
 	//All Sybase dialects share an IN list size limit.
-	private static final int PARAM_LIST_SIZE_LIMIT = 250000;
+	private static final int IN_LIST_SIZE_LIMIT = 250000;
+
+	private static final int PARAM_COUNT_LIMIT = 2000;
+
 	private final UniqueDelegate uniqueDelegate = new SkipNullableUniqueDelegate(this);
 
 	public SybaseDialect() {
@@ -163,7 +166,12 @@ public boolean supportsNullPrecedence() {
 
 	@Override
 	public int getInExpressionCountLimit() {
-		return PARAM_LIST_SIZE_LIMIT;
+		return IN_LIST_SIZE_LIMIT;
+	}
+
+	@Override
+	public int getParameterCountLimit() {
+		return PARAM_COUNT_LIMIT;
 	}
 
 	@Override

hibernate-core/src/main/java/org/hibernate/engine/internal/BatchFetchQueueHelper.java

@@ -80,6 +80,17 @@ public static void removeBatchLoadableEntityKey(
 		batchFetchQueue.removeBatchLoadableEntityKey( entityKey );
 	}
 
+	/**
+	 * Remove the entity key with the specified {@code id} and {@code persister} from
+	 * the batch loadable entities {@link BatchFetchQueue}.
+	 */
+	public static void removeBatchLoadableEntityKey(
+			EntityKey entityKey,
+			SharedSessionContractImplementor session) {
+		final BatchFetchQueue batchFetchQueue = session.getPersistenceContextInternal().getBatchFetchQueue();
+		batchFetchQueue.removeBatchLoadableEntityKey( entityKey );
+	}
+
 	public static void removeBatchLoadableEntityKey(
 			Object id,
 			EntityMappingType entityMappingType,

hibernate-core/src/main/java/org/hibernate/engine/profile/internal/FetchProfileAffectee.java

@@ -0,0 +1,21 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html.
+ */
+package org.hibernate.engine.profile.internal;
+
+import org.hibernate.engine.profile.Fetch;
+
+/**
+ * Commonality between entities and collections as something that can be affected by fetch profiles.
+ *
+ * @author Steve Ebersole
+ */
+public interface FetchProfileAffectee {
+	/**
+	 * Register the profile name with the entity/collection
+	 */
+	void registerAffectingFetchProfile(String fetchProfileName, Fetch.Style fetchStyle);
+}