InDB开发文档

InDB开发文档

最便捷的indexedDB操作工具,10分钟上手indexedDB操作

前言

indexedDB是HTML5标准,是前【原创内容,转载请注明出处】【版权所有,侵权必究】端实现结构化数据存储的最关键因素。基于i【关注微信公众号:wwwtangshuangnet】【原创不易,请尊重版权】ndexedDB驱动,前端应用可以做到更【版权所有】唐霜 www.tangshuang.net【本文受版权保护】加厉害的应用体验。和localStora转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。ge相比,indexedDB的最主要优势【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。在于,indexedDB是一个完整的数据本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。库模型,它具有数据库应该有的库表结构,丰原创内容,盗版必究。未经授权,禁止复制转载。富的查询方式等等。除此之外,localS著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.nettorage的容量在5M左右,而inde原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.netxedDB达到惊人的500M。index著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】edDB还有可以存储arraybuffe【原创内容,转载请注明出处】【关注微信公众号:wwwtangshuangnet】r,进程为异步等特征,这些特质都使得使用原创内容,盗版必究。本文作者:唐霜,转载请注明出处。indexedDB作为前端数据存储的不二【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】之选,localStorage降级为用于【转载请注明来源】【本文首发于唐霜的博客】存储散列的快速读取配置项的存储工具。

转载请注明出处:www.tangshua未经授权,禁止复制转载。【关注微信公众号:wwwtangshuangnet】ng.net【转载请注明来源】未经授权,禁止复制转载。

但是,indexedDB有一个缺点,由于【未经授权禁止转载】【原创内容,转载请注明出处】它需要支持完整的数据库驱动模型,因此,a本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshuang.netpi较为复杂,概念也是一层套一层。我写过【关注微信公众号:wwwtangshuangnet】【转载请注明来源】indexedDB中文教程》较为全面的去介绍它,然鹅,当我发现了新【本文受版权保护】著作权归作者所有,禁止商业用途转载。知识之后,还在不断的去补充那篇教程,可见著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net,如果一个初级开发者要使用原生的inde【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。xedDB api去写代码,会是一件痛苦原创内容,盗版必究。本文作者:唐霜,转载请注明出处。的事。为了解决这个痛点,我决意写一个优秀【作者:唐霜】未经授权,禁止复制转载。的indexedDB操作库。虽然市面上已本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。经有很多库了,但是它们很多都基于inde【原创不易,请尊重版权】原创内容,盗版必究。xedDB原生操作理念去实现,另有一些,【本文受版权保护】【关注微信公众号:wwwtangshuangnet】特意想要套用sql的理念,导致使用反而更著作权归作者所有,禁止商业用途转载。【作者:唐霜】难理解。我经过反复摸索,发布了InDB,【访问 www.tangshuang.net 获取更多精彩内容】【访问 www.tangshuang.net 获取更多精彩内容】它即遵循了indexedDB原生开发的一原创内容,盗版必究。转载请注明出处:www.tangshuang.net些乐趣,开发者再使用它时,可以返回去理解著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.netindexedDB原生接口,但同时,使用【关注微信公众号:wwwtangshuangnet】转载请注明出处:www.tangshuang.net它你又可以非常轻松的使用indexedD未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。B,无需太多复杂的理解。

【作者:唐霜】【原创内容,转载请注明出处】原创内容,盗版必究。【本文受版权保护】

那么InDB到底有多简单呢?这篇文章全面【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net的去介绍它的使用方法。

未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。

关注我博客的同学可能在之前接触过我发布的【本文首发于唐霜的博客】【原创内容,转载请注明出处】HelloIndexedDB,InDB沿转载请注明出处:www.tangshuang.net本文版权归作者所有,未经授权不得转载。袭了它的使用习惯和风格,但是有一些方法在【原创内容,转载请注明出处】【本文受版权保护】具体使用上稍有不同。InDB拆分了“DB【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。”和“Store”两个概念,使用 InD本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。B 只是连接上数据库,需要调用 use 【版权所有,侵权必究】未经授权,禁止复制转载。方法才能使用 store。

【原创内容,转载请注明出处】原创内容,盗版必究。
【关注微信公众号:wwwtangshua【未经授权禁止转载】【原创内容,转载请注明出处】ngnet】本文版权归作者所有,未经授权不得转载。

基础概念

虽然InDB最简化了indexedDB的【版权所有,侵权必究】【版权所有】唐霜 www.tangshuang.net操作,但是,由于indexedDB和lo原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.netcalStorage完全不同,所以,关于【原创不易,请尊重版权】【原创不易,请尊重版权】这个数据库的基本概念要事先了解。

【版权所有】唐霜 www.tangshu【作者:唐霜】【本文首发于唐霜的博客】ang.net【原创内容,转载请注明出处】【未经授权禁止转载】【原创内容,转载请注明出处】

对于一个数据库引擎,我们要记录一条数据,【转载请注明来源】【转载请注明来源】首先需要打开一个数据库,然后在这个数据库本文版权归作者所有,未经授权不得转载。【转载请注明来源】里面选择一个store(也就是sql数据著作权归作者所有,禁止商业用途转载。【未经授权禁止转载】库里面的表),之后才能进行增删改查的工作【作者:唐霜】【版权所有】唐霜 www.tangshuang.net。indexedDB完整的继承这一模型,著作权归作者所有,禁止商业用途转载。【转载请注明来源】你需要了解,在使用InDB时,有“数据库【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.net”“store”“记录”这三层概念存在,【未经授权禁止转载】未经授权,禁止复制转载。具体反应到代码中,这三个概念会在实例化参【原创内容,转载请注明出处】原创内容,盗版必究。数中反应出来。

本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。未经授权,禁止复制转载。

其次是关于keyPath的概念。inde【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。xedDB存的数据和localStora原创内容,盗版必究。【访问 www.tangshuang.net 获取更多精彩内容】ge结构不一样,localStorage【版权所有,侵权必究】原创内容,盗版必究。存的是键值对,而indexedDB存的是【版权所有】唐霜 www.tangshuang.net著作权归作者所有,禁止商业用途转载。object,也就是js对象。就像sql【版权所有,侵权必究】未经授权,禁止复制转载。里面一样,要找到一条记录需要通过它的字段未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。去查,而在indexedDB中,被存的o本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】bject的属性名就相当于字段名,属性值【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。就相当于字段值。而keyPath简单的讲【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。就是object的(某个)属性名。但是,本文版权归作者所有,未经授权不得转载。【原创不易,请尊重版权】indexedDB的强大之处在于,key本文作者:唐霜,转载请注明出处。原创内容,盗版必究。Path可以是链式的多级属性。比如有一个【转载请注明来源】【本文受版权保护】person对象里面深层级的值可以用pe【原创内容,转载请注明出处】【未经授权禁止转载】rson.body.head.left_【原创不易,请尊重版权】【版权所有】唐霜 www.tangshuang.neteye获得,而这个时候”bo【版权所有,侵权必究】【原创内容,转载请注明出处】dy.head.left_eyeR本文版权归作者所有,未经授权不得转载。【转载请注明来源】21;就是这个值相对于person对象的转载请注明出处:www.tangshuang.net【版权所有,侵权必究】keyPath。(而在某些场景中,为了简【本文受版权保护】【关注微信公众号:wwwtangshuangnet】化描述,甚至直接将“keyPath”作为本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshuang.net“keyPath的值”给简写了。)

【本文受版权保护】转载请注明出处:www.tangshua【作者:唐霜】本文版权归作者所有,未经授权不得转载。ng.net【版权所有】唐霜 www.tangshu【本文首发于唐霜的博客】【原创不易,请尊重版权】ang.net

再次是关于key的概念。indexedD【转载请注明来源】【本文受版权保护】B的key的概念有点别扭,它代表的是键值【转载请注明来源】【原创内容,转载请注明出处】,而非键名。

【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshu【本文受版权保护】著作权归作者所有,禁止商业用途转载。ang.net【作者:唐霜】未经授权,禁止复制转载。

最后是关于索引的概念。indexedDB本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。如其名,它的特色就是index(索引)。【未经授权禁止转载】【原创不易,请尊重版权】indexedDB具备了强大的索引系统,本文版权归作者所有,未经授权不得转载。【转载请注明来源】它根据keyPath创建索引,根据ind本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.netexName查询对象记录,可以对一个in【本文首发于唐霜的博客】【原创内容,转载请注明出处】dexName设置多个keyPath,而【原创内容,转载请注明出处】【原创不易,请尊重版权】且还可以实现值域查询。总而言之,如果你想【关注微信公众号:wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.net利用indexeDB快速查询数据,那么索【原创内容,转载请注明出处】转载请注明出处:www.tangshuang.net引要好好利用。

【作者:唐霜】著作权归作者所有,禁止商业用途转载。【作者:唐霜】未经授权,禁止复制转载。

以上就是你在使用InDB之前必须了解的概转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】念。其他indexedDB原生概念可以暂本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。时不用了解。

本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。【本文首发于唐霜的博客】

快速入门

本节让你快速使用InDB进行数据的存取。

本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。

包的安装和使用

InDB是一个npm包,通过npm进行安本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net装:

未经授权,禁止复制转载。【本文首发于唐霜的博客】
npm i indb

安装之后,你可以根据你的编程需求选择不同本文作者:唐霜,转载请注明出处。【作者:唐霜】的使用方式:

本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】
// webpack
import InDB from 'indb'
// CommonJS
const { InDB } = require('indb')

在HTML中直接使用时,你需要把indb转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。/dist/indb.js文件拷贝到你的【转载请注明来源】原创内容,盗版必究。本地目录:

【原创不易,请尊重版权】原创内容,盗版必究。【原创不易,请尊重版权】
<script src="./node_modules/indb/dist/indb.js"></script>
<script>
const { InDB } = window['indb'] // 注意这里的使用方法
</script>

使用

接下来,你就可以像localStorag【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。e一样,使用这个store,不过,由于i著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.netndexedDB是异步操作的,你的所有操著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.net作都必须是异步完成。

【访问 www.tangshuang.n【访问 www.tangshuang.net 获取更多精彩内容】未经授权,禁止复制转载。et 获取更多精彩内容】【本文受版权保护】
let obj = await store.getItem('key')
await store.setItem('key', 'value')

这样我们就完成了对InDB的初步认识。下未经授权,禁止复制转载。原创内容,盗版必究。文,我们会分开详细介绍它的各个细节方面。

【原创不易,请尊重版权】原创内容,盗版必究。

实例化参数

这一节将会是InDB整个使用中最难的部分著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】,一旦掌握了本节的内容,其他的方面完全就原创内容,盗版必究。本文作者:唐霜,转载请注明出处。无需担忧了。

【转载请注明来源】【未经授权禁止转载】原创内容,盗版必究。

在上一节的时候,我们直接使用InDB.g著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.netetItem,这种做法是最简单的做法,但本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。这样不能发挥出indexedDB的强大功【未经授权禁止转载】本文作者:唐霜,转载请注明出处。能,相当于把它当作一个localStor【未经授权禁止转载】本文作者:唐霜,转载请注明出处。age的替代品,没意思。本节我们学习实例【本文受版权保护】【版权所有】唐霜 www.tangshuang.net化参数,这些参数被用来作为对indexe【原创不易,请尊重版权】转载请注明出处:www.tangshuang.netdDB进行操作前的准备工作。

【原创内容,转载请注明出处】【转载请注明来源】本文版权归作者所有,未经授权不得转载。【本文受版权保护】

我们要使用InDB来操作indexedD【原创内容,转载请注明出处】原创内容,盗版必究。B,要经过步骤:

【转载请注明来源】未经授权,禁止复制转载。
  1. 连接到数据库
  2. 本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】
  3. 打开一个store
  4. 【版权所有】唐霜 www.tangshu【转载请注明来源】【版权所有】唐霜 www.tangshuang.netang.net【原创内容,转载请注明出处】转载请注明出处:www.tangshua【作者:唐霜】本文作者:唐霜,转载请注明出处。ng.net原创内容,盗版必究。
  5. 写入或修改数据
  6. 【访问 www.tangshuang.n本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】et 获取更多精彩内容】本文版权归作者所有,未经授权不得转载。

具体操作如下:

原创内容,盗版必究。本文作者:唐霜,转载请注明出处。
const idb = new InDB(options) // 实例化InDB,得到一个可以连接数据库的实例
const store = idb.use('store1') // 通过use方法,打开一个store

参数列表

在进行InDB实例化时,需要传入参数:

【本文首发于唐霜的博客】【关注微信公众号:wwwtangshua【本文受版权保护】【未经授权禁止转载】ngnet】未经授权,禁止复制转载。
  • name: 字符串,数据库名称
  • 原创内容,盗版必究。本文作者:唐霜,转载请注明出处。
  • version: 正整数,数据库结构的版【作者:唐霜】【版权所有,侵权必究】本,调整数据库结构时,需要升级versi【原创不易,请尊重版权】【未经授权禁止转载】on
  • 【版权所有,侵权必究】【访问 www.tangshuang.n【本文受版权保护】【关注微信公众号:wwwtangshuangnet】et 获取更多精彩内容】
  • stores: 数组,用以定义当前数据库【作者:唐霜】【版权所有】唐霜 www.tangshuang.net中每个store的结构
    • name: 字符串,store名称
    • 原创内容,盗版必究。本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshu【作者:唐霜】未经授权,禁止复制转载。ang.net
    • keyPath: 字符串,store k【原创内容,转载请注明出处】【版权所有,侵权必究】eyPath
    • 著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshua【本文首发于唐霜的博客】转载请注明出处:www.tangshuang.netng.net【原创不易,请尊重版权】
    • indexes: 数组,用以定义stor未经授权,禁止复制转载。【本文受版权保护】e的索引
      • name: 字符串,索引名称
      • 【关注微信公众号:wwwtangshua原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.netngnet】原创内容,盗版必究。
      • keyPath: 字符串,索引的keyP原创内容,盗版必究。原创内容,盗版必究。ath
      • 【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshu【未经授权禁止转载】【转载请注明来源】ang.net
      • unique: boolean,该索引是【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。否是唯一的,不允许同一个store中同索【原创内容,转载请注明出处】【关注微信公众号:wwwtangshuangnet】引名存在两个及以上的索引值
      • 本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.n著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】et 获取更多精彩内容】【本文首发于唐霜的博客】
    • 【版权所有】唐霜 www.tangshu【作者:唐霜】【未经授权禁止转载】ang.net转载请注明出处:www.tangshua【转载请注明来源】本文版权归作者所有,未经授权不得转载。ng.net著作权归作者所有,禁止商业用途转载。
    • isKv: boolean,是否开启ke本文作者:唐霜,转载请注明出处。【本文受版权保护】y-value模式,为true时keyP【访问 www.tangshuang.net 获取更多精彩内容】【转载请注明来源】ath和indexes无效
    • 本文作者:唐霜,转载请注明出处。【未经授权禁止转载】【本文受版权保护】原创内容,盗版必究。
  • 【本文受版权保护】【未经授权禁止转载】转载请注明出处:www.tangshua【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.netng.net【版权所有,侵权必究】
未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。【版权所有,侵权必究】【转载请注明来源】

上面就是所有参数字段,看上去非常简单。但【未经授权禁止转载】【本文首发于唐霜的博客】是不要急,复杂的东西在后面。

【转载请注明来源】本文作者:唐霜,转载请注明出处。【未经授权禁止转载】

store的配置

上面的stores参数是一个数组,而数组【作者:唐霜】【原创不易,请尊重版权】的每一个元素,代表要创建怎样的一个sto本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】re出来。

转载请注明出处:www.tangshua转载请注明出处:www.tangshuang.net【未经授权禁止转载】ng.net【本文首发于唐霜的博客】本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.n【关注微信公众号:wwwtangshuangnet】【访问 www.tangshuang.net 获取更多精彩内容】et 获取更多精彩内容】
{
  name: store的名称,必填
  keyPath: 主键名,也就是说,一个object的什么属性(路径)会被作为这个store的最主要查询依据
  indexes: 索引列表
  autoIncrement: 主键是否自增,设置为true时,在向store添加对象的时候,主键值可不传
  isKv: 是否开启key-value模式,只有开启key-value模式的store才会拥有getItem/setItem/removeItem这几个方法,并且用这几个方法像操作localStorage一样操作indexedDB,不开启的情况下,不能使用这几个方法
}

上面比较难理解的是autoIncreme本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。nt,所以,我的建议是不设置这个值。

未经授权,禁止复制转载。【版权所有,侵权必究】【转载请注明来源】

index的配置

上面的indexes配置项是个数组,而其【未经授权禁止转载】【原创不易,请尊重版权】中每个元素代表要给这个store创建怎样【本文受版权保护】【原创不易,请尊重版权】的索引。

【本文受版权保护】未经授权,禁止复制转载。【转载请注明来源】
{
  name: index的name,查询的时候用到
  keyPath: 索引对应object的什么属性(路径)
  unique: 是否为唯一索引,为true的时候,整个store里面该keyPath对应的值不能有重复
}

上面比较难理解的是keyPath,ind【版权所有】唐霜 www.tangshuang.net本文版权归作者所有,未经授权不得转载。ex的keyPath和store的key【转载请注明来源】未经授权,禁止复制转载。Path理解上不一样。index的key【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。Path是指,当你用index的name本文版权归作者所有,未经授权不得转载。【作者:唐霜】去查询的时候,实际要查询的object的著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net属性名,indexName相当于是ind本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。exKeyPath的一个别名,方便在查询转载请注明出处:www.tangshuang.net本文版权归作者所有,未经授权不得转载。的时候使用较短的字符串去代替。

本文作者:唐霜,转载请注明出处。【作者:唐霜】

基础API

本节介绍通用API,利用这些api你可以【本文受版权保护】【版权所有】唐霜 www.tangshuang.net快速操作indexedDB。这些方法全部著作权归作者所有,禁止商业用途转载。【转载请注明来源】为实例化对象的方法,使用时,需先得到实例本文版权归作者所有,未经授权不得转载。【版权所有,侵权必究】化对象。每个实例对应一个库,在进行操作时转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。,一个操作只能对应一个store,不能同【本文首发于唐霜的博客】著作权归作者所有,禁止商业用途转载。时用一个实例操作多个store。你可以通本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。过use方法得到对不同store的实例,【版权所有,侵权必究】【版权所有,侵权必究】通过它们来操作不同store。

未经授权,禁止复制转载。未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。

get

根据store的key获取一个对象。ke【作者:唐霜】【作者:唐霜】y是keyPath的值。

未经授权,禁止复制转载。【版权所有,侵权必究】未经授权,禁止复制转载。【关注微信公众号:wwwtangshua【版权所有,侵权必究】【作者:唐霜】ngnet】
let value = await store.get(key)

add

向store中插入一条新记录。

【关注微信公众号:wwwtangshua【版权所有,侵权必究】【本文受版权保护】ngnet】【访问 www.tangshuang.n本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】et 获取更多精彩内容】【版权所有】唐霜 www.tangshu【原创不易,请尊重版权】【转载请注明来源】ang.net【作者:唐霜】
await store.add({ id, name, age })

相当于sql中的insert操作,需要注著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net意,indexedDB中,对add的数据【本文受版权保护】【访问 www.tangshuang.net 获取更多精彩内容】格式有要求,必须符合下面其中之一

本文版权归作者所有,未经授权不得转载。【本文受版权保护】【访问 www.tangshuang.n【访问 www.tangshuang.net 获取更多精彩内容】【关注微信公众号:wwwtangshuangnet】et 获取更多精彩内容】【版权所有】唐霜 www.tangshu【未经授权禁止转载】转载请注明出处:www.tangshuang.netang.net

如果add的对象key值已经存在于sto【版权所有,侵权必究】著作权归作者所有,禁止商业用途转载。re中,会报错,因此,比较常规的操作是用【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】put代替add。

【版权所有】唐霜 www.tangshu【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.netang.net【版权所有】唐霜 www.tangshu【本文受版权保护】【原创不易,请尊重版权】ang.net未经授权,禁止复制转载。原创内容,盗版必究。

put

更新store中的一条数据,如果传入对象【作者:唐霜】【本文受版权保护】的key值不存在,就插入这条数据。

【访问 www.tangshuang.n【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。et 获取更多精彩内容】【版权所有】唐霜 www.tangshu【原创不易,请尊重版权】【原创不易,请尊重版权】ang.net
await store.put({ id, name, age })

put中key值其实也遵循上面add的规【版权所有】唐霜 www.tangshuang.net【原创内容,转载请注明出处】律,如果autoIncrement设置为【转载请注明来源】原创内容,盗版必究。true,那么不给key时,就是添加,给【访问 www.tangshuang.net 获取更多精彩内容】【作者:唐霜】key时,就是更新。

未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。【作者:唐霜】

一般,在代码中我们尽量少使用autoIn著作权归作者所有,禁止商业用途转载。【转载请注明来源】crement配置,因为我们很难完全掌握未经授权,禁止复制转载。【本文首发于唐霜的博客】数据的实际情况。我们尽量使用put,而不【未经授权禁止转载】【未经授权禁止转载】是add,因为代码一旦部署,它就不能修改【关注微信公众号:wwwtangshuangnet】【本文受版权保护】,如果在执行中add报错,那么很可能阻塞转载请注明出处:www.tangshuang.net【原创内容,转载请注明出处】你的程序。

【作者:唐霜】原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。

delete

从store中删除一条数据。

原创内容,盗版必究。【原创内容,转载请注明出处】
await store.delete(key)

传入key值。

【版权所有】唐霜 www.tangshu【转载请注明来源】本文版权归作者所有,未经授权不得转载。ang.net未经授权,禁止复制转载。【转载请注明来源】【未经授权禁止转载】

以上是InDB中最基础的api,利用这些未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。api,就可以实现最基础的数据增删改查了【本文首发于唐霜的博客】著作权归作者所有,禁止商业用途转载。

【关注微信公众号:wwwtangshua【版权所有,侵权必究】原创内容,盗版必究。ngnet】【本文首发于唐霜的博客】【作者:唐霜】【访问 www.tangshuang.n转载请注明出处:www.tangshuang.net原创内容,盗版必究。et 获取更多精彩内容】

remove

从store中删除一条数据,和delet本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。e不同的是,remove直接接收这个对象【原创内容,转载请注明出处】【原创内容,转载请注明出处】

【本文受版权保护】【转载请注明来源】【关注微信公众号:wwwtangshua【本文首发于唐霜的博客】【关注微信公众号:wwwtangshuangnet】ngnet】
await store.remove(obj)

它会自动去找到obj上的keyPath,【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。然后用delete去删除。

【原创不易,请尊重版权】【关注微信公众号:wwwtangshua转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.netngnet】著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.n【本文首发于唐霜的博客】著作权归作者所有,禁止商业用途转载。et 获取更多精彩内容】

另外,使用delete的时候,你需要传入【本文首发于唐霜的博客】【原创内容,转载请注明出处】的是keyPath的值,而如果你的key转载请注明出处:www.tangshuang.net【关注微信公众号:wwwtangshuangnet】Path是多级路径,例如’b本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。ody.hands’这样的路【访问 www.tangshuang.net 获取更多精彩内容】未经授权,禁止复制转载。径,那么要取到key也是挺麻烦的,你需要【版权所有】唐霜 www.tangshuang.net【原创不易,请尊重版权】自己有一套解析keyPath的工具。而I【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。nDB内置了这样的功能,使用remove本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】不用担心这个问题,只要你的obj是一个和转载请注明出处:www.tangshuang.net原创内容,盗版必究。数据库中记录对应的上的对象,就能被正确删【关注微信公众号:wwwtangshuangnet】【原创不易,请尊重版权】除。

【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。

clear

清空store中的所有数据,注意备份!!

【访问 www.tangshuang.n本文版权归作者所有,未经授权不得转载。【版权所有,侵权必究】et 获取更多精彩内容】著作权归作者所有,禁止商业用途转载。
awiat store.clear()

查询API

基础api仅仅是最基础功能的实现,还没有转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net涉及indexedDB真正强大的地方。i未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.netndexedDB真正强大的地方是利用索引著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net进行查询,因此,我们要发挥这些能力,我们未经授权,禁止复制转载。【关注微信公众号:wwwtangshuangnet】就会用到下面的api。

本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。

注意:依赖于 index 的查询 API本文作者:唐霜,转载请注明出处。【作者:唐霜】 需要在创建仓库时传入对应的 index本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】es,即使该属性已经被 keyPath 转载请注明出处:www.tangshuang.net【未经授权禁止转载】使用,也要在 indexes 中再次声明本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net,否则无法使用下面的查询接口。

【关注微信公众号:wwwtangshua本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。ngnet】本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】【作者:唐霜】
【转载请注明来源】著作权归作者所有,禁止商业用途转载。

find

从store中找到第一条indexNam【原创不易,请尊重版权】原创内容,盗版必究。e为某值的记录。

【版权所有,侵权必究】【转载请注明来源】【作者:唐霜】【转载请注明来源】
let obj = await store.find(indexName, value)

要使用find的前提是,你的store在【版权所有】唐霜 www.tangshuang.net【本文首发于唐霜的博客】配置时传入了对应的index,否则是不能【关注微信公众号:wwwtangshuangnet】【未经授权禁止转载】根据索引找到值的。

【本文受版权保护】著作权归作者所有,禁止商业用途转载。【版权所有,侵权必究】原创内容,盗版必究。
const store = new InDB({
  name: 'my-idb',
  stores: [
    {
      name: 'my-store',
      keyPath: 'id',
      indexes: [
        {
          name: 'indexName',
          keyPath: 'age',
        },
      ],
    },
  ],
})

注意上面红色的部分,只有当你在创建sto【未经授权禁止转载】【本文受版权保护】re的时候,设置了这个索引,才能使用fi本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。nd去使用它:

【版权所有,侵权必究】【作者:唐霜】
let obj = await store.find('indexName', 10)

这样就可以找到第一条age=10的数据了【作者:唐霜】【原创内容,转载请注明出处】,相当于sql里面的where age=【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。10 limit 1的子句。

本文作者:唐霜,转载请注明出处。【版权所有,侵权必究】【本文受版权保护】

注意,我这里传入的是indexName,【作者:唐霜】原创内容,盗版必究。但是indexedDB实际会使用keyP原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.netath,也就是’age本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】217;字段作为查询条件。关于keyPa【转载请注明来源】转载请注明出处:www.tangshuang.netth前面已经解释过了,这里不再赘述。

原创内容,盗版必究。【转载请注明来源】本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】

query

查询出store中所有满足条件的记录,返【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。回一个数组。

未经授权,禁止复制转载。【原创内容,转载请注明出处】【原创不易,请尊重版权】原创内容,盗版必究。
let objs = await store.query(indexName, value, compare)

find仅仅找到第一条数据,而query【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。则可以找出所有满足条件的记录。和find转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。一样,它也必须是index支持的才能使用未经授权,禁止复制转载。【转载请注明来源】

【版权所有,侵权必究】转载请注明出处:www.tangshua【未经授权禁止转载】原创内容,盗版必究。ng.net
let objs = await store.query('indexName', 10)

这样就可以查出age=10的所有记录。

本文版权归作者所有,未经授权不得转载。【关注微信公众号:wwwtangshua【关注微信公众号:wwwtangshuangnet】转载请注明出处:www.tangshuang.netngnet】【本文受版权保护】【作者:唐霜】

query比find更强大的地方在于,它【关注微信公众号:wwwtangshuangnet】【版权所有,侵权必究】支持条件筛选,它的第三个参数可以传入比较【关注微信公众号:wwwtangshuangnet】【原创内容,转载请注明出处】运算符。

【关注微信公众号:wwwtangshua【关注微信公众号:wwwtangshuangnet】本文版权归作者所有,未经授权不得转载。ngnet】本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】原创内容,盗版必究。
let objs = await store.query('indexName', 10, '>')

表示查出所有age>10的记录,支未经授权,禁止复制转载。【本文受版权保护】持的条件如下:

【转载请注明来源】转载请注明出处:www.tangshua著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。ng.net【转载请注明来源】

在使用!=、%和in的时候一定要注意,由未经授权,禁止复制转载。【本文受版权保护】于indexedDB内部还不支持这3种查【原创不易,请尊重版权】原创内容,盗版必究。询方式,但InDB可以支持。说到这里,可【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。以将index配置项里面都只配置name【转载请注明来源】未经授权,禁止复制转载。属性,这样keyPath属性会自动使用n【关注微信公众号:wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.netame属性。

【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。
const store = new InDB({
  name: 'my-idb',
  stores: [
    {
      name: 'my-store',
      keyPath: 'id',
      indexes: [
        {
          name: 'body.head', // 这样可以保证name和keyPath的值是一样的
        },
      ],
    },
  ],
})

不过上面也只是建议,最后根据你的实际情况转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net来确定。

【转载请注明来源】【转载请注明来源】【版权所有】唐霜 www.tangshu原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。ang.net【未经授权禁止转载】

select

查询出store中所有满足条件的记录,返未经授权,禁止复制转载。原创内容,盗版必究。回一个数组。

转载请注明出处:www.tangshua【作者:唐霜】【版权所有】唐霜 www.tangshuang.netng.net原创内容,盗版必究。
let objs = await store.select([
  { key: 'name', value: 'c', compare: '>' },
  { key: 'age', value: 10, compare: '>' },
  { key: 'age', value: 20, compare: '<' },
])

虽然indexedDB很强大,但是仅支持转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。单索引查询,而无法做到多个索引同时联系起【原创不易,请尊重版权】【原创不易,请尊重版权】来查询。为了实现这一功能,我实现了sel著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。ect方法,这个方法可以让你同时使用多个【关注微信公众号:wwwtangshuangnet】【原创内容,转载请注明出处】查询条件,并且取一定的逻辑关系。例如上面本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】这段代码,它可以查询出name>&本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。#8217;c’同时10&l原创内容,盗版必究。转载请注明出处:www.tangshuang.nett;age<20的所有记录。

本文作者:唐霜,转载请注明出处。【转载请注明来源】【关注微信公众号:wwwtangshua原创内容,盗版必究。原创内容,盗版必究。ngnet】【版权所有】唐霜 www.tangshu本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】ang.net

select接收一个数组,数组中的每个元本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。素都是一个查询条件,它可以包含如下属性:

【原创内容,转载请注明出处】【转载请注明来源】

optional这个选项有点难理解,简单【原创不易,请尊重版权】【原创不易,请尊重版权】的说,它就是sql里面的OR,而sele未经授权,禁止复制转载。【关注微信公众号:wwwtangshuangnet】ct方法的查询方式非常简单,没有opti原创内容,盗版必究。本文作者:唐霜,转载请注明出处。onal或者optional为false本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。的,被认为是AND子句,先进行查询,所有【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】optional为true的被视为一个整【转载请注明来源】著作权归作者所有,禁止商业用途转载。体,最后进行查询,在满足AND的基础上,【未经授权禁止转载】【版权所有,侵权必究】只有满足任意一条OR的子句的记录才会在结转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。果集合中,否则就不在。而如果你的条件里面【作者:唐霜】【未经授权禁止转载】,全部都是optional为true,那本文作者:唐霜,转载请注明出处。原创内容,盗版必究。么相当于只有一条AND语句,也就是说只要【转载请注明来源】未经授权,禁止复制转载。记录满足任何一条规则,即可被返回。

本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。【原创不易,请尊重版权】
let objs = await store.select([
  { key: 'name', value: 'c', compare: '>' },
  { key: 'age', value: 10, compare: '<', optional: true },
  { key: 'age', value: 20, compare: '>', optional: true },
])

这条查询相当于 name>R【转载请注明来源】原创内容,盗版必究。17;c’ AND (age著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net<10 OR age>20)本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net。所有类似的语句都能转化为 (a AND【原创内容,转载请注明出处】原创内容,盗版必究。 b AND c) AND (d OR 著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】e OR f) 这样的句子,你只要记住所【作者:唐霜】【关注微信公众号:wwwtangshuangnet】有条件被分为两组,AND 子句被视作一个【本文受版权保护】未经授权,禁止复制转载。整体先判断,在成立的情况下,再把 OR 【原创不易,请尊重版权】【关注微信公众号:wwwtangshuangnet】子句被视作一个整体后判断,就可以轻松理解未经授权,禁止复制转载。转载请注明出处:www.tangshuang.net了。

【访问 www.tangshuang.n【版权所有,侵权必究】【原创内容,转载请注明出处】et 获取更多精彩内容】【转载请注明来源】转载请注明出处:www.tangshua【本文受版权保护】【未经授权禁止转载】ng.net

但是,这样的查询没有办法做到 (a AN【本文受版权保护】本文作者:唐霜,转载请注明出处。D b) OR (c AND d) 这样未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。的查询,我们在业务中经常需要查询多个条件【作者:唐霜】【本文首发于唐霜的博客】的并集,所以,我提供了一种方式来获得多个【作者:唐霜】【关注微信公众号:wwwtangshuangnet】条件的并集,即:你可以传入多个数组来作为原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。多个条件。语法如下:

【原创内容,转载请注明出处】本文版权归作者所有,未经授权不得转载。【作者:唐霜】本文作者:唐霜,转载请注明出处。
await store.select(
  [ ... ],
  [ ... ]
)

通常情况下,你只会传入一个参数,但是在有著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。取多个并集时,可以传入多个参数,每个参数【未经授权禁止转载】本文作者:唐霜,转载请注明出处。的结构都是一样的。这样可以获得多个查询结原创内容,盗版必究。【原创不易,请尊重版权】果的并集。

【原创内容,转载请注明出处】【作者:唐霜】转载请注明出处:www.tangshua【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.netng.net

但是,我没有提供 (a OR b) AN本文作者:唐霜,转载请注明出处。原创内容,盗版必究。D (c OR d) 这样的查询能力,你【原创内容,转载请注明出处】原创内容,盗版必究。需要把它转化为 (a AND c) OR【关注微信公众号:wwwtangshuangnet】原创内容,盗版必究。 (b AND d) 的查询,当然,这要转载请注明出处:www.tangshuang.net【关注微信公众号:wwwtangshuangnet】根据实际情况来决定怎么组合在一起,而不是本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net像我这里直接把 a&c b&am原创内容,盗版必究。【未经授权禁止转载】p;d 组合在一起。举个例子,你需要查询【版权所有,侵权必究】【转载请注明来源】年龄小于10或大于30,且体重小于40或【本文受版权保护】【原创不易,请尊重版权】140的学生集合,正常的写法是 (age【版权所有,侵权必究】【版权所有】唐霜 www.tangshuang.net<10 OR age>30)原创内容,盗版必究。未经授权,禁止复制转载。 AND (weight<40 O【关注微信公众号:wwwtangshuangnet】【作者:唐霜】R weight>140),但是我【本文受版权保护】本文作者:唐霜,转载请注明出处。们不支持这种查询语法,此时,我们要分析具著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。体的需求,在草稿纸上画出两条查询之间的内原创内容,盗版必究。原创内容,盗版必究。在逻辑,就可以知道它可以用 (age&l原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.nett;10 AND weight<4原创内容,盗版必究。【未经授权禁止转载】0) OR (age>30 AND【本文受版权保护】著作权归作者所有,禁止商业用途转载。 weight>140) 来表达。【作者:唐霜】【原创不易,请尊重版权】当然,不是所有情况都是这样的,这需要你在著作权归作者所有,禁止商业用途转载。【版权所有,侵权必究】草稿纸上画出每条查询之间的联系。

【版权所有】唐霜 www.tangshu本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】ang.net【访问 www.tangshuang.n【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。et 获取更多精彩内容】【原创内容,转载请注明出处】【关注微信公众号:wwwtangshua本文作者:唐霜,转载请注明出处。【版权所有,侵权必究】ngnet】
<---|  10 age 30  |-------->
<----| 40  wieght  140 |--->

通过这种分析得到一个可用的语法。但是实际本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】上,我们很少在业务中出现这种需求,毕竟我【访问 www.tangshuang.net 获取更多精彩内容】【本文受版权保护】们不是在做 SQL 的复杂查询。

【原创不易,请尊重版权】【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。

注意:find、query、select【本文首发于唐霜的博客】【版权所有,侵权必究】都要求你使用indexes配置才能使用。

未经授权,禁止复制转载。原创内容,盗版必究。

first

返回store中的第一条数据。

【版权所有】唐霜 www.tangshu本文作者:唐霜,转载请注明出处。【未经授权禁止转载】ang.net【本文首发于唐霜的博客】原创内容,盗版必究。
let firstRecord = await store.first()

last

返回store中的最后一条数据。

【原创内容,转载请注明出处】【关注微信公众号:wwwtangshua原创内容,盗版必究。【未经授权禁止转载】ngnet】
let lastRecord = await store.last()

some

返回几条连续的数据。

【原创不易,请尊重版权】【关注微信公众号:wwwtangshua【版权所有】唐霜 www.tangshuang.net转载请注明出处:www.tangshuang.netngnet】【转载请注明来源】转载请注明出处:www.tangshua【未经授权禁止转载】【原创内容,转载请注明出处】ng.net
let someRecords = await store.some(5, 3)

表示从索引值为3开始,返回连续的5条记录转载请注明出处:www.tangshuang.net原创内容,盗版必究。

本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.n【原创不易,请尊重版权】【转载请注明来源】et 获取更多精彩内容】【原创不易,请尊重版权】转载请注明出处:www.tangshua著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.netng.net

当offset小于0时,查询将会移到所有原创内容,盗版必究。本文作者:唐霜,转载请注明出处。记录的尾部,例如:

【作者:唐霜】【版权所有,侵权必究】
let someRecords = await store.some(3, -5)

则会从倒数第5个记录开始拿取,一共拿出3【版权所有,侵权必究】本文版权归作者所有,未经授权不得转载。个。

【版权所有】唐霜 www.tangshu原创内容,盗版必究。原创内容,盗版必究。ang.net【作者:唐霜】

all

返回store中的所有数据,结果为数组。

未经授权,禁止复制转载。未经授权,禁止复制转载。【未经授权禁止转载】
let allRecords = await store.all()

count

返回store中所有数据的条数,结果为数原创内容,盗版必究。【作者:唐霜】字。

【关注微信公众号:wwwtangshua【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有,禁止商业用途转载。ngnet】【原创不易,请尊重版权】原创内容,盗版必究。原创内容,盗版必究。
let count = await store.count()

keys

返回store中所有记录的主键值,结果为本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net一个数组。

【本文受版权保护】原创内容,盗版必究。转载请注明出处:www.tangshua本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。ng.net本文版权归作者所有,未经授权不得转载。
let keys = await store.keys()

上述就是所有InDB提供的查询api,这本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】些api具有非常简洁易用的特征,而且很多【本文受版权保护】【未经授权禁止转载】情况下,你并不需要复杂的api,用上面这本文作者:唐霜,转载请注明出处。原创内容,盗版必究。些api完全可以满足你的查询需求。

【转载请注明来源】未经授权,禁止复制转载。

Key-Value API

在InDB里面,有几个特殊的API,它们未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.net和原生的Storage api命名保持一【转载请注明来源】本文版权归作者所有,未经授权不得转载。致。要使用这些api,你必须在创建sto【版权所有】唐霜 www.tangshuang.net【本文受版权保护】re时,在store的参数中使用isKv转载请注明出处:www.tangshuang.net原创内容,盗版必究。为true,这样做之后,keyPath配【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。置,autoIncrement配置都将失著作权归作者所有,禁止商业用途转载。原创内容,盗版必究。效,但它可以把当前这个store转化为一【本文受版权保护】【本文受版权保护】个支持Storage api的store【未经授权禁止转载】【版权所有】唐霜 www.tangshuang.net

【原创不易,请尊重版权】【访问 www.tangshuang.n【未经授权禁止转载】著作权归作者所有,禁止商业用途转载。et 获取更多精彩内容】本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。
const store = new InDB({
  name: 'my-idb',
  stores: [
    {
      name: 'my-store',
      isKv: true,
    },
  ],
  use: 'my-store',
})

这样配置之后(注意,在你的代码第一次发布【版权所有】唐霜 www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】上线之前就必须这样做,而不能等到后面发布【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。新版本的时候再调整,否则你必须通过升级v【关注微信公众号:wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.netersion值来办到),这个store就本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。可以调用如下api。

【转载请注明来源】本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。转载请注明出处:www.tangshua著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。ng.net

getItem

获取对应key的值。

【作者:唐霜】转载请注明出处:www.tangshua【本文受版权保护】本文版权归作者所有,未经授权不得转载。ng.net
let value = await store.getItem(key)

setItem

设置对应key的值。

未经授权,禁止复制转载。【版权所有,侵权必究】
await store.setItem(key, value)

removeItem

删除对应的key-value。

【版权所有】唐霜 www.tangshu著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】ang.net【关注微信公众号:wwwtangshua【版权所有】唐霜 www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】ngnet】【版权所有】唐霜 www.tangshu本文版权归作者所有,未经授权不得转载。【本文首发于唐霜的博客】ang.net【转载请注明来源】
awiat store.removeItem(key)

以上就是Storage api,这使得使著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。用InDB之后,可以像使用localSt【原创内容,转载请注明出处】本文版权归作者所有,未经授权不得转载。orage一样操作indexedDB,非转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.net常方便。

【关注微信公众号:wwwtangshua本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】ngnet】【版权所有,侵权必究】【转载请注明来源】

遍历API

这一些特殊情况下,你可能还需要更奇特的操著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.net作,InDB提供了几个可能对你有帮助的a【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。pi,利用它们,你可以办到任何你想干的事本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】

【关注微信公众号:wwwtangshua本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】ngnet】【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshu未经授权,禁止复制转载。【作者:唐霜】ang.net

each

遍历当前store。

【本文受版权保护】转载请注明出处:www.tangshua转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.netng.net本文版权归作者所有,未经授权不得转载。
await store.each((obj) => {
  // ..
})

通过each,可以遍历整个store,这未经授权,禁止复制转载。【原创内容,转载请注明出处】样,如果当上面的api不能满足你的查询需【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.net求的时候,你可以自己写一个遍历操作来搜集【本文受版权保护】【本文首发于唐霜的博客】所有满足你的条件的记录。

本文版权归作者所有,未经授权不得转载。【作者:唐霜】【本文受版权保护】

each接收一个函数,函数可以有如下参数著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.net

本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。

reverse

逆序遍历整个store。

本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。

和each用法一摸一样,只不过迭代的方向本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net是从store的最后一条往第一条。

【版权所有】唐霜 www.tangshu【转载请注明来源】【转载请注明来源】ang.net【作者:唐霜】【转载请注明来源】

原子API

InDB提供了一套可以快速进入原生操作的本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。api,它可以帮助你不需要写太多原生代码【版权所有】唐霜 www.tangshuang.net转载请注明出处:www.tangshuang.net,就可以拿到indexedDB的原生对象著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。,在这些原生对象的基础上进行下一步操作。

【版权所有】唐霜 www.tangshu【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。ang.net【版权所有】唐霜 www.tangshu【转载请注明来源】本文版权归作者所有,未经授权不得转载。ang.net

transaction

基于当前store,快速开启一个事务,而原创内容,盗版必究。【本文首发于唐霜的博客】且不用担心事务的可用性。

【本文首发于唐霜的博客】【作者:唐霜】
  • writable: 是否开启一个可写的事【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshuang.net务,默认是关闭的
  • 转载请注明出处:www.tangshua【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。ng.net【版权所有】唐霜 www.tangshu【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。ang.net
let tx = await store.transaction(true)

objectStore

快速打开当前store。

【本文首发于唐霜的博客】【原创不易,请尊重版权】【版权所有,侵权必究】未经授权,禁止复制转载。
  • writable: 是否在一个可写的事务转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。打开该store,默认是关闭的
  • 【作者:唐霜】【原创内容,转载请注明出处】未经授权,禁止复制转载。
let objectStore = await store.objectStore()

cursor

打开一个游标来遍历数据。

本文作者:唐霜,转载请注明出处。【未经授权禁止转载】原创内容,盗版必究。未经授权,禁止复制转载。
await store.cursor({
  index:'indexName',
  ranage:null, // [IDBKeyRange](https://developer.mozilla.org/en-US/docs/Web/API/IDBKeyRange)
  direction:'next', // next or prev
  writable:false, // true or false
  onTouch, // function, (cursor, owner) => {}, `owner` is the owner of cursor (objectStore or index)
  onDone, // function
  onError, // function
})

iterate

创建一个迭代器遍历数据。
著作权归作者所有,禁止商业用途转载。【本文受版权保护】
await store.iterate((cursor, next, stop) => {
  // ...
}, {
  writable: false,
  direction: 'next',
})
【版权所有】唐霜 www.tangshu未经授权,禁止复制转载。【未经授权禁止转载】ang.net【版权所有,侵权必究】【关注微信公众号:wwwtangshua转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。ngnet】原创内容,盗版必究。

当调用stop的时候,直接resolve【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.net当前这个promise。

【作者:唐霜】【本文首发于唐霜的博客】【作者:唐霜】
【版权所有】唐霜 www.tangshu【版权所有,侵权必究】【版权所有,侵权必究】ang.net转载请注明出处:www.tangshua【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。ng.net

request

基于当前store发起一个request【原创内容,转载请注明出处】转载请注明出处:www.tangshuang.net

转载请注明出处:www.tangshua转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】ng.net未经授权,禁止复制转载。原创内容,盗版必究。

这是一个非常强大,但理解起来比较复杂的a【关注微信公众号:wwwtangshuangnet】【访问 www.tangshuang.net 获取更多精彩内容】pi,如果你不是很了解原生的indexe【本文受版权保护】【原创内容,转载请注明出处】dDB接口,可能使用起来就有些吃力。

【转载请注明来源】原创内容,盗版必究。【访问 www.tangshuang.n【原创内容,转载请注明出处】原创内容,盗版必究。et 获取更多精彩内容】
await store.request(fn, { writable })
  • fn: 基于当前store发起reque本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。st的准备动作,是一个函数,函数必须返回转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。一个request实例
  • 【作者:唐霜】【作者:唐霜】【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。
  • options
    • writable: 是否以可写模式运行,著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.net默认为只读,设置为true后这个requ著作权归作者所有,禁止商业用途转载。【作者:唐霜】est是可写的
    • 【本文受版权保护】本文版权归作者所有,未经授权不得转载。
  • 【关注微信公众号:wwwtangshua【本文首发于唐霜的博客】【原创不易,请尊重版权】ngnet】【版权所有】唐霜 www.tangshu原创内容,盗版必究。【作者:唐霜】ang.net
store.request(objectStore => objectStore.get(key)).then(obj => console.log(obj))

InDB内置的很多方法都是通过这种形式调著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】用原生api实现的。

转载请注明出处:www.tangshua转载请注明出处:www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】ng.net【作者:唐霜】未经授权,禁止复制转载。

batch

发起一个批量任务。

【版权所有】唐霜 www.tangshu【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。ang.net【版权所有,侵权必究】【原创内容,转载请注明出处】
store.batch([
  objectStore => objectStore.put(obj1),
  objectStore => objectStore.put(obj2),
  objectStore => objectStore.remove(obj3),
], {
  writable: true,
})

keyPath

这是一个属性,快速获取当前store的主【关注微信公众号:wwwtangshuangnet】未经授权,禁止复制转载。键名。

本文版权归作者所有,未经授权不得转载。【关注微信公众号:wwwtangshua著作权归作者所有,禁止商业用途转载。【转载请注明来源】ngnet】【本文首发于唐霜的博客】本文作者:唐霜,转载请注明出处。
let keyPath = store.keyPath

数据库管理

前面的所有一切,都是只对当前的store本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net进行操作,如果你希望切换到另外一个sto【版权所有】唐霜 www.tangshuang.net著作权归作者所有,禁止商业用途转载。re进行操作怎么办呢?

转载请注明出处:www.tangshua【转载请注明来源】【访问 www.tangshuang.net 获取更多精彩内容】ng.net【访问 www.tangshuang.n著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。et 获取更多精彩内容】【本文首发于唐霜的博客】著作权归作者所有,禁止商业用途转载。

connect

打开一个数据库连接。

【关注微信公众号:wwwtangshua【作者:唐霜】【转载请注明来源】ngnet】【未经授权禁止转载】本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshu原创内容,盗版必究。【原创不易,请尊重版权】ang.net
const db = idb.connect()

use

基于当前的数据库配置,切换到一个stor【关注微信公众号:wwwtangshuangnet】【转载请注明来源】e。

未经授权,禁止复制转载。未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。
const store2 = idb.use('store2')

注意:use是一个同步方法,和其他大部分转载请注明出处:www.tangshuang.net【转载请注明来源】方法不同,它不返回一个promise,而【关注微信公众号:wwwtangshuangnet】【原创内容,转载请注明出处】是直接返回一个InDBStore实例。

【版权所有】唐霜 www.tangshu著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。ang.net【转载请注明来源】【原创内容,转载请注明出处】未经授权,禁止复制转载。

close

关闭当前数据库连接。几乎不会用到。

【原创不易,请尊重版权】原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。【原创不易,请尊重版权】

version

由于indexedDB的特点是,你一旦创【版权所有】唐霜 www.tangshuang.net【本文受版权保护】建数据库之后,不可以随意修改数据的任何结【本文首发于唐霜的博客】【本文受版权保护】构,因此,你不能通过修改代码来实现数据库本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。结构调整。如果哪一天,你真的需要调整数据【关注微信公众号:wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.net了怎么办?

【本文首发于唐霜的博客】【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。

你需要明白一个道理,indexedDB是【本文受版权保护】【版权所有,侵权必究】在用户的浏览器的,你不可能像MySQL一【原创内容,转载请注明出处】【作者:唐霜】样自己去执行一些脚步一次性修改。怎么做呢【原创不易,请尊重版权】原创内容,盗版必究。?就是在你新发布的代码中,增加versi原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.neton,并且修改options。

本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshu本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。ang.net原创内容,盗版必究。

前端项目的脚步很多都会放在CDN,在你下【关注微信公众号:wwwtangshuangnet】原创内容,盗版必究。一次进行发布时,你需要修改你的代码:

著作权归作者所有,禁止商业用途转载。【关注微信公众号:wwwtangshua【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。ngnet】
export const store = new InDB({
  name: 'my-idb',
  version: 2,
  stores: [
    {
      name: 'my-store',
      isKv: true,
    },
    {
      name: 'my-store2',
      keyPath: 'id',
    },
  ],
  use: 'my-store',
})
export const store2 = store.use('store2')

上面的代码表示,我在新版本中,新增了一个本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.netstore,并通过升级version来使未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。得这个修改生效。一次修改,必须基于前一个转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。版本进行,否则你会发现,你的数据库管理非【本文受版权保护】【本文首发于唐霜的博客】常混乱。

本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshua【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。ng.net本文版权归作者所有,未经授权不得转载。【转载请注明来源】
【版权所有】唐霜 www.tangshu著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。ang.net【原创不易,请尊重版权】【访问 www.tangshuang.n著作权归作者所有,禁止商业用途转载。【关注微信公众号:wwwtangshuangnet】et 获取更多精彩内容】原创内容,盗版必究。

结语

我从去年开始不断深入学习indexedD【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。B,甚至对google的leveldb都著作权归作者所有,禁止商业用途转载。【原创不易,请尊重版权】进行了一定的了解,很多人都不知道,chr【转载请注明来源】【转载请注明来源】ome里面的indexedDB有一个特点【原创不易,请尊重版权】转载请注明出处:www.tangshuang.net:读慢写快,如果不是深入了解,根本不会明未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.net白为什么会出现这样的特点。在整个学习过程本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshuang.net中,我发现,对于开发者而言,了解这些深层本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。次的知识虽然是有必要的,但是却无法快速入【转载请注明来源】【原创内容,转载请注明出处】门,上手使用,每天要写重复的reques【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。t代码,会让人崩溃。一个真正好的开发工具著作权归作者所有,禁止商业用途转载。原创内容,盗版必究。,是帮助开发者抹平这些复杂的凹凸不平的底本文作者:唐霜,转载请注明出处。【本文受版权保护】层信息,只给开发者最直观好用的结果。这也本文作者:唐霜,转载请注明出处。【未经授权禁止转载】是我这两年来越来越注重的事。如果你觉得这【本文首发于唐霜的博客】【版权所有,侵权必究】个项目还不错,请在我的github上点s【访问 www.tangshuang.net 获取更多精彩内容】本文版权归作者所有,未经授权不得转载。tar,让更多人了解它。

【版权所有,侵权必究】【原创内容,转载请注明出处】

去github点star

【转载请注明来源】原创内容,盗版必究。

(完)

原创内容,盗版必究。转载请注明出处:www.tangshua转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。ng.net【作者:唐霜】【版权所有,侵权必究】

 

原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。
【关注微信公众号:wwwtangshua【本文首发于唐霜的博客】【本文首发于唐霜的博客】ngnet】未经授权,禁止复制转载。【版权所有,侵权必究】本文作者:唐霜,转载请注明出处。
未经授权,禁止复制转载。【访问 www.tangshuang.n【关注微信公众号:wwwtangshuangnet】转载请注明出处:www.tangshuang.netet 获取更多精彩内容】本文作者:唐霜,转载请注明出处。
【原创不易,请尊重版权】【版权所有】唐霜 www.tangshu原创内容,盗版必究。【关注微信公众号:wwwtangshuangnet】ang.net【关注微信公众号:wwwtangshua【转载请注明来源】转载请注明出处:www.tangshuang.netngnet】本文作者:唐霜,转载请注明出处。

如果你觉得本书对你有帮助,通过下方的二维码向我打赏吧,帮助我写出更多有用的内容。

2018-09-15

已有32条评论
  1. 杜凯文 2022-05-18 21:02

    博主你好,请问如果有的浏览器不兼容indexDB,new InDB()会返回什么?

    • 否子戈 2022-05-18 22:08

      这个需要你提供具体的一个场景,indexedDB的兼容性可以通过caniuse.com查询

      • 杜凯文 2022-05-23 11:57

        目前还没找到不兼容的场景,主要是我想知道InDB初始化失败会返回的内容是什么?我方便判断错误条件成立,做一下错误处理。

        • 否子戈 2022-05-25 15:58

          可以遇到问题再及时反馈

  2. Tb 2022-01-12 10:20

    博主!事务那里怎么一笔带过?要怎么使用?

  3. 垂涎自由 2021-05-27 12:07

    {
          name: ‘Indb’,
          version: 1,
          stores: [
            {
              name: ‘Version’,
              keyPath: ‘Version’,
              isKv: true,
              indexes: [
                {
                  name: ‘dict_code’,
                  keyPath: ‘dict_code’,
                  unique: true
                },
                {
                  name: ‘dict_name’,
                  keyPath: ‘dict_name’,
                  unique: false
                }
              ]
            }
          ]
        }

    store.put(
          {
            dict_code: ‘devicecompareitem’,
            dict_load_way: ‘0’,
            dict_name: ‘设备对照’,
            dict_version: 26,
            id: ‘8ae4e6f45f57107a015f57c35dfc001e’,
          }
        )

    为什么我这样put,老是报 【 Failed to execute ‘put’ on ‘IDBObjectStore’: Evaluating the object store’s key path did not yield a value.】

    • 否子戈 2021-05-28 13:08

      你keyPath定的Version,但你put的值没这个字段
      另外,你isKv:true,代表你这个store是一个kv库,你只能用setItem

      • 垂涎自由 2021-06-15 17:00

        上面的问题解决了,又出现一个新的问题。我用get 无法获取值。结果始终是 undefined。store 设置了 keyPath,我也是用keyPath 的值去get,【主键值,注意,是值,不是名】。但是用 find 就没问题。请大佬给指点一二

        • 否子戈 2021-06-15 17:56

          不给case让我凭空想象,我也很为难啊……gitee 走一个?

          • 垂涎自由 2021-06-15 18:24

            async find (_dbName, _store, _indexName, _indexValue) {
                return this.indbOpen(_dbName, _store).find(_indexName, _indexValue)
              },

            使用find 的时候 ,everything is well

          • 否子戈 2021-06-15 22:04

            要看就给个完整的代码看啊,你这种丢一段代码谁能看出来?

  4. 嘎嘎 2021-05-08 17:20

    select多条件查询时查不到数据  明明有匹配的数据 但返回一直是空数组
    var objs = await userStore.select([
                        { key: ‘birthday_month’, value: 4, compare: ‘=’ },
                        { key: ‘birthday_date’, value: 22, compare: ‘=’ },
                    ])

    • 否子戈 2021-05-08 23:39

      已经修复了,升级到最新版本应该就可以了,感谢指出问题

  5. lee 2021-02-24 15:43

    请问一下支持批量添加?如何实现?

    • 否子戈 2021-03-01 10:06

      你可以给 put 传入一个数组,把要添加的多条记录一次性传入,比如:

      “`
      await put([
        { id: 1, value: ‘111’ },
        { id: 2, value: ‘222’ },
      ])
      “`

  6. lee 2021-02-24 15:42

    支持批量添加?如何实现?

  7. 大海 2020-12-17 15:36

    IE 浏览器试过吗,我这里试了IE不行

  8. 低手 2020-07-25 10:45

    我使用了这个多条件select,但是怎么配合some取10条数据,做分页?

    • 否子戈 2020-07-25 11:58

      select一次性取出所有数据,暂不支持分页。如果你一定要分页,可以看下用iterate自己实现一个类似的方法。

      • 低手 2020-07-25 12:40

        那可以加条件,按新旧,数字大小来排序功能吗

        • 否子戈 2020-07-25 12:54

          indexedDb本身没有提供排序的能力,你提出的这些排序需求,最终还是落实到js排序,属于算法层面的东西,所以我也不会提供排序的功能。
          关于indexedDB的所有功能,你可以阅读我文档开头提到的另外一篇文档,了解完整的indexedDB能力。

          • 低手 2020-07-25 17:49

            unique: true 我一个索引名称里的值用了不能重复值 ,然后再用put添加数据有重复的就出错,这个怎么解决。

  9. 噬蛇之牙 2019-06-04 11:09

    some这个方法,可以实现查询某个索引区间,返回前10条,或10-20条的数据吗?

    • 否子戈 2019-06-04 20:21

      你具体阅读一下 offset 的解释

  10. 噬蛇之牙 2019-06-03 17:22

    追问:
    remove和delete有什么区别,好像都是通过主键删除行

    • 否子戈 2019-06-03 17:37

      remove 接收整个 object 也是调用 delete 去删

      • 噬蛇之牙 2019-06-03 17:47

        remove中主键是必传项,似乎和delete的功能重复,没有设置的意义

        • 否子戈 2019-06-03 17:58

          具体的使用场景不同,要用到的时候你自然会去用

  11. 噬蛇之牙 2019-06-03 16:23

    拜读了教程,有些许不明白的地方
    1、keyPath可以是链式的多级属性,这个不明白什么含义,能举个使用例子吗?
    2、如何实现批量添加和删除多个行?

    • 否子戈 2019-06-03 17:34

      阅读一下教程里面关于keyPath的部分,简单说就是可以用 parent.child 这种形式做主键。

      目前没有批量删。后期我把批量删除功能加上吧。