app.myoss.cloud.mybatis.table.annotation.Table Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-2018 https://github.com/myoss
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package app.myoss.cloud.mybatis.table.annotation;

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

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

import app.myoss.cloud.core.utils.NameStyle;

/**
 * This annotation specifies the primary table for the annotated entity.
 * 
 * If no Table annotation is specified for an entity class, the
 * default values apply.
 *
 * 
 *    Example:
 *
 *    @Table(name="CUST", schema="RECORDS")
 *    public class Customer { ... }
 * 
 *
 * @author Jerry.Chen
 * @since 2018年4月26日 上午11:55:45
 */
@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface Table {
    /**
     * 
     * (Optional) The name of the table.
     * 

     * Defaults to the entity name.
     *
     * @return 数据库表名
     */
    String name() default "";

    /**
     * (Optional) 编码之后的数据库表名，比如：表名是关键字、有空格
     *
     * @return 编码之后的数据库表名
     */
    String escapedName() default "";

    /**
     * 

     * (Optional) The catalog of the table.
     * 

     * Defaults to the default catalog.
     *
     * @return 数据库中的catalog，如果设置了此属性，将在表名前面加上catalog指定的值
     */
    String catalog() default "";

    /**
     * 

     * (Optional) The schema of the table.
     * 

     * Defaults to the default schema for user.
     *
     * @return 数据库中的schema
     */
    String schema() default "";

    /**
     * 

     * table name or column name style
     * 
     * Defaults to snake_case.
     *
     * @return 数据库表名、数据库字段命名风格
     */
    NameStyle nameStyle() default NameStyle.SNAKE_CASE;
}