From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../api/idbdatabase/createobjectstore/index.html | 178 ++++++++++++++++ .../api/idbdatabase/deleteobjectstore/index.html | 114 +++++++++++ files/zh-cn/web/api/idbdatabase/index.html | 225 +++++++++++++++++++++ .../web/api/idbdatabase/onversionchange/index.html | 99 +++++++++ 4 files changed, 616 insertions(+) create mode 100644 files/zh-cn/web/api/idbdatabase/createobjectstore/index.html create mode 100644 files/zh-cn/web/api/idbdatabase/deleteobjectstore/index.html create mode 100644 files/zh-cn/web/api/idbdatabase/index.html create mode 100644 files/zh-cn/web/api/idbdatabase/onversionchange/index.html (limited to 'files/zh-cn/web/api/idbdatabase') diff --git a/files/zh-cn/web/api/idbdatabase/createobjectstore/index.html b/files/zh-cn/web/api/idbdatabase/createobjectstore/index.html new file mode 100644 index 0000000000..99ea2480df --- /dev/null +++ b/files/zh-cn/web/api/idbdatabase/createobjectstore/index.html @@ -0,0 +1,178 @@ +--- +title: IDBDatabase.createObjectStore() +slug: Web/API/IDBDatabase/createObjectStore +translation_of: Web/API/IDBDatabase/createObjectStore +--- +

{{ APIRef("IndexedDB") }}

+ +
+

{{domxref("IDBDatabase")}} 接口的 createObjectStore() 方法创建并返回一个新的 object store 或 index。

+
+ +

此方法接受一个参数作为 store 的名称，也接受一个可选的参数对象让你可以定义重要的可选属性。你可以用这个属性唯一的标识此 store 中的每个对象。因为参数是一个标识符，所以 store 中的每一个对象都应有此属性并保证此属性唯一。

+ +

此方法只能在 versionchange 事务中被调用。

+ +

{{AvailableInWorkers}}

+ +

语法

+ +
var objectStore = IDBDatabase.createObjectStore(name);
+var objectStore = IDBDatabase.createObjectStore(name, options);
+
+ +

参数

+ +
+
name
+
被创建的 object store 的名称。请注意创建空名称的 object store 是被允许的。
+
optionalParameters {{optional_inline}}
+
+

可选的对象，它的属性是此方法的可选参数，其中包括以下的属性：

+ + + + + + + + + + + + + + + + + + +
AttributeDescription
keyPath +

key path 被用在新的 object store 上。如果为空或未指定，object store 创建时将没有 key path，而是使用 out-of-line keys 。你也能传一个数组作为 keyPath 。

+
autoIncrement如果为 true,  object store 有一个 key generator. 默认为 false。
+ +

未知参数将被忽略。

+
+
+ +

返回值

+ +
+
{{domxref("IDBObjectStore")}}
+
新创建的 object store 对象。
+
+ +

异常

+ +

This method may raise a此方法可能会抛出一个 {{domxref("DOMException")}} 带有以下所列其中一种类型的 {{domxref("DOMError")}} ：

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ExceptionDescription
InvalidStateError +

在非versionchange事务中调用时发生。在一些旧版本的 Webkit 浏览器，你必须先调用{{APIRef("IDBVersionChangeRequest.setVersion")}}方法。

+
TransactionInactiveError +

如果对不存在的源数据库发出请求（例如，已被删除的）。此外，在 Firefox 版本小于 41 中，会抛出误导性的 InvalidStateError 错误，这一问题现已修复（请参阅 {{Bug("1176165")}}）。

+
ConstraintError +

数据库中已存同名的对象存储（名字区分大小写）

+
InvalidAccessError +

如果 autoIncrement 设置为 true，并且 keyPath 是空字符串或包含空字符串的数组。

+
+ +

Example

+ +
 // 打开一个数据库
+  var request = window.indexedDB.open("toDoList", 4);
+
+  // This handler is called when a new version of the database
+  // is created, either when one has not been created before
+  // or when a new version number is submitted by calling
+  // window.indexedDB.open().
+  // This handler is only supported in recent browsers.
+  request.onupgradeneeded = function(event) {
+    var db = event.target.result;
+
+    db.onerror = function(event) {
+      note.innerHTML += '<li>Error loading database.</li>';
+    };
+
+    // Create an objectStore for this database
+
+    var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });
+
+    // define what data items the objectStore will contain
+
+    objectStore.createIndex("hours", "hours", { unique: false });
+    objectStore.createIndex("minutes", "minutes", { unique: false });
+    objectStore.createIndex("day", "day", { unique: false });
+    objectStore.createIndex("month", "month", { unique: false });
+    objectStore.createIndex("year", "year", { unique: false });
+
+    objectStore.createIndex("notified", "notified", { unique: false });
+
+    note.innerHTML += '<li>Object store created.</li>';
+  };
+ +

Specification

+ + + + + + + + + + + + + + + + + + + +
SpecificationStatusComment
{{SpecName('IndexedDB', '#widl-IDBDatabase-createObjectStore-IDBObjectStore-DOMString-name-IDBObjectStoreParameters-optionalParameters', 'createObjectStore()')}}{{Spec2('IndexedDB')}}
{{SpecName("IndexedDB 2", "#dom-idbdatabase-createobjectstore", "createObjectStore()")}}{{Spec2("IndexedDB 2")}}
+ +

Browser compatibility

+ +
+ + +

{{Compat("api.IDBDatabase.createObjectStore")}}

+
+ +

See also

+ + diff --git a/files/zh-cn/web/api/idbdatabase/deleteobjectstore/index.html b/files/zh-cn/web/api/idbdatabase/deleteobjectstore/index.html new file mode 100644 index 0000000000..67e4d08b30 --- /dev/null +++ b/files/zh-cn/web/api/idbdatabase/deleteobjectstore/index.html @@ -0,0 +1,114 @@ +--- +title: IDBDatabase.deleteObjectStore() +slug: Web/API/IDBDatabase/deleteObjectStore +translation_of: Web/API/IDBDatabase/deleteObjectStore +--- +

{{ APIRef("IndexedDB") }}

+ +
+

 deleteObjectStore() 方法从 {{domxref("IDBDatabase")}} 中销毁指定名称的对象存储，及这个对象存储所包含的任何索引。

+
+ +

与 {{ domxref("IDBDatabase.createObjectStore") }} 一样，此方法只能在versionchange事务中调用。

+ +

{{AvailableInWorkers}}

+ +

语法

+ +
dbInstance.deleteObjectStore(name);
+ +

参数

+ +
+
name
+
将要删除的对象存储的名字
+
+ +

异常

+ +

此方法可能会引发下列 {{domxref("DOMException")}}  异常：

+ + + + + + + + + + + + + + + + + + + + + + +
ExceptionDescription
InvalidStateErrorOccurs if the method was not called from a versionchange transaction callback. For older WebKit browsers, you must call {{ APIRef("IDBVersionChangeRequest.setVersion")}} first.
TransactionInactiveErrorOccurs if a request is made on a source database that doesn't exist (e.g. has been deleted or removed.) In Firefox previous to version 41, an InvalidStateError was raised in this case as well, which was misleading; this has now been fixed (see {{Bug("1176165")}}.)
NotFoundErrorYou are trying to delete an object store that does not exist. Names are case sensitive.
+ +

示例

+ +
var dbName = "sampleDB";
+var dbVersion = 2;
+var request = indexedDB.open(dbName, dbVersion);
+
+request.onupgradeneeded = function(e) {
+  var db = request.result;
+  if (e.oldVersion < 1) {
+    db.createObjectStore("store1");
+  }
+
+  if (e.oldVersion < 2) {
+    db.deleteObjectStore("store1");
+    db.createObjectStore("store2");
+  }
+
+  // etc. for version < 3, 4...
+};
+ +

Specification

+ + + + + + + + + + + + + + + + + + + +
SpecificationStatusComment
{{SpecName('IndexedDB', '#widl-IDBDatabase-deleteObjectStore-void-DOMString-name', 'deleteObjectStore()')}}{{Spec2('IndexedDB')}}
{{SpecName("IndexedDB 2", "#dom-idbdatabase-deleteobjectstore", "deleteObjectStore()")}}{{Spec2("IndexedDB 2")}}
+ +

Browser compatibility

+ +
+ + +

{{Compat("api.IDBDatabase.deleteObjectStore")}}

+
+ +

See also

+ + diff --git a/files/zh-cn/web/api/idbdatabase/index.html b/files/zh-cn/web/api/idbdatabase/index.html new file mode 100644 index 0000000000..1bf1663f7b --- /dev/null +++ b/files/zh-cn/web/api/idbdatabase/index.html @@ -0,0 +1,225 @@ +--- +title: IDBDatabase +slug: Web/API/IDBDatabase +tags: + - IDBDatabase +translation_of: Web/API/IDBDatabase +--- +

{{APIRef("IndexedDB")}}

+ +
+

IndexedDB 中的 IDBDatabase 接口提供一个到 数据库的连接; 你可以使用 IDBDatabase 对象在数据库中打开一个transaction , 然后进行操作或者删除数据库中的对象。这是唯一一个能够访问和管理数据库版本的接口。 

+ + + +

{{AvailableInWorkers}}

+
+ +
+

注意:在IndexedDB中所做的所有事情总是发生在事务的上下文中，表示与数据库中的数据的交互。IndexedDB中的所有对象——包括对象存储、索引和游标——都与特定事务绑定。因此，在事务之外您不能执行命令、访问数据或打开任何东西。

+
+ +
+

注意：请注意，从Firefox 40开始，IndexedDB事务具有宽松的持久性保证以提高性能（请参阅bug 1112702）以前在readwrite事务中IDBTransaction.oncomplete被触发只有当所有数据都保证已刷新到磁盘时。在Firefox 40+中，complete事件在操作系统被告知写入数据之后被触发，但可能在该数据实际上被刷新到磁盘之前。该complete因此，事件可以比以前更快地传递，但是，如果操作系统崩溃或者在将数据刷新到磁盘之前系统电源丢失，则整个事务将丢失的可能性很小。由于这种灾难性事件很少见，大多数消费者不应该进一步关注自己。如果由于某种原因必须确保持久性（例如，您要存储以后无法重新计算的关键数据），则可以complete通过使用实验（非标准）readwriteflush模式创建事务来强制事务在传递事件之前刷新到磁盘（请参阅IDBDatabase.transaction）。

+
+ +

方法

+ +

继承自: EventTarget

+ +
+
{{domxref("IDBDatabase.close()")}}
+
在一个单独的线程中关闭数据库连接并立即返回。
+
{{domxref("IDBDatabase.createObjectStore()")}}
+
创建并返回一个新的 object store 或者 index。
+
{{domxref("IDBDatabase.deleteObjectStore()")}}
+
根据给定的名字，删除在当前连接的数据库中的 object store 和 相关的索引。 
+
{{domxref("IDBDatabase.transaction()")}}
+
立即返回一个包含{{domxref("IDBTransaction.objectStore")}} 方法的 transaction 对象。你可以用这个对象来操作object store。这个操作是在一个单独的线程中执行的。
+
+ +

属性

+ +
+
{{domxref("IDBDatabase.name")}} {{readonlyInline}}
+
{{ domxref("DOMString") }}类型，当前连接数据库名  。
+
{{domxref("IDBDatabase.version")}} {{readonlyInline}}
+
64-bit 整型数，当前连接数据库的版本 。当数据第一次被创建时，这个属性是一个空的字符串。 
+
{{domxref("IDBDatabase.objectStoreNames")}} {{readonlyInline}}
+
{{ domxref("DOMStringList") }}类型，当前连接连接数据库中所有的object store 名字列表。
+
+ +

Event handlers

+ +
+
{{domxref("IDBDatabase.onabort")}}
+
在中断数据库访问时触发。
+
{{domxref("IDBDatabase.onerror")}}
+
当访问数据库失败时触发。
+
{{domxref("IDBDatabase.onversionchange")}}
+
+

当数据库结构发生更改时触发

+ +

({{domxref("IDBOpenDBRequest.onupgradeneeded")}}事件或在其他地方请求 {{domxref("IDBFactory.deleteDatabase")}} 时（最可能在同一台计算机上的另一个窗口/选项卡中）这与版本更改事务（请参阅参考资料{{domxref("IDBVersionChangeEvent")}})不同，但它是相关的。

+
+
+ +

示例

+ +

在下面的代码中, 异步打开了一个数据库连接 ({{domxref("IDBFactory")}}), 并处理成功或者异常事件, 如果触发了upgrade事件就需要创建一个新的object store  ({{ domxref("IDBdatabase") }})。如果想看完整的例子, 可以使用 To-do Notifications 应用(view example live.)

+ +

+// 我们先打开一个数据库
+  var DBOpenRequest = window.indexedDB.open("toDoList", 4);
+
+  // 当数据库打开出错/成功时，以下两个事件处理程序将分别对IDBDatabase对象进行下一步操作
+  DBOpenRequest.onerror = function(event) {
+    note.innerHTML += '<li>Error loading database.</li>';
+  };
+
+  DBOpenRequest.onsuccess = function(event) {
+    note.innerHTML += '<li>Database initialised.</li>';
+
+    // 将打开数据库的结果存储在db变量中，该变量将在后面的代码中被频繁使用
+    db = DBOpenRequest.result;
+
+    // 运行displayData()方法，用IDB中已经存在的所有待办事项列表数据填充到任务列表中
+    displayData();
+  };
+
+  // 当试图打开一个尚未被创建的数据库，或者试图连接一个数据库还没被创立的版本时，onupgradeneeded事件会被触发
+
+  DBOpenRequest.onupgradeneeded = function(event) {
+    var db = event.target.result;
+
+    db.onerror = function(event) {
+      note.innerHTML += '<li>Error loading database.</li>';
+    };
+
+    // 使用IDBDatabase.createObjectStore方法，可创建一个对象存储区
+
+    var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });
+
+    // 定义objectStore将包含哪些数据项
+
+    objectStore.createIndex("hours", "hours", { unique: false });
+    objectStore.createIndex("minutes", "minutes", { unique: false });
+    objectStore.createIndex("day", "day", { unique: false });
+    objectStore.createIndex("month", "month", { unique: false });
+    objectStore.createIndex("year", "year", { unique: false });
+
+    objectStore.createIndex("notified", "notified", { unique: false });
+
+    note.innerHTML += '<li>Object store created.</li>';
+  };
+ +

下一行打开数据库上的事务，然后打开一个对象存储，然后我们可以在其中操作数据。

+ +

+    var objectStore = db.transaction('toDoList').objectStore('toDoList');
+ +

规范

+ + + + + + + + + + + + + + +
SpecificationStatusComment
{{SpecName('IndexedDB', '#idl-def-IDBDatabase', 'IDBDatabase')}}{{Spec2('IndexedDB')}} 
+ +

浏览器兼容性

+ +
{{CompatibilityTable}}
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureChromeFirefox (Gecko)Internet ExplorerOperaSafari (WebKit)
Basic support23{{property_prefix("webkit")}}
+ 24		10 {{property_prefix("moz")}}
+ {{CompatGeckoDesktop("16.0")}}		10, partial157.1
Available in workers{{CompatVersionUnknown}}{{CompatGeckoMobile("37.0")}}{{CompatUnknown}}{{CompatVersionUnknown}}{{CompatUnknown}}
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAndroidFirefox Mobile (Gecko)Firefox OSIE PhoneOpera MobileSafari Mobile
Basic support4.4{{CompatGeckoMobile("22.0")}}1.0.110228
Available in workers{{CompatVersionUnknown}}{{CompatGeckoMobile("37.0")}}{{CompatVersionUnknown}}{{CompatUnknown}}{{CompatVersionUnknown}}{{CompatUnknown}}
+
+ +
+

Be careful in Chrome as it still implements the old specification along with the new one. Similarly it still has the prefixed webkitIndexedDB property even if the unprefixed indexedDB is present.

+
+ +

See also

+ + + +

 

diff --git a/files/zh-cn/web/api/idbdatabase/onversionchange/index.html b/files/zh-cn/web/api/idbdatabase/onversionchange/index.html new file mode 100644 index 0000000000..97227eacac --- /dev/null +++ b/files/zh-cn/web/api/idbdatabase/onversionchange/index.html @@ -0,0 +1,99 @@ +--- +title: IDBDatabase.onversionchange +slug: Web/API/IDBDatabase/onversionchange +translation_of: Web/API/IDBDatabase/onversionchange +--- +

{{ APIRef("IndexedDB") }}

+ +

 {{domxref("IDBDatabase")}} 中的 onversionchange 事件处理器能处理版本更新事件，此事件能在任意地方 (很可能在同一台计算机上的另一个窗口/选项卡中)导致数据库结构更改（{{ domxref("IDBOpenDBRequest.onupgradeneeded")}} 事件 或 {{ domxref("IDBFactory.deleteDatabase")}} 事件）的时候被触发 。

+ +
+

onversionchange 与 versionchange 是不相同的事件（但两者是有关联的）。

+ +

{{AvailableInWorkers}}

+
+ +

语法

+ +
IDBDatabase.onversionchange = function(event) { ... }
+ +

举例

+ +

本例展示了一个创建新对象仓库的 {{domxref("IDBOpenDBRequest.onupgradeneeded")}} 代码块；代码中包含用于处理失败操作的 onerror 和 onabort 函数，以及一个 onversionchange 函数用以在数据库结构被改变时通知用户。

+ +
request.onupgradeneeded = function(event) {
+  var db = event.target.result;
+
+  db.onerror = function(event) {
+    note.innerHTML += '<li>Error opening database.</li>';
+  };
+
+  db.onabort = function(event) {
+    note.innerHTML += '<li>Database opening aborted!</li>';
+  };
+
+  // 给这个数据库创建对象仓库
+
+  var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });
+
+  // 定义对象仓库中包含的数据项
+
+  objectStore.createIndex("hours", "hours", { unique: false });
+  objectStore.createIndex("minutes", "minutes", { unique: false });
+  objectStore.createIndex("day", "day", { unique: false });
+  objectStore.createIndex("month", "month", { unique: false });
+  objectStore.createIndex("year", "year", { unique: false });
+
+  objectStore.createIndex("notified", "notified", { unique: false });
+
+  note.innerHTML += '<li>Object store created.</li>';
+
+  db.onversionchange = function(event) {
+    note.innerHTML += '<li>a database change has occurred; you should refresh this
+                       browser window, or close it down and use the other open version of
+                       this application, wherever it exists.</li>';
+  };
+};
+ +

格式

+ + + + + + + + + + + + + + + + + + + +
格式状态注释
{{SpecName('IndexedDB', '#widl-IDBDatabase-onversionchange', 'onversionchange')}}{{Spec2('IndexedDB')}} 
{{SpecName("IndexedDB 2", "#dom-idbdatabase-onversionchange", "onversionchange")}}{{Spec2("IndexedDB 2")}} 
+ +

浏览器兼容性

+ +
+ + +

{{Compat("api.IDBDatabase.onversionchange")}}

+
+ +

更多参考

+ + -- cgit v1.2.3-54-g00ecf