... ]]> The entity-mappings element is the root element of a mapping file. It contains the following four types of elements: 1. The persistence-unit-metadata element contains metadata for the entire persistence unit. It is undefined if this element occurs in multiple mapping files within the same persistence unit. 2. The package, schema, catalog and access elements apply to all of the entity, mapped-superclass and embeddable elements defined in the same file in which they occur. 3. The sequence-generator, table-generator, converter, named-query, named-native-query, named-stored-procedure-query, and sql-result-set-mapping elements are global to the persistence unit. It is undefined to have more than one sequence-generator or table-generator of the same name in the same or different mapping files in a persistence unit. It is undefined to have more than one named-query, named-native-query, sql-result-set-mapping, or named-stored-procedure-query of the same name in the same or different mapping files in a persistence unit. It is also undefined to have more than one converter for the same target type in the same or different mapping files in a persistence unit. 4. The entity, mapped-superclass and embeddable elements each define the mapping information for a managed persistent class. The mapping information contained in these elements may be complete or it may be partial. See @JavaTypeRegistration See @JdbcTypeRegistration See @TypeRegistration See @CompositeTypeRegistration See @CollectionTypeRegistration Configuration parameter user-types See `@org.hibernate.metamodel.CollectionClassification` See @ConverterRegistration See @EmbeddableInstantiatorRegistration Metadata that applies to the persistence unit and not just to the mapping file in which it is contained. If the xml-mapping-metadata-complete element is specified, the complete set of mapping metadata for the persistence unit is contained in the XML mapping files for the persistence unit. These defaults are applied to the persistence unit as a whole unless they are overridden by local annotation or XML element settings. schema - Used as the schema for all tables, secondary tables, join tables, collection tables, sequence generators, and table generators that apply to the persistence unit catalog - Used as the catalog for all tables, secondary tables, join tables, collection tables, sequence generators, and table generators that apply to the persistence unit delimited-identifiers - Used to treat database identifiers as delimited identifiers. access - Used as the access type for all managed classes in the persistence unit cascade-persist - Adds cascade-persist to the set of cascade options in all entity relationships of the persistence unit entity-listeners - List of default entity listeners to be invoked on each entity in the persistence unit. See jakarta.persistence.Entity Defines the settings and mappings for an entity. Is allowed to be sparsely populated and used in conjunction with the annotations. Alternatively, the metadata-complete attribute can be used to indicate that no annotations on the entity class (and its fields or properties) are to be processed. If this is the case then the defaulting rules for the entity and its subelements will be recursively applied. @Target(TYPE) @Retention(RUNTIME) public @interface Entity { String name() default ""; } See `@org.hibernate.annotations.PolymorphismType` See `@org.hibernate.annotations.Polymorphism` See `@org.hibernate.annotations.OptimisticLockType` See `@org.hibernate.annotations.OptimisticLocking` See `@org.hibernate.annotations.TenantId` Entity-defined attributes This element contains the entity field or property mappings. It may be sparsely populated to include only a subset of the fields or properties. If metadata-complete for the entity is true then the remainder of the attributes will be defaulted according to the default rules. See `org.hibernate.annotations.GenerationTime` See `org.hibernate.tuple.GenerationTiming` See `@org.hibernate.annotations.Generated` See `@jakarta.persistence.Basic` See `@jakarta.persistence.Lob` See `@jakarta.persistence.Temporal` See `@jakarta.persistence.Enumerated` See `@jakarta.persistence.Convert` See `@org.hibernate.annotations.Nationalized` See `@org.hibernate.annotations.OptimisticLock` See `@org.hibernate.annotations.AttributeAccessor` See `@org.hibernate.annotations.Type` See `@org.hibernate.annotations.JdbcTypeCode` See `@jakarta.persistence.CollectionTable` See `@jakarta.persistence.ColumnResult` See `jakarta.persistence.ConstraintMode` See `@jakarta.persistence.ConstructorResult` See `@jakarta.persistence.DiscriminatorColumn` See `@org.hibernate.annotations.DiscriminatorOptions` See `jakarta.persistence.DiscriminatorType` See `jakarta.persistence.DiscriminatorValue See `jakarta.persistence.ElementCollection` See `jakarta.persistence.OrderBy` See `jakarta.persistence.OrderColumn` See `@org.hibernate.annotations.AttributeAccessor` See `@org.hibernate.annotations.OptimisticLock` See `@org.hibernate.annotations.SortComparator` See `@org.hibernate.annotations.SortNatural` See `@jakarta.persistence.Lob` See `@jakarta.persistence.Temporal` See `@jakarta.persistence.Enumerated` See `@jakarta.persistence.Convert` See `@org.hibernate.annotations.Nationalized` See `@jakarta.persistence.Embeddable` Describes the features available for mapping attributes of embeddables See `@jakarta.persistence.Embedded` See `@org.hibernate.annotations.AttributeAccessor` See `@org.hibernate.annotations.OptimisticLock` See `@jakarta.persistence.EmbeddedId` See `@org.hibernate.annotations.AttributeAccessor` See `@jakarta.persistence.PrePersist` See `@jakarta.persistence.PreRemove` See `@jakarta.persistence.PreUpdate` See `@jakarta.persistence.PostPersist` See `@jakarta.persistence.PostRemove` See `@jakarta.persistence.PostUpdate` See `@jakarta.persistence.PostLoad` See `@jakarta.persistence.EntityListeners` See `@jakarta.persistence.EntityResult` See `jakarta.persistence.EnumType` See `@jakarta.persistence.Enumerated` See `jakarta.persistence.FetchType` See `@jakarta.persistence.FieldResult` See `@jakarta.persistence.ForeignKey` See `@jakarta.persistence.GeneratedValue` See `jakarta.persistence.GenerationType` See `@jakarta.persistence.Id` See `@org.hibernate.annotations.AttributeAccessor` See `@org.hibernate.annotations.Type` See `@org.hibernate.annotations.JdbcTypeCode` See `@org.hibernate.annotations.UuidGenerator` See `@jakarta.persistence.IdClass` See `jakarta.persistence.Index` See `@jakarta.persistence.Inheritance` See `jakarta.persistence.InheritanceType See `@jakarta.persistence.JoinColumn` See `@jakarta.persistence.JoinTable` See `jakarta.persistence.Lob` See `javax.persistence.LockModeType` See `@jakarta.persistence.ManyToMany` See `@org.hibernate.annotations.SortComparator` See `@org.hibernate.annotations.SortNatural` See `@org.hibernate.annotations.AttributeAccessor` See `@jakarta.persistence.ManyToOne` See `@org.hibernate.annotations.AttributeAccessor` See `@org.hibernate.annotations.OnDelete See `@jakarta.persistence.MapKey` See `@jakarta.persistence.MapKeyClass` See `@jakarta.persistence.MapKeyColumn` See `@jakarta.persistence.MapKeyJoinColumn` See `@jakarta.persistence.MappedSuperclass` @Target({}) @Retention(RUNTIME) public @interface NamedAttributeNode { String value(); String subgraph() default ""; String keySubgraph() default ""; } @Target({TYPE}) @Retention(RUNTIME) public @interface NamedEntityGraph { String name() default ""; NamedAttributeNode[] attributeNodes() default {}; boolean includeAllAttributes() default false; NamedSubgraph[] subgraphs() default {}; NamedSubGraph[] subclassSubgraphs() default {}; } @Target({TYPE}) @Retention(RUNTIME) public @interface NamedNativeQuery { String name(); String query(); QueryHint[] hints() default {}; Class resultClass() default void.class; String resultSetMapping() default ""; //named SqlResultSetMapping } Common Hibernate specific extensions available for named query definitions. todo : a lot of these extensions could be handled by JPA QueryHint scheme Used only by tools to generate finder methods for named queries @Target({TYPE}) @Retention(RUNTIME) public @interface NamedQuery { String name(); String query(); LockModeType lockMode() default NONE; QueryHint[] hints() default {}; } @Target({TYPE}) @Retention(RUNTIME) public @interface NamedStoredProcedureQuery { String name(); String procedureName(); StoredProcedureParameter[] parameters() default {}; Class[] resultClasses() default {}; String[] resultSetMappings() default{}; QueryHint[] hints() default {}; } @Target({TYPE}) @Retention(RUNTIME) public @interface StoredProcedureParameter { String name() default ""; ParameterMode mode() default ParameterMode.IN; Class type(); } public enum ParameterMode { IN, INOUT, OUT, REF_CURSOR}; @Target({}) @Retention(RUNTIME) public @interface NamedSubgraph { String name(); Class type() default void.class; NamedAttributeNode[] attributeNodes(); } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToMany { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default LAZY; String mappedBy() default ""; } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToOne { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default EAGER; boolean optional() default true; String mappedBy() default ""; boolean orphanRemoval() default false; } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OrderBy { String value() default ""; } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OrderColumn { String name() default ""; boolean nullable() default true; boolean insertable() default true; boolean updatable() default true; String columnDefinition() default ""; } @Target({METHOD}) @Retention(RUNTIME) public @interface PostLoad {} @Target({METHOD}) @Retention(RUNTIME) public @interface PostPersist {} @Target({METHOD}) @Retention(RUNTIME) public @interface PostRemove {} @Target({METHOD}) @Retention(RUNTIME) public @interface PostUpdate {} @Target({METHOD}) @Retention(RUNTIME) public @interface PrePersist {} @Target({METHOD}) @Retention(RUNTIME) public @interface PreRemove {} @Target({METHOD}) @Retention(RUNTIME) public @interface PreUpdate {} @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface PrimaryKeyJoinColumn { String name() default ""; String referencedColumnName() default ""; String columnDefinition() default ""; } @Target({}) @Retention(RUNTIME) public @interface QueryHint { String name(); String value(); } @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface SequenceGenerator { String name(); String sequenceName() default ""; String catalog() default ""; String schema() default ""; int initialValue() default 1; int allocationSize() default 50; } @Target({TYPE}) @Retention(RUNTIME) public @interface SqlResultSetMapping { String name(); EntityResult[] entities() default {}; ConstructorResult[] classes() default{}; ColumnResult[] columns() default {}; } @Target({TYPE}) @Retention(RUNTIME) public @interface Table { String name() default ""; String catalog() default ""; String schema() default ""; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; } See `@org.hibernate.annotations.Comment` See `@org.hibernate.annotations.Check` @Target({TYPE}) @Retention(RUNTIME) public @interface SecondaryTable { String name(); String catalog() default ""; String schema() default ""; PrimaryKeyJoinColumn[] pkJoinColumns() default {}; UniqueConstraint[] uniqueConstraints() default {}; Index[] indexes() default {}; } @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface TableGenerator { String name(); String table() default ""; String catalog() default ""; String schema() default ""; String pkColumnName() default ""; String valueColumnName() default ""; String pkColumnValue() default ""; int initialValue() default 0; int allocationSize() default 50; UniqueConstraint[] uniqueConstraints() default {}; Indexes[] indexes() default {}; } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Temporal { TemporalType value(); } public enum TemporalType { DATE, // java.sql.Date TIME, // java.sql.Time TIMESTAMP // java.sql.Timestamp } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Transient {} @Target({}) @Retention(RUNTIME) public @interface UniqueConstraint { String name() default ""; String[] columnNames(); } @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Version {} Specifies a filter definition. After definition, a filter can be applied to entity or collection by name. Used to identify all bind parameters in the condition elemement Applies a filter defined by hbm-filter-def usage element defines a single path to which the fetch refers, as well as the style of fetch to apply. The 'root' of the path is different depending upon the context in which the containing occurs; within a element, the entity-name of the containing class mapping is assumed... ]]> Names a org.hibernate.id.IdentifierGenerator implementation (class attribute) as well as any configuration information need by the implementation (Hibernate will pass it the parameters after instantiation). Corresponds to the org.hibernate.annotations.Cache annotation. Used to specify Hibernate-specific extra control over the caching of entity and collection state. org.hibernate.cache.spi.access.AccessType enum values org.hibernate.CacheMode enum values See `@org.hibernate.annotations.TenantId` The loader element allows specification of a named query to be used for fetching an entity or collection This element determines how the persistence provider accesses the state of an entity or embedded object. @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AssociationOverride { String name(); JoinColumn[] joinColumns() default{}; JoinTable joinTable() default @JoinTable; } @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface AttributeOverride { String name(); Column column(); } See `@org.hibernate.annotations.NaturalId` See `@org.hibernate.annotations.Any` Describes the discriminator of a discriminated association (any, many-to-any), including the mapping of discriminator values to matching entity name Describes the "foreign key" of a discriminated association (any, many-to-any). com.acme.Employee ]]> See `@org.hibernate.annotations.ManyToAny` See `@jakarta.persistence.CascadeType` See `@org.hibernate.annotations.Cascade` See `@jakarta.persistence.Column` See `@org.hibernate.annotations.Comment` See `@org.hibernate.annotations.Check` See `@org.hibernate.annotations.ColumnDefault` See `@org.hibernate.annotations.ColumnTransformer` See `@jakarta.persistence.Convert` See `@jakarta.persistence.Converter` See `@jakarta.persistence.AttributeConverter See `@org.hibernate.annotations.Nationalized` See `org.hibernate.annotations.OnDeleteAction` enum org.hibernate.FetchMode enum values org.hibernate.FetchMode enum values org.hibernate.FlushMode enum values See `@org.hibernate.annotations.Type` org.hibernate.annotations.UuidGenerator.Style enum values See `@org.hibernate.annotations.UuidGenerator`