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,35 @@
+package org.hibernate.annotations;
+
+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 a certain package or class, overriding the
+ * effect of {@link org.hibernate.cfg.AvailableSettings#DEFAULT_SCHEMA}
+ * and/or {@link org.hibernate.cfg.AvailableSettings#DEFAULT_CATALOG}
+ * if either of those configuration settings is specified.
+ * <p>
+ * The effect of this annotation may be overridden by explicitly
+ * specifying {@link jakarta.persistence.Table#schema()}.
+ *
+ * @author Gavin King
+ */
+@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

@@ -36,6 +36,7 @@
 import org.hibernate.annotations.CollectionTypeRegistrations;
 import org.hibernate.annotations.Columns;
 import org.hibernate.annotations.Comment;
+import org.hibernate.annotations.DefaultSchema;
 import org.hibernate.annotations.DiscriminatorFormula;
 import org.hibernate.annotations.DiscriminatorOptions;
 import org.hibernate.annotations.EmbeddableInstantiatorRegistration;
@@ -589,9 +590,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 ) ) {
@@ -601,6 +602,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,
@@ -842,6 +856,34 @@ else if ( InheritanceType.SINGLE_TABLE.equals( inheritanceState.getType() ) ) {
 		bindCallbacks( clazzToProcess, persistentClass, context );
 	}
 
+	public static String defaultSchema(XClass clazzToProcess) {
+		XAnnotatedElement annotatedElement = clazzToProcess;
+		while (annotatedElement instanceof XClass) {
+			if ( clazzToProcess.isAnnotationPresent(DefaultSchema.class) ) {
+				return clazzToProcess.getAnnotation(DefaultSchema.class).schema();
+			}
+			annotatedElement = clazzToProcess.getContainingElement();
+		}
+		if ( annotatedElement.isAnnotationPresent(DefaultSchema.class) ) {
+			return annotatedElement.getAnnotation(DefaultSchema.class).schema();
+		}
+		return "";
+	}
+
+	public static String defaultCatalog(XClass clazzToProcess) {
+		XAnnotatedElement annotatedElement = clazzToProcess;
+		while (annotatedElement instanceof XClass) {
+			if ( clazzToProcess.isAnnotationPresent(DefaultSchema.class) ) {
+				return clazzToProcess.getAnnotation(DefaultSchema.class).catalog();
+			}
+			annotatedElement = clazzToProcess.getContainingElement();
+		}
+		if ( annotatedElement.isAnnotationPresent(DefaultSchema.class) ) {
+			return annotatedElement.getAnnotation(DefaultSchema.class).catalog();
+		}
+		return "";
+	}
+
 	private static void handleTypeDescriptorRegistrations(XAnnotatedElement annotatedElement, MetadataBuildingContext context) {
 		final ManagedBeanRegistry managedBeanRegistry = context.getBootstrapContext()
 				.getServiceRegistry()
@@ -2654,9 +2696,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 );
 			}
@@ -2669,6 +2717,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/annotations/EntityBinder.java

@@ -1055,8 +1055,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;
 
@@ -1095,6 +1095,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,