org.eclipse.persistence.annotations.TenantDiscriminatorColumn Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction 346465e
There is a newer version: 5.0.0-B05
/*
 * Copyright (c) 2011, 2024 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     03/24/2011-2.3 Guy Pelletier
//       - 337323: Multi-tenant with shared schema support (part 1)
//     06/12/2017-2.7 Lukas Jungmann
//       - 518155: [jpa22] add support for repeatable annotations
package org.eclipse.persistence.annotations;

import jakarta.persistence.DiscriminatorType;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Tenant discriminator column(s) are used with a {@linkplain MultitenantType#SINGLE_TABLE} multitenant
 * strategy. Tenant discriminator column(s) are completely user specified and
 * there is no limit on how many tenant discriminator columns an application
 * can define (ie using the {@linkplain TenantDiscriminatorColumns} annotation)
 * 
 * Tenant discriminator column(s) can be specified at the Entity or
 * MappedSuperclass level and must always be accompanied by a
 * {@code @Multitenant(SINGLE_TABLE)} specification. It is not sufficient to specify
 * only tenant discriminator column(s).
 *
 * @see TenantDiscriminatorColumns
 * @see Multitenant
 * @see MultitenantType
 * @author Guy Pelletier
 * @since EclipseLink 2.3
 */
@Target({TYPE})
@Retention(RUNTIME)
@Repeatable(TenantDiscriminatorColumns.class)
public @interface TenantDiscriminatorColumn {
    /**
     * The name of column to be used for the tenant discriminator.
     */
    String name() default "TENANT_ID";

    /**
     * The name of the context property to apply to the
     * tenant discriminator column.
     */
    String contextProperty() default "eclipselink.tenant-id";

    /**
     * The type of object/column to use as a class discriminator.
     * 

     * Defaults to {@linkplain jakarta.persistence.DiscriminatorType#STRING}.
     */
    DiscriminatorType discriminatorType() default DiscriminatorType.STRING;

    /**
     * The SQL fragment that is used when generating the DDL
     * for the discriminator column.
     * 

     * Defaults to the provider-generated SQL to create a column
     * of the specified discriminator type.
     */
    String columnDefinition() default "";

    /**
     * The column length for String-based discriminator types.
     * Ignored for other discriminator types.
     */
    int length() default 31;

    /**
     * The name of the table that contains the column.
     * 
     * If absent the column is assumed to be in the primary table.
     */
    String table() default "";

    /**
     * Specifies that the tenant discriminator column is part of the primary
     * key of the tables.
     */
    boolean primaryKey() default false;
}