ODk Test Framework (версия 2.5.1)/io.bitbucket.dsmoons.framework.odk/DbHelper/ExecuteQuery/forListAndGetFirst

forListAndGetFirst

fun <T> forListAndGetFirst(sql: String, cls: Class<T>, message: String? = null, needFail: Boolean = true): T?

Метод выполняет запрос к БД. Работает аналогично методу forList, но возвращает только первый объект из списка.

Метод используется, например, с sql-запросами с оператором ORDER BY.

Пример:

public Entity getEntityByValue(String value) {
    var query = String.format("SELECT * FROM entities WHERE value = '%s' ORDER BY id DESC", value);
    return dbHelper.executeQuery.forListAndGetFirst(query, Entity.class,
        "Получение записи из таблицы");
}

public Integer getEmployeesCount() {
    var query = "SELECT count(*) FROM employees";
    return sqlite.executeQuery.forListAndGetFirst(query, Integer.class);
}

Return

Объект класса T

Parameters

Класс ответа

sql

sql-запрос

cls

Класс ответа T. Может быть POJO, Kotlin Data Class или другой, описывающий структуру таблицы в БД

message

По умолчанию null. Описание запроса

needFail

По умолчанию true. Нужно ли завершать тест как непройденный, если запрос не выполнен

@JvmOverloads

fun <T> forListAndGetFirst(sql: String, params: Map<String, Any>?, cls: Class<T>, message: String? = null, needFail: Boolean = true): T?

Метод выполняет запрос к БД. Работает аналогично методу forList, но возвращает только первый объект из списка.

Метод используется, например, с sql-запросами с оператором ORDER BY.

Пример:

public Entity getEntityByValue(String value) {
    var query = "SELECT * FROM entities WHERE value = :value ORDER BY id DESC";
    var params = Map.of("value", value);
    return dbHelper.executeQuery.forListAndGetFirst(query, params, Entity.class,
        "Получение записи из таблицы");
}

Return

Объект класса T

Parameters

Класс ответа

sql

sql-запрос

params

Map с параметрами запроса

cls

Класс ответа T. Может быть POJO, Kotlin Data Class или другой, описывающий структуру таблицы в БД

message

По умолчанию null. Описание запроса

needFail

По умолчанию true. Нужно ли завершать тест как непройденный, если запрос не выполнен

inline fun <T : Any> forListAndGetFirst(sql: String, message: String? = null, needFail: Boolean = true): T?

Метод выполняет запрос к БД. Работает аналогично методу forList, но возвращает только первый объект из списка.

Метод используется, например, с sql-запросами с оператором ORDER BY.

Пример:

fun getEntityByValue(value: String): Entity {
    val query = "SELECT * FROM entities WHERE value = '$value' ORDER BY id DESC"
    return dbHelper.executeQuery.forListAndGetFirst(query, "Получение записи из таблицы")
}

Return

Объект класса T

Since

2.5.1

Parameters

Класс ответа

sql

sql-запрос

message

По умолчанию null. Описание запроса

needFail

По умолчанию true. Нужно ли завершать тест как непройденный, если запрос не выполнен

inline fun <T : Any> forListAndGetFirst(sql: String, params: Map<String, Any>?, message: String? = null, needFail: Boolean = true): T?

Метод выполняет запрос к БД. Работает аналогично методу forList, но возвращает только первый объект из списка.

Метод используется, например, с sql-запросами с оператором ORDER BY.

Пример:

fun getEntityByValue(value: String): Entity {
    val query = "SELECT * FROM entities WHERE value = '$value' ORDER BY id DESC"
    return dbHelper.executeQuery.forListAndGetFirst(query, "Получение записи из таблицы")
}

Return

Объект класса T

Since

2.5.1

Parameters

Класс ответа

sql

sql-запрос

params

Map с параметрами запроса

message

По умолчанию null. Описание запроса

needFail

По умолчанию true. Нужно ли завершать тест как непройденный, если запрос не выполнен