DBを作成するにはGaviaコンストラクタを使います。
gaviaDBObject = new Gavia('DBName', version, { // optional version
'ObjectStoreName': {
keyPath: 'keyName', // optional
autoIncrement: Boolean, // optional
index: { // optional
keyPath: 'indexKeyName', // optional
name: 'indexName', // optional
unique: Boolean, // optional
multiEntry: Boolean // optional
}
},
...
})
名前 | 概要 | デフォルト値 |
---|---|---|
DBName | 作成するDBの名前。 IndexedDB内で一意の文字列を指定。 | 省略不可 |
version | DBのバージョンを指定。 バージョンが上がるとオブジェクトストアの構成を変更する。 | 1 |
ObjectStoreName | 作成するオブジェクトストアの名前。 DB内で一意の文字列を指定。 | 省略不可 |
keyPath | 指定するオブジェクトストアの主キー。 | 省略するとオブジェクトの保存時にキーを指定する必要がある。 |
autoIncrement | オブジェクトを保存するたびにキー値を自動でインクリメントするかどうか。 | |
index | オブジェクトストアのindexを指定。 | |
index: keyPath | indexとなるプロパティの名前。 | オブジェクトストアのkeyPath |
index: name | 作成するindexの名前。 | indexのkeyPath。 |
index: unique | indexが一意かどうか。 | |
index: multiEntry |
作成したgaviaDBObjectへはGavia['DBName']
でも同様にアクセス出来ます。
また、gaviaDBObjectから個々のオブジェクトストアへも、
オブジェクトストア名からプロパティアクセス可能です。
var db = new Gavia('sample-db', {
'sample-store': {
keyPath: 'id'
}
});
assert(db === Gavia['sample-db']);
db['sample-store']; // ストアオブジェクト