com.landawn.abacus.jdbc.annotation.Update Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abacus-jdbc Show documentation
abacus jdbc
There is a newer version: 3.8.5
/*
 * Copyright (c) 2021, Haiyang Li.
 *
 * 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 com.landawn.abacus.jdbc.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.landawn.abacus.annotation.Beta;
import com.landawn.abacus.jdbc.JdbcUtil;
import com.landawn.abacus.jdbc.OP;

/**
 * The Interface Update.
 *
 * @see How to turn off the Eclipse code formatter for certain sections of Java code?
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Update {

    /**
     * Sql script, or id which is defined in sql mapper or sql table class inside DAO class.
     *
     * @return
     * @deprecated using {@code sql="SELECT ... FROM ..."} or {@code id="selectById"} for explicit call.
     */
    @Deprecated
    String value() default "";

    /**
     *
     * @return
     */
    String sql() default "";

    /**
     *
     * @return
     */
    String id() default ""; // id defined SqlMapper

    /**
     *
     * @return
     */
    boolean isBatch() default false;

    /**
     *
     * @return
     */
    int batchSize() default JdbcUtil.DEFAULT_BATCH_SIZE;

    /**
     * Unit is seconds.
     *
     * @return
     */
    int queryTimeout() default -1;

    /**
     * Set it to {@code true} if there is only one input parameter and the type is Collection/Object Array, and the target db column type is Collection/Object Array.
     *
     * @return
     */
    boolean isSingleParameter() default false;

    /**
     *
     *
     * @return
     */
    @Beta
    boolean hasDefineWithNamedParameter() default false;

    /**
     * Set named parameter {@code :now} to current system time if it's {@code true}.
     *
     * @return
     */
    @Beta
    boolean timestamped() default false;

    /**
     * It should only be set with {@code OP.update} or {@code OP.largeUpdate}
     * @return
     */
    OP op() default OP.update;
}