FMPDatabase

Описание

Интерфейс FMPDatabase предназначен для описания локальной базы данных.

interface FMPDatabase: FMPObject

Комментарии

Интерфейс используется в качестве параметра в других объектах, взаимодействующих с базой данных. Также все операции записи синхронизированы на этом объекте, поэтому рекомендуется использовать только один объект для каждой базы. На данный момент используется СУБД SQLite.

Свойства

Свойство Описание

path

 Полный путь к файлу базы данных. 
val path: String

Методы

Метод Описание

open

 Открытие соединения с базой данных. В случае успешного открытия соединения с базой данных возвращает true. 
fun open(): Boolean
close Закрытие соединения с базой данных и удаление кэша. 
fun close(): Boolean

getResources

 Получение списка ресурсов из базы данных. 
fun getResources(): List<FMPResource>
downloadResources Загрузка ресурсов в базу данных. При выполнении запроса с помощью интерфейса FMPQuery загрузка ресурсов в базу данных выполняется автоматически. 
fun downloadResources(): Boolean
query Отправляет SQL-запрос к локальной базе данных. 
fun query(query: String): String

Параметры:

  • query. SQL-запрос: DROP TABLE User.
getTableName Получение полного имени таблицы в локальной базе данных, если используется локальный кэш по параметрам и в названии таблицы используется хэш от параметра. Возвращает название таблицы в локальной базе данных. 
fun getTableName(table: FMPTable): String

Параметры:

  • table. Таблица.
dropCache Удаление кэшированных таблиц из базы данных для указанного ресурса. В случае успешного удаления таблиц из базы данных возвращает true. 
fun dropCache(resource: FMPResource): Boolean

Параметры:

  • resource. Ресурс, кэшированные таблицы которого должны быть удалены.
drop Удаление файла базы данных из файловой системы. 
fun drop(): Boolean

Методы, унаследованные от интерфейса FMPObject

Метод Описание
toJSON Сериализация объекта в JSON. 
fun toJSON(): String
copy Получение экземпляра конструктора для копирования интерфейса. Возвращает экземпляр в виде: <название интерфейса>.Builder. 
fun copy(): Builder
equals Сравнивает объекты между собой по ключевым параметрам. Например, два FMPUser одинаковы, если имеют одинаковый логин. 
fun equals(other: Any?): Boolean

Параметры:

  • other. Любой другой объект.
hashCode Выдает хэш-код на основе ключевых параметров. 
fun hashCode(): Int
toString Выводит основную информацию об объекте в не сериализованном виде. Для сериализации используйте метод toJSON(). 
fun toString(): String

См. также:

Фреймворк FMP | Интерфейсы