Module eclipselink
Package org.eclipse.persistence.annotations

Annotation Interface TenantTableDiscriminator

@Target(TYPE) @Retention(RUNTIME) public @interface TenantTableDiscriminator

A tenant table discriminator is used with a MultitenantType.TABLE_PER_TENANT multitenant strategy. The tenant table discriminator describes the type of table discriminator to use. The user may choose their own tenant identifier property or use the default property: 

org.eclipse.persistence.config.PersistenceUnitProperties.MULTITENANT_PROPERTY_DEFAULT = "eclipselink.tenant-id";

Tenant table discriminator can be specified at the Entity or MappedSuperclass level and must always be accompanied with a @Multitenant(TABLE_PER_TENANT) specification. It is not sufficient to specify only a tenant table discriminator.

See Also:
Author:
Guy Pelletier

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    contextProperty
    The name of the context property to apply to as tenant table discriminator.
    TenantTableDiscriminatorType
    type
    The type of tenant table discriminator to use with the tables of the persistence unit.

  • Element Details

    • contextProperty

      String contextProperty
      The name of the context property to apply to as tenant table discriminator.

      Default is "eclipselink-tenant.id".

      Default:
      "eclipselink.tenant-id"

    • type

      TenantTableDiscriminatorType type
      The type of tenant table discriminator to use with the tables of the persistence unit.

      Defaults to TenantTableDiscriminatorType.SUFFIX.

      Default:
      SUFFIX