jakarta.persistence.SecondaryTables Maven / Gradle / Ivy
/*
* Copyright (c) 2008, 2023 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:
// Linda DeMichiel - 2.1
// Linda DeMichiel - 2.0
package jakarta.persistence;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Specifies multiple secondary tables for an entity.
*
* Example 1: Multiple secondary tables assuming primary key
* columns are named the same in all tables.
* {@snippet :
* @Entity
* @Table(name = "EMPLOYEE")
* @SecondaryTables({
* @SecondaryTable(name = "EMP_DETAIL"),
* @SecondaryTable(name = "EMP_HIST")})
* public class Employee { ... }
* }
*
*
Example 2: Multiple secondary tables with differently named
* primary key columns.
* {@snippet :
* @Entity
* @Table(name = "EMPLOYEE")
* @SecondaryTables({
* @SecondaryTable(name = "EMP_DETAIL",
* pkJoinColumns = @PrimaryKeyJoinColumn(name = "EMPL_ID")),
* @SecondaryTable(name = "EMP_HIST",
* pkJoinColumns = @PrimaryKeyJoinColumn(name = "EMPLOYEE_ID"))})
* public class Employee { ... }
* }
*
* @since 1.0
*/
@Target(TYPE)
@Retention(RUNTIME)
public @interface SecondaryTables {
/**
* (Required) The secondary tables for an entity.
*/
SecondaryTable[] value();
}