MDN’s new design is in Beta! A sneak peek: https://blog.mozilla.org/opendesign/mdns-new-design-beta/

API: IndexedDB documentation status

This page tracks ongoing documentation work in the MDN IndexedDB section. Feel free to contribute!

Summary

Pages Needs* tags Missing tags Editorial reviews Technical reviews Outdated pages Missing pages Dev-doc-needed bugs Documentation requests
104 2 (2%) 0 (0%) 2 (2%) 6 (6%) 4 (4%) 0 (0%) 3 (3%) 17 (17%)

See also localization status of this section.

Needs* tags

Found 2 pages. Learn more about how to deal with meta-tags.

Editorial reviews

Found 2 pages. Learn more about how to do an editorial review.

Technical reviews

Found 6 pages. Learn more about how to do a technical review.

Outdated pages

Found 4 pages. These pages haven't been updated in over a year. Outdated pages can have problems with both content and format. Look at these pages and consider: Is this page talking about the Web of today? Does it look consistent with newer pages in this topic area? If not, make any needed changes.

Dev-doc-needed bugs

Found 3 bugs. Learn more about how to resolve a dev-doc-needed bug.

Bug Summary Release
1246828 Push shutdown back to profile-before-change2 mozilla50
975699 Remove mozIndexedDB again mozilla38
1006485 FileHandle: Rename FileHandle to MutableFile and LockedFile to FileHandle mozilla33

Browse as bug list.

Documentation requests

Found 17 bugs. Documentation request bugs can contain various kinds work related to MDN pages. Read through the bug and ask questions in the bug if in doubt.

Bug Summary
1231081 IDBRequest.onsuccess and onerror docs missing event explanation
1248269 Example is irrelevant to the page topic
1273290 Incorrect Usage Example of IDBTransaction
1282948 IndexedDB: Cover transaction types and transaction upgrades in more detail
1301657 Document IndexedDB's 'blocked' event
1357498 Does not explain how IndexedDB decides whether to update an existing record or add a new one
1357500 Index documentation doesn't mention what types the indexed fields can be
1357624 List of IDBKeyRange methods should call out which methods can be called on the global IDBKeyRange object, and which ones can be called on a IDBKeyRange instance
1358699 IDBVersionChangeEvent.oldVersion doesn't mention what oldVersion is on first setup
1358700 IDBDatabase.deleteObjectStore() should have a more reasonable example and describe how to handle upgrades vs first setup
1358701 IDBObjectStore.put should mention that you have to supply the primary key in the second argument if you want to modify a record and your object store uses an autoIncrement key
1358702 IDBObjectStore.put should recommend calling cursor.update instead, if you want to modify a record that you have a cursor to
1358704 IDBObjectStore.delete mentions a "cursor" in the InvalidStateError description - which cursor is it talking about?
1358705 IDBObjectStore.delete should suggest using cursor.delete() instead, if you have a cursor
1358707 IDBCursor.update and IDBCursor.delete documentation should mention that it cannot be used on cursors obtained through index.openKeyCursor
1358922 IDBFactory.deleteDatabase() should mention that attempting to delete a non-existent database is not an error
1374973 Shouldn't success only be reported from the transaction and not from the request?

Browse as bug list.

Localizations

Please help us to localize this documentation into different languages. Read more about how to translate.

Language Pages Translated Translations up to date
af 101 0 (0%) 0 (0%)
bn-BD 101 1 (0%) 0 (0%)
de 101 3 (2%) 1 (33%)
es 101 8 (7%) 1 (12%)
fa 101 0 (0%) 0 (0%)
fr 101 85 (84%) 79 (92%)
it 101 1 (0%) 0 (0%)
ja 101 17 (16%) 5 (29%)
ko 101 3 (2%) 1 (33%)
pl 101 0 (0%) 0 (0%)
pt-BR 101 3 (2%) 0 (0%)
pt-PT 101 0 (0%) 0 (0%)
ro 101 0 (0%) 0 (0%)
ru 101 2 (1%) 0 (0%)
zh-CN 101 14 (13%) 1 (7%)
zh-TW 101 4 (3%) 0 (0%)

Notes

Tagging standard

  • The tag "Indexed DB API" is the one to use.
  • We also list here pages with the deprecated "indexeddb" tag.

Other tasks to do

  • TBD

Tutorial to-do list

  • TBD

Notes for translators

Any notes here? Where do we expect updates, so that localizers don't translate and update too often?

Specifications

The following specifications are tracked by this status page:

TBD

Help the 'API/IndexedDB' documentation project…
Topic driver : Eric Shepherd (IRC nickname: sheppy)
Look at the current status of the 'API/IndexedDB' documentation.
Don't hesitate to contact us on #mdn or on the MDN discourse group/list:

Document Tags and Contributors

 Contributors to this page: jswisher, fscholz, teoli
 Last updated by: jswisher,