store — Ключ-значение

Key-value поверх SQLite в каталоге плагина

Ключ-значение

Key-value поверх SQLite в каталоге плагина.

store.open

Открывает хранилище.

store.open(name)

Аргументы

#	имя	тип
1	name	string	имя хранилища

Возвращает

тип
store	объект хранилища

Ключ — строка, значение — таблица, число, строка или boolean. Повторный вызов с тем же именем в том же плагине возвращает тот же объект: два объекта над одним файлом означали бы две очереди записи, и вторая затирала бы первую.

Файл ложится в plugin.data_dir().

s:get

Читает значение по ключу.

s:get(key)

Аргументы

#	имя	тип
1	key	string	ключ

Возвращает

тип
any | nil	значение или nil

Видит то, что положено через set, ещё до записи на диск.

s:set

Кладёт значение в очередь записи.

s:set(key, value)

Аргументы

#	имя	тип
1	key	string	ключ
2	value	any	таблица, число, строка или boolean

Возвращает

тип
store	сам объект, для цепочки

s:delete

Удаляет ключ.

s:delete(key)

Аргументы

#	имя	тип
1	key	string	ключ

Возвращает

тип
store	сам объект

s:keys

Все ключи хранилища.

s:keys()

Возвращает

тип
table	отсортированный массив строк

Учитывает то, что ещё лежит в очереди записи.

s:all

Всё содержимое хранилища.

s:all()

Возвращает

тип
table	{ [key] = value }

Читает всё в память — это для отчёта или миграции, не для кода на таймере.

s:flush

Записывает очередь на диск одной транзакцией.

s:flush()

Возвращает

тип
boolean	true при успехе
string	причина при ошибке

Вызывается сам на map_change и при выгрузке плагина. Явно нужен, только если данные должны лечь на диск прямо сейчас.

Записи откладываются намеренно: вставка вне транзакции — отдельный коммит с синхронизацией на диск, и делать так на каждый фраг нельзя.

s:pending

Сколько записей ждёт в очереди.

s:pending()

Возвращает

тип
number	количество