IDBObjectStore: метод add()

Метод add() интерфейса IDBObjectStore возвращает объект IDBRequest, который в отдельном потоке создаёт структурированную копию значения и сохраняет скопированное значение в хранилище объектов. Это предназначено для добавления новых записей в хранилище объектов.

Чтобы определить, успешно ли выполнилась операция добавления, прослушивайте событие complete транзакции, а также событие success запроса IDBObjectStore.add, так как транзакция может всё ещё завершиться ошибкой после срабатывания события об успехе. Другими словами, событие об успехе срабатывает только тогда, когда транзакция успешно помещена в очередь.

Метод add является методом только для вставки. Если в хранилище объектов уже существует запись с ключом, заданным параметром key, то на возвращённом объекте запроса будет вызвано событие об ошибке ConstraintError. Для обновления существующих записей следует использовать метод IDBObjectStore.put вместо этого.

value

Значение, которое нужно сохранить.

key Необязательно

Ключ для идентификации записи. Если не указан, используется значение null.

Объект IDBRequest, на котором будут сгенерированы последующие события, связанные с данной операцией.

Если операция выполнена успешно, значение свойства result запроса будет ключом новой записи.

Этот метод может вызвать исключение DOMException одного из следующих типов:

ReadOnlyError DOMException

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

TransactionInactiveError DOMException

Вызывается, если транзакция данного IDBObjectStore неактивна.

DataError DOMException

Вызывается, если выполняются следующие условия:

• Хранилище объектов использует встроенные ключи или имеет генератор ключей, и параметр ключа был указан.
• Хранилище объектов использует внешние ключи и не имеет генератора ключей, и параметр ключа не был указан.
• Хранилище объектов использует встроенные ключи, но не имеет генератора ключей, и путь к ключу хранилища не возвращает допустимый ключ.
• Параметр ключа был указан, но не содержит допустимый ключ.

InvalidStateError DOMException

Вызывается, если IDBObjectStore был удалён.

DataCloneError DOMException

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

ConstraintError DOMException

Вызывается, если операция вставки завершилась ошибкой, потому что было нарушено ограничение первичного ключа (из-за уже существующей записи с тем же значением первичного ключа).

В следующем примере кода мы открываем транзакцию чтения/записи для нашей базы данных и добавляем некоторые данные в хранилище объектов, используя add(). Обратите также внимание на функции, прикреплённые к обработчикам событий транзакции, чтобы отслеживать результат открытия транзакции в случае успеха или неудачи. Для полного рабочего примера см. наше приложение To-do Notifications (посмотреть пример в браузере).

// Let us open our database
const DBOpenRequest = window.indexedDB.open("toDoList", 4);

DBOpenRequest.onsuccess = (event) => {
  note.appendChild(document.createElement("li")).textContent =
    "Database initialized.";

  // store the result of opening the database in the db variable.
  // This is used a lot below
  db = DBOpenRequest.result;

  // Run the addData() function to add the data to the database
  addData();
};

function addData() {
  // Create a new object ready to insert into the IDB
  const newItem = [
    {
      taskTitle: "Walk dog",
      hours: 19,
      minutes: 30,
      day: 24,
      month: "December",
      year: 2013,
      notified: "no",
    },
  ];

  // open a read/write db transaction, ready for adding the data
  const transaction = db.transaction(["toDoList"], "readwrite");

  // report on the success of the transaction completing, when everything is done
  transaction.oncomplete = (event) => {
    note.appendChild(document.createElement("li")).textContent =
      "Transaction completed.";
  };

  transaction.onerror = (event) => {
    note.appendChild(document.createElement("li")).textContent =
      "Transaction not opened due to error. Duplicate items not allowed.";
  };

  // create an object store on the transaction
  const objectStore = transaction.objectStore("toDoList");

  // Make a request to add our newItem object to the object store
  const objectStoreRequest = objectStore.add(newItem[0]);

  objectStoreRequest.onsuccess = (event) => {
    // report the success of our request
    note.appendChild(document.createElement("li")).textContent =
      "Request successful.";
  };
}

• Использование IndexedDB
• Инициализация транзакций: IDBDatabase
• Использование транзакций: IDBTransaction
• Установка диапазона ключей: IDBKeyRange
• Получение и изменение данных: IDBObjectStore
• Использование курсоров: IDBCursor
• Пример: To-do Notifications (посмотреть пример в браузере).