Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface CollectionTable

@Target({METHOD,FIELD}) @Retention(RUNTIME) @Deprecated public @interface CollectionTable
Deprecated.
Use CollectionTable.
A CollectionTable annotation is used in conjunction with a BasicCollection or a BasicMap annotation. However, if a CollectionTable is not defined, one will be defaulted.
See Also:
Author:
Guy Pelletier

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    catalog
    Deprecated.
    The catalog of the table.
    String
    name
    Deprecated.
    The name of the collection table.
    jakarta.persistence.PrimaryKeyJoinColumn[]
    primaryKeyJoinColumns
    Deprecated.
    Used to specify a primary key column that is used as a foreign key to join to another table.
    String
    schema
    Deprecated.
    The schema of the table.
    jakarta.persistence.UniqueConstraint[]
    uniqueConstraints
    Deprecated.
    Unique constraints that are to be placed on the table.

  • Element Details

    • name

      String name
      Deprecated.
      The name of the collection table.

      If it is not specified, it is defaulted to the concatenation of the following:

      • the name of the source entity
      • "_"
      • the name of the relationship property or field of the source entity.
      Default:
      ""

    • catalog

      String catalog
      Deprecated.
      The catalog of the table.

      It defaults to the persistence unit default catalog.

      Default:
      ""

    • schema

      String schema
      Deprecated.
      The schema of the table.

      It defaults to the persistence unit default schema.

      Default:
      ""

    • primaryKeyJoinColumns

      jakarta.persistence.PrimaryKeyJoinColumn[] primaryKeyJoinColumns
      Deprecated.
      Used to specify a primary key column that is used as a foreign key to join to another table. If the source entity uses a composite primary key, a primary key join column must be specified for each field of the composite primary key. In a single primary key case, a primary key join column may optionally be specified.

      Defaulting applies otherwise as follows:

      • name, the same name as the primary key column of the primary table of the source entity.
      • referencedColumnName, the same name of primary key column of the primary table of the source entity.
      Default:
      {}

    • uniqueConstraints

      jakarta.persistence.UniqueConstraint[] uniqueConstraints
      Deprecated.
      Unique constraints that are to be placed on the table. These are only used if table generation is in effect.
      Default:
      {}