Package org.eclipse.persistence.annotations

Annotation Type Multitenant

  • @Target(TYPE)
@Retention(RUNTIME)
public @interface Multitenant
    Multitenant specifies that a given entity is shared amongst multiple tenants of a given application. The multitenant type specifies how the data for these entities are to be stored on the database for each tenant. Multitenant can be specified at the Entity or MappedSuperclass level.
    See Also:
    MultitenantType, TenantDiscriminatorColumn, TenantDiscriminatorColumns
    Author:
    Guy Pelletier
    Since:
    EclipseLink 2.3

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean includeCriteria
      (Optional) Indicate if the database requires the tenant criteria to be added to the SELECT, UPDATE, and DELETE queries.
      MultitenantType value
      (Optional) Specify the multi-tenant strategy to use.

    • Element Detail

      • value

        MultitenantType value
        (Optional) Specify the multi-tenant strategy to use.
        Default:
        org.eclipse.persistence.annotations.MultitenantType.SINGLE_TABLE

      • includeCriteria

        boolean includeCriteria
        (Optional) Indicate if the database requires the tenant criteria to be added to the SELECT, UPDATE, and DELETE queries. By default this is done but when set to false the queries will not be modified and it will be up to the application or database to ensure that the correct criteria is applied to all queries.
        Default:
        true