All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jakarta.persistence.Table Maven / Gradle / Ivy

There is a newer version: 3.2.0
Show newest version
/*
 * Copyright (c) 2008, 2020 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 the primary table for the annotated entity. Additional
 * tables may be specified using {@link SecondaryTable} or {@link
 * SecondaryTables} annotation.
 *
 * 

If no Table annotation is specified for an entity * class, the default values apply. * *

 *    Example:
 *
 *    @Entity
 *    @Table(name="CUST", schema="RECORDS")
 *    public class Customer { ... }
 * 
* * @since 1.0 */ @Target(TYPE) @Retention(RUNTIME) public @interface Table { /** * (Optional) The name of the table. *

Defaults to the entity name. */ String name() default ""; /** (Optional) The catalog of the table. *

Defaults to the default catalog. */ String catalog() default ""; /** (Optional) The schema of the table. *

Defaults to the default schema for user. */ String schema() default ""; /** * (Optional) Unique constraints that are to be placed on * the table. These are only used if table generation is in * effect. These constraints apply in addition to any constraints * specified by the Column and JoinColumn * annotations and constraints entailed by primary key mappings. *

Defaults to no additional constraints. */ UniqueConstraint[] uniqueConstraints() default {}; /** * (Optional) Indexes for the table. These are only used if * table generation is in effect. Note that it is not necessary * to specify an index for a primary key, as the primary key * index will be created automatically. * * @since 2.1 */ Index[] indexes() default {}; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy