В таблице перечислены основные методы библиотеки LocalStorageDB.
| Метод | Аргументы | Описание |
|---|---|---|
localStorageDB() |
database_name, storage_engine |
Конструктор - значение storage_engine может быть либо localStorage(по-умолчанию), либо sessionStorage |
isNew() |
Возвращает true, если база данных создана в момент вызова метода-конструктора |
|
drop() |
Удаляет базу данных и вычищает ее из localStorage | |
tableCount() |
Возвращает количество таблиц в базе данных | |
commit() |
Помещает базу данных в localStorage | |
serialize() |
Возвращает всю базу данных как сериализованный JSON | |
tableExists() |
table_name |
Проверяет присутствует ли указанная таблица в базе данных |
createTable() |
table_name, fields |
Создает таблицу. Имена полей передаются в виде массива. “ID” – зарезервированное имя |
dropTable() |
table_name |
Удаляет таблицу из базы данных |
truncate() |
table_name |
Очищает все записи в таблице и обнуляет auto-increment поле “ID” |
rowCount() |
table_name |
Возвращает количество записей в таблице |
insert() |
table_name, data |
Добавляет запись в таблицу и возвращает ее числовой идентификатор (“ID”)data – объектный литерал содержащий пары «имя поля» — «значение».Каждой записи автоматически присваивается идентификатор |
query() |
table_name, query, limit |
Возвращает массив записей (объектный литерал) из таблицы, согласно запросу.query – может быть объектным литералом или иметь значение nulllimit – максимальное количество записей, которые могут быть возвращеныКаждый элемент массива будет иметь свой идентификатор из таблицы, который будет присвоен переменной ID |
update() |
table_name, query, update_function |
Изменяет существующие записи в таблице, согласно запросу и возвращает количество измененных записей.query – объектный литерал или функция. Если этот аргумент отсутствует, то изменяются все записиupdate_function – функция, которая возвращает объектный литерал с измененными значениями |
insertOrUpdate() |
table_name, data, query |
Добавляет данные в таблицу, если в таблице нет таких данных или обновляет их, если данные присутствуют в таблице.query – объектный литерал, функция или nulldata – объектный литерал, содержащий пары «имя поля» - «значение».Возвращает идентификатор добавленной записи, в случае добавления или массив идентификаторов измененных записей. |
deleteRows() |
table_name, query |
Удаляет записи из таблицы, согласно запросу и возвращает количество удаленных записейquery – объектный литерал или функция. Если аргумент отсутствует, то удаляются все записи |
Подробнее ознакомиться с LocalStorageDB и посмотреть примеры использования можно здесь: http://nadh.in/code/localstoragedb/
Оригинал статьи - http://www.coolajax.net/post/localstoragedb-a-tiny-database-layer-for-localstorage.html
Перевод Матвей Земсков