Package org.apache.ibatis.annotations

Annotation Type Delete

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@Repeatable(List.class)
public @interface Delete
The annotation that specify an SQL for deleting record(s).

How to use: 

 public interface UserMapper {
   @Delete("DELETE FROM users WHERE id = #{id}")
   boolean deleteById(int id);
 }
Author:
Clinton Begin

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static interface  Delete.List
    The container annotation for Delete.

  • Required Element Summary

    Required Elements
    Modifier and Type Required Element Description
    String[] value
    Returns an SQL for deleting record(s).

  • Optional Element Summary

    Optional Elements
    Modifier and Type Optional Element Description
    String databaseId  

  • Element Details

    • value

      String[] value
      Returns an SQL for deleting record(s).
      Returns:
      an SQL for deleting record(s)

    • databaseId

      String databaseId
      Returns:
      A database id that correspond this statement
      Since:
      3.5.5
      Default:
      ""