com.udaan.r2dbi.SqlUpdate.kt Maven / Gradle / Ivy

Go to download
/*
 *  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.udaan.r2dbi

import com.udaan.r2dbi.sql.annotations.UseSqlMethodHandler

/**
 * Used to indicate that a method should execute a non-query sql statement (INSERT, DELETE, UPDATE etc).
 * The method annotated with SqlUpdate, must have a Flow<Long> return type
 */
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER)
@UseSqlMethodHandler(value = SqlUpdateMethodHandler::class)
annotation class SqlUpdate(
    /**
     * The sql to be executed.
     *
     * @return the SQL string (or name)
     */
    val value: String
)