Record Class ForeignKeyMetadataPolicy

java.lang.Object
java.lang.Record
org.hibernate.tool.schema.extract.spi.ForeignKeyMetadataPolicy
@SPI(USE) public record ForeignKeyMetadataPolicy(ForeignKeyMetadataPolicy.Mode mode, @Nullable String crossReferenceParentTableFilter) extends Record

Selects the JDBC metadata calls used for per-table foreign-key discovery.

Use importedKeysOnly() for the portable JDBC path. Use importedKeysAndCrossReference(String) only when the driver requires cross-reference rows to complete imported-key metadata, preserving the parent-table filter exactly as required by that driver.

Since:
8.0

  • Constructor Details

    • ForeignKeyMetadataPolicy

      public ForeignKeyMetadataPolicy(ForeignKeyMetadataPolicy.Mode mode, @Nullable String crossReferenceParentTableFilter)
      Creates an instance of a ForeignKeyMetadataPolicy record class.
      Parameters:
      mode - the value for the mode record component
      crossReferenceParentTableFilter - the value for the crossReferenceParentTableFilter record component

  • Method Details

    • importedKeysOnly

      public static ForeignKeyMetadataPolicy importedKeysOnly()
      Return the stable portable imported-keys-only policy.

    • importedKeysAndCrossReference

      public static ForeignKeyMetadataPolicy importedKeysAndCrossReference(@Nullable String parentTableFilter)
      Return a policy which supplements imported keys with cross-reference rows.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • mode

      public ForeignKeyMetadataPolicy.Mode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • crossReferenceParentTableFilter

      @Nullable public String crossReferenceParentTableFilter()
      Returns the value of the crossReferenceParentTableFilter record component.
      Returns:
      the value of the crossReferenceParentTableFilter record component