1 /*
2 * Copyright 2009-2023 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.apache.ibatis.annotations;
17
18 import java.lang.annotation.Documented;
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Repeatable;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
24
25 /**
26 * The annotation that specify an SQL for inserting record(s).
27 * <p>
28 * <b>How to use:</b>
29 *
30 * <pre>
31 * public interface UserMapper {
32 * @Insert("INSERT INTO users (id, name) VALUES(#{id}, #{name})")
33 * void insert(User user);
34 * }
35 * </pre>
36 *
37 * @author Clinton Begin
38 */
39 @Documented
40 @Retention(RetentionPolicy.RUNTIME)
41 @Target(ElementType.METHOD)
42 @Repeatable(Insert.List.class)
43 public @interface Insert {
44 /**
45 * Returns an SQL for inserting record(s).
46 *
47 * @return an SQL for inserting record(s)
48 */
49 String[] value();
50
51 /**
52 * @return A database id that correspond this statement
53 *
54 * @since 3.5.5
55 */
56 String databaseId() default "";
57
58 /**
59 * The container annotation for {@link Insert}.
60 *
61 * @author Kazuki Shimizu
62 *
63 * @since 3.5.5
64 */
65 @Documented
66 @Retention(RetentionPolicy.RUNTIME)
67 @Target(ElementType.METHOD)
68 @interface List {
69 Insert[] value();
70 }
71
72 }