introduce @DefaultSchema

to allow setting the schema at the package or outer class level

Author: gavinking

hibernate-core/src/main/java/org/hibernate/annotations/DefaultSchema.java

@@ -0,0 +1,46 @@
+/*
+ * 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.annotations;
+
+import org.hibernate.Incubating;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.PACKAGE;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Specifies a default schema for all table mappings occurring within
+ * the scope of the annotated package or type, overriding the effect of
+ * {@value org.hibernate.cfg.AvailableSettings#DEFAULT_SCHEMA} and/or
+ * {@value org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG} if
+ * either of these configuration properties is specified.
+ * <p>
+ * The default schema specified by this annotation is ignored if a
+ * table mapping explicitly specifies a
+ * {@linkplain jakarta.persistence.Table#schema() schema} or
+ * {@linkplain jakarta.persistence.Table#catalog() catalog}.
+ *
+ * @author Gavin King
+ */
+@Incubating
+@Target({TYPE,PACKAGE})
+@Retention(RUNTIME)
+public @interface DefaultSchema {
+	/**
+	 * A schema to use when no schema is explicitly specified using
+	 * {@link jakarta.persistence.Table#schema()}.
+	 */
+	String schema() default "";
+	/**
+	 * A catalog to use when no schema is explicitly specified using
+	 * {@link jakarta.persistence.Table#catalog()}.
+	 */
+	String catalog() default "";
+}

hibernate-core/src/main/java/org/hibernate/cfg/AnnotationBinder.java

@@ -40,6 +40,7 @@
 import org.hibernate.annotations.Columns;
 import org.hibernate.annotations.Comment;
 import org.hibernate.annotations.DialectOverride.OverridesAnnotation;
+import org.hibernate.annotations.DefaultSchema;
 import org.hibernate.annotations.DiscriminatorFormula;
 import org.hibernate.annotations.DiscriminatorOptions;
 import org.hibernate.annotations.EmbeddableInstantiatorRegistration;
@@ -595,9 +596,9 @@ public static void bindClass(
 		bindQueries( clazzToProcess, context );
 		bindFilterDefs( clazzToProcess, context );
 
-		String schema = "";
-		String table = ""; //might be no @Table annotation on the annotated class
-		String catalog = "";
+		String schema;
+		String catalog;
+		String table;
 		List<UniqueConstraintHolder> uniqueConstraints = new ArrayList<>();
 		jakarta.persistence.Table tabAnn = null;
 		if ( clazzToProcess.isAnnotationPresent( jakarta.persistence.Table.class ) ) {
@@ -607,6 +608,19 @@ public static void bindClass(
 			catalog = tabAnn.catalog();
 			uniqueConstraints = TableBinder.buildUniqueConstraintHolders( tabAnn.uniqueConstraints() );
 		}
+		else {
+			//might be no @Table annotation on the annotated class
+			schema = "";
+			catalog = "";
+			table = "";
+		}
+
+		if ( schema.isEmpty() ) {
+			schema = defaultSchema( clazzToProcess );
+		}
+		if ( catalog.isEmpty() ) {
+			catalog = defaultCatalog( clazzToProcess );
+		}
 
 		AnnotatedJoinColumn[] inheritanceJoinedColumns = makeInheritanceJoinColumns(
 				clazzToProcess,
@@ -899,6 +913,36 @@ public static <T extends Annotation> T getOverridableAnnotation(
 		return element.getAnnotation( annotationType );
 	}
 
+	public static String defaultSchema(XClass clazzToProcess) {
+		XAnnotatedElement annotatedElement = clazzToProcess;
+		while (true) {
+			if ( annotatedElement.isAnnotationPresent(DefaultSchema.class) ) {
+				return annotatedElement.getAnnotation(DefaultSchema.class).schema();
+			}
+			else if ( annotatedElement instanceof XClass ) {
+				annotatedElement = ((XClass) annotatedElement).getContainingElement();
+			}
+			else {
+				return "";
+			}
+		}
+	}
+
+	public static String defaultCatalog(XClass clazzToProcess) {
+		XAnnotatedElement annotatedElement = clazzToProcess;
+		while (true) {
+			if ( annotatedElement.isAnnotationPresent(DefaultSchema.class) ) {
+				return annotatedElement.getAnnotation(DefaultSchema.class).catalog();
+			}
+			else if ( annotatedElement instanceof XClass ) {
+				annotatedElement = ((XClass) annotatedElement).getContainingElement();
+			}
+			else {
+				return "";
+			}
+		}
+	}
+
 	private static void handleTypeDescriptorRegistrations(XAnnotatedElement annotatedElement, MetadataBuildingContext context) {
 		final ManagedBeanRegistry managedBeanRegistry = context.getBootstrapContext()
 				.getServiceRegistry()
@@ -2707,9 +2751,15 @@ private static void bindJoinedTableAssociation(
 			if ( !BinderHelper.isEmptyAnnotationValue( schema ) ) {
 				associationTableBinder.setSchema( schema );
 			}
+			else {
+				associationTableBinder.setSchema( defaultSchema( property.getDeclaringClass() ) );
+			}
 			if ( !BinderHelper.isEmptyAnnotationValue( catalog ) ) {
 				associationTableBinder.setCatalog( catalog );
 			}
+			else {
+				associationTableBinder.setCatalog( defaultCatalog( property.getDeclaringClass() ) );
+			}
 			if ( !BinderHelper.isEmptyAnnotationValue( tableName ) ) {
 				associationTableBinder.setName( tableName );
 			}
@@ -2722,6 +2772,8 @@ private static void bindJoinedTableAssociation(
 		else {
 			annJoins = null;
 			annInverseJoins = null;
+			associationTableBinder.setSchema( defaultSchema( property.getDeclaringClass() ) );
+			associationTableBinder.setCatalog( defaultCatalog( property.getDeclaringClass() ) );
 		}
 		AnnotatedJoinColumn[] joinColumns = AnnotatedJoinColumn.buildJoinTableJoinColumns(
 				annJoins,

hibernate-core/src/main/java/org/hibernate/cfg/AvailableSettings.java

@@ -10,7 +10,6 @@
 
 import org.hibernate.HibernateException;
 import org.hibernate.query.NativeQuery;
-import org.hibernate.query.Query;
 import org.hibernate.Transaction;
 import org.hibernate.boot.MetadataBuilder;
 import org.hibernate.boot.registry.classloading.internal.TcclLookupPrecedence;

hibernate-core/src/main/java/org/hibernate/cfg/annotations/EntityBinder.java

@@ -1056,8 +1056,8 @@ private Join addJoin(
 		Join join = new Join();
 		join.setPersistentClass( persistentClass );
 
-		final String schema;
-		final String catalog;
+		String schema;
+		String catalog;
 		final Object joinColumns;
 		final List<UniqueConstraintHolder> uniqueConstraintHolders;
 
@@ -1096,6 +1096,13 @@ else if ( joinTable != null ) {
 			throw new AssertionFailure( "Both JoinTable and SecondaryTable are null" );
 		}
 
+		if ( schema.isEmpty() ) {
+			schema = AnnotationBinder.defaultSchema( annotatedClass );
+		}
+		if ( catalog.isEmpty() ) {
+			catalog = AnnotationBinder.defaultCatalog( annotatedClass );
+		}
+
 		final Table table = TableBinder.buildAndFillTable(
 				schema,
 				catalog,