JS--IndexedDB(非全面指南)

一、 基本概念(中文版)
二、名词解释(中文版)
三、 IDBFactory对象(等价window.indexedDB)
  • open(name,version): 返回IDBOpenDBRequest对象,
  • cmp(value1,value2):将两个值作为键进行比较,以确定IndexedDB操作的相等性和排序,例如存储和迭代。返回值 -1为< 0为= 1为>
  • delete​Database() 返回IDBOpenDBRequest对象
var DBDeleteRequest = window.indexedDB.deleteDatabase("toDoList");

DBDeleteRequest.onerror = function(event) {
  console.log("Error deleting database.");
};
 
DBDeleteRequest.onsuccess = function(event) {
  console.log("Database deleted successfully");
    
  console.log(event.result); // should be undefined
};
四、IDBOpenDBRequest 接口

blocked事件
upgradeneeded事件

var db;

var request = window.indexedDB.open("library", 3);

request.onupgradeneeded = function(event) {
  db = request.result;
 
  db.onerror = function(errorEvent) {
    note.innerHTML += '<li>Error loading database.</li>';
  };

  if (event.oldVersion < 1) {
   
    var store = db.createObjectStore("books", {keyPath: "isbn"});
    var titleIndex = store.createIndex("by_title", "title", {unique: true});
    var authorIndex = store.createIndex("by_author", "author");
  }
  if (event.oldVersion < 2) {
   
    var bookStore = request.transaction.objectStore("books");
    var yearIndex = bookStore.createIndex("by_year", "year");
  }
  if (event.oldVersion < 3) {
    var magazines = db.createObjectStore("magazines");
    var publisherIndex = magazines.createIndex("by_publisher", "publisher");
    var frequencyIndex = magazines.createIndex("by_frequency", "frequency");
  }
};

request.onerror = function(event) {
  console.log(event)
};

request.onsuccess = function(event) {
  db = request.result;
};
五、 IDBDatabase对象
  • 事件 :
    • abort:在中断数据库访问时触发
    • error:当访问数据库失败时触发。
    • versionchange:当数据库结构发生更改时触发 close
  • 属性 :
    • name :当前连接数据库名
    • version:当前连接数据库的版本
    • objectStoreNames:当前连接连接数据库中所有的object store 名字列表
  • 方法 :
    • close() :在一个单独的线程中关闭数据库连接并立即返回。
    • create​Object​Store():创建并返回一个新的 object store 或 index
    • delete​Object​Store():此方法只能在 versionchange 事务中被调用。
    • transaction(storeNames,mode):开启一个事务
   // 键生成器和keyPath
    var objectStore = db.createObjectStore("names", { autoIncrement : true }); //键生成器
    var objectStore = db.createObjectStore("customers", { keyPath: "ssn" }); //keyPath
    var objectStore = db.createObjectStore("names", { keyPath: 'id', autoIncrement: true });
六、IDBTransacation对象(事务)
  • 事务提供了三种模式:readonlyreadwriteversionchange
  • 事务接收三种不同的 DOM 事件:errorabortcomplete
  • 事件:upgradeneeded``complete``abort``success``error``blocked``versionchange``close
  • 属性:db error mode object​Store​Names
  • 方法:abort() object​Store()
  // 开启一个事务
  var transaction = db.transaction(["customers"], "readwrite");
  • transaction() 方法接受两个参数(一个是可选的)并返回一个事务对象。第一个参数是事务希望跨越的对象存储空间的列表。如果你希望事务能够跨越所有的对象存储空间你可以传入一个空数组。如果你没有为第二个参数指定任何内容,你得到的是只读事务。如果你想写入数据,你需要传入 "readwrite" 标识。
  • 事务方法返回一个包含IDBIndex.objectStore方法的事务对象,使用 IDBIndex.objectStore你可以访问你的对象仓库。
五、IDBObjectStore对象
  • 属性 : auto​Increment index​Names key​Path name transaction
  • 事件 upgradeneeded complete abort success error blocked versionchange close
方法 参数 返回 描述
add() value[, key] IDBRequest add方法只能插入数据。
clear () IDBRequest
getAll() [A key or IDBKeyRange[,在找到多个值时要返回的值的数量] IDBRequest
getAllKeys() 同上 IDBRequest
count() 参数可以是键,或键范围(key range) IDBRequest
createIndex() (in DOMString name, in DOMString keyPath, in optional boolean unique) IDBIndex 该方法只能从versionchange事务模式的回调方法中被调用。
delete 参数可以是键,或键范围(key range) IDBRequest
deleteIndex (in any DOMString indexName) void 该方法只能从versionchange事务模式的回调方法中被调用。
get (in any key) IDBRequest 不存在时就像存在记录时一样,但具有undefined值。
index (in DOMString name) IDBIndex
openCursor (in optional IDBKeyRange range, in optional unsigned short direction) IDBRequest
put (in any value, in optional any key) IDBRequest put方法是更新或插入方法。
六、IDBRequest接口
六、IDBIndex对象
六、IDBCursor对象(游标)

属性 direction key primaryKey source

// 首先,确定你已经在 request.onupgradeneeded 中创建了索引:
// objectStore.createIndex("name", "name",{ unique: false });
// 否则你将得到 DOMException。

var index = objectStore.index("name");

index.get("Donna").onsuccess = function(event) {
  alert("Donna's SSN is " + event.target.result.ssn);
};
  • “name” 游标不是唯一的,因此 name 被设成 "Donna" 的记录可能不止一条。在这种情况下,你总是得到键值最小的那个。

  • 如果你需要访问带有给定 name 的所有的记录你可以使用一个游标。你可以在索引上打开两个不同类型的游标。

    • 一个常规游标映射索引属性到对象存储空间中的对象。
    • 一个键索引映射索引属性到用来存储对象存储空间中的对象的键。不同之处被展示如下:
index.openCursor().onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    // cursor.key 是一个 name, 就像 "Bill", 然后 cursor.value 是整个对象。
    alert("Name: " + cursor.key + ", SSN: " + cursor.value.ssn + ", email: " + cursor.value.email);
    cursor.continue();
  }
};

index.openKeyCursor().onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    // cursor.key 是一个 name, 就像 "Bill", 然后 cursor.value 是那个 SSN。
    // 没有办法可以得到存储对象的其余部分。
    alert("Name: " + cursor.key + ", SSN: " + cursor.value);
    cursor.continue();
  }
};
六、IDBKeyRange对象(指定游标的范围和方向)
  • 属性 lower lower​Open upper upper​Open
  • 方法 bound() includes() lower​Bound() only() upper​Bound()
// 仅匹配 "Donna"
var singleKeyRange = IDBKeyRange.only("Donna");

// 匹配所有超过“Bill”的,包括“Bill”
var lowerBoundKeyRange = IDBKeyRange.lowerBound("Bill");

// 匹配所有超过“Bill”的,但不包括“Bill”
var lowerBoundOpenKeyRange = IDBKeyRange.lowerBound("Bill", true);

// 匹配所有不超过“Donna”的,但不包括“Donna”
var upperBoundOpenKeyRange = IDBKeyRange.upperBound("Donna", true);

// 匹配所有在“Bill”和“Donna”之间的,但不包括“Donna”
var boundKeyRange = IDBKeyRange.bound("Bill", "Donna", false, true);

// 使用其中的一个键范围,把它作为 openCursor()/openKeyCursor 的第一个参数
index.openCursor(boundKeyRange).onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    // 当匹配时进行一些操作
    cursor.continue();
  }
};
  • 有时候你可能想要以倒序而不是正序(所有游标的默认顺序)来遍历。切换方向是通过传递 prev 到 openCursor() 方法来实现的:
objectStore.openCursor(boundKeyRange, "prev").onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    // 进行一些操作
    cursor.continue();
  }
};
  • 如果你只是想改变遍历的方向,而不想对结果进行筛选,你只需要给第一个参数传入 null。
index.openKeyCursor(null, IDBCursor.nextunique).onsuccess = function(event) {
  var cursor = event.target.result;
  if (cursor) {
    // Do something with the entries.
    cursor.continue();
  }
};
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容