vertx-sql-assist — это инструмент для помощи в работе с SQL в Vert.x, который обеспечивает поддержку вставки, удаления, обновления, запроса, соединения, постраничного запроса и взаимодействия с классом справки SqlAssist. В основном не нужно писать ни строчки кода SQL.

Мы рекомендуем вам использовать ScrewDriver для генерации кода, чтобы мир показался вам прекрасным!

Зависимости

Чтобы использовать vertx-sql-assist, добавьте следующую зависимость в раздел зависимостей вашего дескриптора сборки

XML
<dependency>
  <groupId>org.mirrentools</groupId>
  <artifactId>vertx-sql-assist</artifactId>
  <version>RELEASE</version>
</dependency>

Описание методов класса SQL

• getCount Получить общее количество строк данных
• selectAll Запрос нескольких строк данных
• limitAll Постраничный запрос
• selectById Запрос данных по ID
• selectByObj Запрос данных по атрибутам, которые не пусты в объекте
• selectSingleByObj Запросить первую строку данных, возвращаемую при снятии средств через атрибут, не пустой в объекте
• insertBatch Пакетная вставка
• insertAll Вставка объекта, включая значение со значением свойства null
• insertNonEmpty Вставка объекта только со свойством, значение которого не равно null
• insertNonEmptyGeneratedKeys Вставка объекта только со свойством, значение которого не null, и получение идентификатора результата
• replace Вставка объекта. Если объект не существует, создайте новый. Если объект уже существует, обновите его
• updateAllById Обновите все свойства в объекте, включая null значение, если это значение первичного ключа в объекте
• updateAllByAssist Обновите все свойства в объекте, включая null значение, с помощью SqlAssist
• updateNonEmptyById Обновление ненулевого значения свойства в объекте по ID
• updateNonEmptyByAssist Обновление ненулевого значения свойства в объекте с помощью SqlAssist
• updateSetNullById Установите столбец в null по ID
• updateSetNullByAssist Установите столбец в null с помощью SqlAssist
• deleteById Удалить по ID
• deleteByAssist Удалить с помощью SqlAssist
• queryAsObj Результат выполнения запроса — JsonObject
• queryAsList Результат выполнения запроса — List
• update Результат обновления — количество затронутых строк
• updateResult Выполнение обновления и получение результата
• batch Пакетное выполнение
• execute Выполнение пула

Описание метода SqlAssist

• setOrders Установить OrderBy с помощью SqlAssist.order(column,mode)
• setGroupBy Установить GroupBy
• setHaving Установить Having
• setDistincts Установить distinct или нет, true — удалить дубликаты
• setPage Установить номер страницы. Значение действительно только в методе limitAll, в конце будет преобразовано в startRow
• setStartRow Установить начальную строку данных
• setRowSize Установить, сколько строк данных получить
• setResultColumn Установить возвращаемый столбец, несколько столбцов разделены символом ,
• setJoinOrReference Установить запрос на соединение или запрос с несколькими таблицами
• and Добавить условие and
• or Добавить условие or
• andEq Добавить условие and equal
• orEq Добавить условие or equal
• andNeq Добавить условие and not equal
• orNeq Добавить условие or not equal
• andLt Добавить условие and less than
• orLt Добавить условие or less than
• andLte Добавить условие and less than or equal to
• orLte Добавить условие or less than or equal to
• andGt Добавить условие and greater than
• orGt Добавить условие or greater than
• andGte Добавить условие and greater than or equal to
• orGte Добавить условие or greater than or equal to
• andLike Добавить условие and like
• orLike Добавить условие or like
• andNotLike Добавить условие and not like
• orNotLike Добавить условие or not like
• andIsNull Добавить условие and is null
• orIsNull Добавить условие or is null
• andIsNotNull Добавить условие and is not null
• orIsNotNull Добавить условие or is not null
• setConditions Добавить условие запроса
• customCondition Добавить пользовательское условие запроса

Пример использования SqlAssist

[Пример] ``` // (1)Create SqlAssist SqlAssist assist = new SqlAssist(); // (2)Add condition type=1 or 3,equivalent to SQL: where type=1 or type=3 assist.orEq("type", 1).orEq("type", 3); // (3)Eliminating duplicate data ,equivalent to SQL: select distinct ... assist.setDistincts(true); // (4)Custom return column only [id,type,name,seq] assist.setResultColumn("id,type,name,seq"); // (5)order by seq desc assist.setOrders(SqlAssist.order("seq", false)); // (6)To get the data of lines 20-35 in the database, you can also use setpage (page number) to get the data by page,equivalent to SQL: limit 20,15 assist.setStartRow(20).setRowSize(15); // (7)Execute get data Future future=Promise.promise().future(); future.setHandler(//Processed results); itemsSQL.selectAll(assist,future);

Для получения дополнительной помощи см. примечания к методу класса SqlAssist.

## Как это использовать?

**Пример**

1. Создайте класс сущности

``` java
@Table("имя таблицы")
public class User {
  @TableId("первичный ключ")
  private Long id;
  @TableColumn("имя столбца")
  private String name;
  @TableColumn(value = "имя столбца", alias = "имя столбца, не требуется")
  private Integer type;
  //Другое необходимое
}

2. Создайте SQL-класс и расширьте CommonSQL

public class UserSQL extends CommonSQL<User,JDBCPool> {//(1)
    public UserSQL(SQLExecute<JDBCPool> execute) {
        super(execute);
    }
  //(1)
  //Пользователь должен быть классом сущностей с аннотацией @Table, @TableId, @TableColumn или переписать SQLStatement, который реализует имя таблицы, ID и возвращает столбец для передачи в CommonSQL
  //JDBCPool может быть другим клиентом базы данных
  //Переопределить другие методы
}

3. Выполните

public static void main(String[] args) {
  // Другое необходимое
  UserSQL userSQL = new UserSQL(SQLExecute.createJDBC(JDBCPool));
  // Пример запроса
  // Создаем SqlAssist
  SqlAssist assist = new SqlAssist();
  assist.setStartRow(0).setRowSize(15);
  assist.andEq("type", 1);
  assist.setOrders(SqlAssist.order("id", true));
  // Выполнение запроса
  userSQL.selectAll(assist,res->{
    if (res.succeeded()) {
      System.out.println(res.result());
    }else {
      System.err.println(res.cause());
    }
  });
  //Пример сохранения
  User user =new User();
  user.setId(1001L);
  user.setName("org.mirrentools");
  user.setType(1);
  userSQL.insertNonEmpty(user,res->{//Обработанные результаты});
}

Общие настройки

Установите различные операторы SQL для базы данных По умолчанию оператор SQL использует стандартный оператор MySQL, вы можете установить различные операторы SQL для баз данных через SQLStatement, поддерживая: MySQL、PostgreSQL、Oracle、DB2、SQL Server、SQLite, например, если вы установите его на Oracle, вы можете:

SQLStatement.register(OracleStatementSQL.class);

Установите предельное количество возвращаемых данных Значение по умолчанию для имени возвращаемого результата данных: totals=Общее количество строк данных, pages=Общее количество страниц данных, page=Номер текущей страницы, size=Сколько строк данных отображается на странице, data=Результат данных. Если вы хотите изменить имя результата данных на другое, вы можете:

SqlLimitResult.registerResultKey("totals", "counts");