put() 方法在 IDBObjectStore interface updates a given record in a database, or inserts a new record if the given item does not already exist.

It returns an IDBRequest object, and, in a separate thread, creates a structured clone of the value and stores the cloned value in the object store. This is for adding new records, or updating existing records in an object store when the transaction's mode is readwrite . If the record is successfully stored, then a success event is fired on the returned request object with the result set to the key for the stored record, and the transaction set to the transaction in which this object store is opened.

The put method is an update or insert method. See the IDBObjectStore.add method for an insert only 方法。

Bear in mind that if you have a IDBCursor to the record you want to update, updating it with IDBCursor.update() is preferable to using IDBObjectStore.put() . Doing so makes it clear that an existing record will be updated, instead of a new record being inserted.

注意: 此特征可用于 Web 工作者 .

句法

let request = objectStore.put(item);
let request = objectStore.put(item, key);
					

参数

item

The item you wish to update (or insert).

key 可选
The primary key of the record you want to update (e.g. from IDBCursor.primaryKey ). This is only needed for object stores that have an autoIncrement primary key, therefore the key is not in a field on the record object. In such cases, calling put(item) will always insert a new record, because it doesn't know what existing record you might want to modify.

返回值

IDBRequest object on which subsequent events related to this operation are fired.

异常

此方法可能引发 DOMException of one of the following types:

异常 描述
ReadOnlyError The transaction associated with this operation is in read-only mode .
TransactionInactiveError This IDBObjectStore 's transaction is inactive.
DataError Any of the following conditions apply:

  • The object store uses in-line keys or has a key generator, and a key parameter was provided.
  • The object store uses out-of-line keys and has no key generator, and no key parameter was provided.
  • The object store uses in-line keys but no key generator, and the object store's key path does not yield a valid key.
  • The key parameter was provided but does not contain a valid key.
InvalidStateError IDBObjectStore has been deleted or removed.
DataCloneError The data being stored could not be cloned by the internal structured cloning algorithm.

参数

The value to be stored.

key

The key to use to identify the record. If unspecified, it results to null. If the object store has a key generator (e.g. autoincrement) the key of the object must be passed in to update the object.

范例

The following example requests a given record title; when that request is successful the onsuccess function gets the associated record from the IDBObjectStore (made available as objectStoreTitleRequest.result ), updates one property of the record, and then puts the updated record back into the object store in another request with put() . For a full working example, see our 待办通知 app ( 实时查看范例 )。

const title = "Walk dog";
// Open up a transaction as usual
const objectStore = db.transaction(['toDoList'], "readwrite").objectStore('toDoList');
// Get the to-do list object that has this title as it's title
const objectStoreTitleRequest = objectStore.get(title);
objectStoreTitleRequest.onsuccess = () => {
  // Grab the data object returned as the result
  const data = objectStoreTitleRequest.result;
  // Update the notified value in the object to "yes"
  data.notified = "yes";
  // Create another request that inserts the item back into the database
  const updateTitleRequest = objectStore.put(data);
  // Log the transaction that originated this request
  console.log("The transaction that originated this request is " + updateTitleRequest.transaction);
  // When this new request succeeds, run the displayData() function again to update the display
  updateTitleRequest.onsuccess = () => {
    displayData();
  };
};
					

规范

规范 状态 注释
索引数据库 API 2.0
The definition of 'put()' in that specification.
推荐
索引数据库 API 草案
The definition of 'put()' in that specification.
推荐

浏览器兼容性

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request. 更新 GitHub 上的兼容性数据
桌面 移动
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet
put Chrome 24
24
23 — 57 Prefixed
Prefixed Implemented with the vendor prefix: webkit
Edge 12 Firefox 16
16
10 — 16 Prefixed
Prefixed Implemented with the vendor prefix: moz
IE 部分支持 10 Opera 15 Safari 7 WebView Android Yes
Yes
? — 57 Prefixed
Prefixed Implemented with the vendor prefix: webkit
Chrome Android 25
25
25 — 57 Prefixed
Prefixed Implemented with the vendor prefix: webkit
Firefox Android 22 Opera Android 14 Safari iOS 8 Samsung Internet Android 1.5
1.5
1.5 — 7.0 Prefixed
Prefixed Implemented with the vendor prefix: webkit

图例

完整支持

完整支持

部分支持

部分支持

要求使用供应商前缀或不同名称。

要求使用供应商前缀或不同名称。

另请参阅

元数据

  • 最后修改: