001/*
002 *  Copyright (c) 2022-2023, Mybatis-Flex (fuhai999@gmail.com).
003 *  <p>
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *  <p>
008 *  http://www.apache.org/licenses/LICENSE-2.0
009 *  <p>
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package com.mybatisflex.annotation;
017
018import java.lang.annotation.*;
019
020/**
021 * 数据库表中的列信息注解。
022 */
023@Inherited
024@Retention(RetentionPolicy.RUNTIME)
025@Target({ElementType.FIELD})
026public @interface Id {
027
028    /**
029     * ID 生成策略，默认为 {@link KeyType#None}。
030     *
031     * @return 生成策略
032     */
033    KeyType keyType() default KeyType.None;
034
035    /**
036     * <p>若 keyType 类型是 sequence， value 则代表的是
037     * sequence 序列的 sql 内容。
038     * 例如：select SEQ_USER_ID.nextval as id from dual
039     *
040     * <p>若 keyType 是 Generator，value 则代表的是使用的那个 keyGenerator 的名称。
041     */
042    String value() default "";
043
044    /**
045     * <p>sequence 序列执行顺序。
046     *
047     * <p>是在 entity 数据插入之前执行，还是之后执行，之后执行的一般是数据主动生成的 id。
048     *
049     * @return 执行之前还是之后
050     */
051    boolean before() default true;
052
053
054    /**
055     * 数据库字段注释，在 AI 时代，注释的内容往往可用于 AI 辅助对话
056     */
057    String comment() default "";
058}