Search code examples
hibernatepersistenceconstraintsunique-constrainthibernate-mapping

How to do multiple column UniqueConstraint in hbm?


Working on some legacy hibernate code.

How do I do the following with hbm.xml(hibernate mapping file) instead of with annotations?

@Table(name="users", uniqueConstraints = {
    @UniqueConstraint(columnNames={"username", "client"}),
    @UniqueConstraint(columnNames={"email", "client"})
})
public class User implements Serializable {
    private static final long serialVersionUID = 1L;
    @Id
    private int id;
    private String username;
    private String email;
    private Client client;
}

Solution

  • Use the properties tag:

    ...
    <properties name="uk1" unique="true">
            <property name="username" .../>
            <many-to-one name="client" .../>
    </properties>
    
    <properties name="uk2" unique="true">
            <property name="email" .../>
            <many-to-one name="client" update="false" insert="false" .../>
    </properties>
    ...
    

    Documentation extract :

    The <properties> element allows the definition of a named, logical grouping of the properties of a class. The most important use of the construct is that it allows a combination of properties to be the target of a property-ref. It is also a convenient way to define a multi-column unique constraint.

    All available options are described in the Hibernate documentation.