-
Notifications
You must be signed in to change notification settings - Fork 22.4k
/
index.md
111 lines (88 loc) · 3.67 KB
/
index.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
---
title: IDBCursor.delete()
slug: Web/API/IDBCursor/delete
page-type: web-api-instance-method
tags:
- API
- Database
- IDBCursor
- IndexedDB
- Method
- Reference
- Storage
- delete
browser-compat: api.IDBCursor.delete
---
{{APIRef("IndexedDB")}}
The **`delete()`** method of the {{domxref("IDBCursor")}}
interface returns an {{domxref("IDBRequest")}} object, and, in a separate thread,
deletes the record at the cursor's position, without changing the cursor's position.
Once the record is deleted, the cursor's value is set to null.
Be aware that you can't call `delete()` (or
{{domxref("IDBCursor.update()")}}) on cursors obtained from
{{domxref("IDBIndex.openKeyCursor()")}}. For such needs, you have to use
{{domxref("IDBIndex.openCursor()")}} instead.
{{AvailableInWorkers}}
## Syntax
```js
delete()
```
### Parameters
None.
### Return value
An {{domxref("IDBRequest")}} object on which subsequent events related to this
operation are fired. The result attribute is set to undefined.
### Exceptions
This method may raise a {{domxref("DOMException")}} of one of the following types:
- `TransactionInactiveError` {{domxref("DOMException")}}
- : Thrown if this IDBCursor's transaction is inactive.
- `ReadOnlyError` {{domxref("DOMException")}}
- : Thrown if the transaction mode is read-only.
- `InvalidStateError` {{domxref("DOMException")}}
- : Thrown if the cursor was created using {{domxref("IDBindex.openKeyCursor")}}, is currently being iterated, or has iterated past its end.
## Examples
In this simple fragment we create a transaction, retrieve an object store, then use a
cursor to iterate through all the records in the object store. If the
`albumTitle` of the current cursor is "Grace under pressure", we delete that
entire record using `var request = cursor.delete();`.
The cursor does not require us to select the data based on a key; we can just grab all
of it. Also note that in each iteration of the loop, you can grab data from the current
record under the cursor object using `cursor.value.foo`. For a complete
working example, see our [IDBCursor example](https://github.com/mdn/dom-examples/tree/master/indexeddb-examples/idbcursor) ([View the example live](https://mdn.github.io/indexeddb-examples/idbcursor/)).
```js
function deleteResult() {
list.textContent = '';
const transaction = db.transaction(['rushAlbumList'], 'readwrite');
const objectStore = transaction.objectStore('rushAlbumList');
objectStore.openCursor().onsuccess = function(event) {
const cursor = event.target.result;
if(cursor) {
if(cursor.value.albumTitle === 'Grace under pressure') {
const request = cursor.delete();
request.onsuccess = function() {
console.log('Deleted that mediocre album from 1984. Even Power windows is better.');
};
} else {
const listItem = document.createElement('li');
listItem.innerHTML = '<strong>' + cursor.value.albumTitle + '</strong>, ' + cursor.value.year;
list.appendChild(listItem);
}
cursor.continue();
} else {
console.log('Entries displayed.');
}
};
};
```
## Specifications
{{Specifications}}
## Browser compatibility
{{Compat}}
## See also
- [Using IndexedDB](/en-US/docs/Web/API/IndexedDB_API/Using_IndexedDB)
- Starting transactions: {{domxref("IDBDatabase")}}
- Using transactions: {{domxref("IDBTransaction")}}
- Setting a range of keys: {{domxref("IDBKeyRange")}}
- Retrieving and making changes to your data: {{domxref("IDBObjectStore")}}
- Using cursors: {{domxref("IDBCursor")}}
- Reference example: [To-do Notifications](https://github.com/mdn/to-do-notifications/tree/gh-pages) ([View the example live](https://mdn.github.io/to-do-notifications/)).