goog.db.ObjectStore

Provided By	`goog.db.ObjectStore`

Creates an IDBObjectStore wrapper object. Object stores have methods for storing and retrieving records, and are accessed through a transaction object. They also have methods for creating indexes associated with the object store. They can only be created when setting the version of the database. Should not be created directly, access object stores through transactions.

new ObjectStore( `store` )

Parameters

`store`	`IDBObjectStore`
	The backing IndexedDb object.

Instance Methods

Adds an object to the object store. Requires that there is no object with the same key already present.

Parameters

`value`	`*`
	The value to add.
`opt_key`	`(number\|string\|Date\|Array<?>\|ArrayBuffer\|ArrayBufferView)=`
	The key to use. Cannot be used if the keyPath was specified for the object store. If the keyPath was not specified but autoIncrement was not enabled, it must be used.

Returns

goog.async.Deferred

The deferred add request.

VIEW SOURCE

Deletes all objects from the store.

Parameters

None.

Returns

goog.async.Deferred

The deferred clear request.

VIEW SOURCE

Gets number of records within a key range.

Parameters

`opt_range`	`goog.db.KeyRange=`
	The key range. If undefined, this will count all records in the object store.

Returns

goog.async.Deferred

The deferred number of records.

VIEW SOURCE

Creates an index in this object store. Can only be called inside a goog.db.UpgradeNeededCallback.

Parameters

`name`	`string`
	Name of the index to create.
`keyPath`	`(string\|Array<string>)`
	Attribute or array of attributes to index on.
`opt_parameters`	`Object=`
	Optional parameters object. The only available option is unique, which defaults to false. If unique is true, the index will enforce that there is only ever one object in the object store for each unique value it indexes on.

Returns

goog.db.Index

The newly created, wrapped index.

Throws

{goog.db.Error} In case of an error creating the index.

VIEW SOURCE

Deletes an index from the object store. Can only be called inside a goog.db.UpgradeNeededCallback.

Parameters

`name`	`string`
	Name of the index to delete.

Throws

{goog.db.Error} In case of an error deleting the index.

VIEW SOURCE

Gets an object from the store. If no object is present with that key the result is undefined.

Parameters

`key`	`(number\|string\|Date\|Array<?>\|ArrayBuffer\|ArrayBufferView)`
	The key to look up.

Returns

goog.async.Deferred

The deferred get request.

VIEW SOURCE

Returns the values matching opt_key up to opt_count.

If obt_key is a KeyRange, returns all keys in that range. If it is undefined, returns all known keys.

Parameters

`opt_key`	`(number\|string\|Date\|Array<?>\|ArrayBuffer\|ArrayBufferView\|goog.db.KeyRange)=`
	Key or KeyRange to look up in the index.
`opt_count`	`number=`
	The number records to return

Returns

goog.async.Deferred

A deferred array of objects that match the key.

VIEW SOURCE

Returns the keys matching opt_key up to opt_count.

If obt_key is a KeyRange, returns all keys in that range. If it is undefined, returns all known keys.

Parameters

`opt_key`	`(number\|string\|Date\|Array<?>\|ArrayBuffer\|ArrayBufferView\|goog.db.KeyRange)=`
	Key or KeyRange to look up in the index.
`opt_count`	`number=`
	The number records to return

Returns

goog.async.Deferred

A deferred array of keys for objects that match the key.

VIEW SOURCE

Gets an index.

Parameters

`name`	`string`
	Name of the index to fetch.

Returns

goog.db.Index

The requested wrapped index.

Throws

{goog.db.Error} In case of an error getting the index.

VIEW SOURCE

Parameters

None.

Returns

string

The name of the object store.

VIEW SOURCE

Opens a cursor over the specified key range. Returns a cursor object which is able to iterate over the given range.

Example usage:


  var cursor = objectStore.openCursor(goog.db.Range.bound('a', 'c'));
var key = goog.events.listen(
cursor, goog.db.Cursor.EventType.NEW_DATA, function() {
// Do something with data.
cursor.next();
});
goog.events.listenOnce(
cursor, goog.db.Cursor.EventType.COMPLETE, function() {
// Clean up listener, and perform a finishing operation on the data.
goog.events.unlistenByKey(key);
});

Parameters

`opt_range`	`goog.db.KeyRange=`
	The key range. If undefined iterates over the whole object store.
`opt_direction`	`goog.db.Cursor.Direction=`
	The direction. If undefined moves in a forward direction with duplicates.

Returns

goog.db.Cursor

The cursor.

Throws

{goog.db.Error} If there was a problem opening the cursor.

VIEW SOURCE

Adds an object to the object store. Replaces existing objects with the same key.

Parameters

`value`	`*`
	The value to put.
`opt_key`	`(number\|string\|Date\|Array<?>\|ArrayBuffer\|ArrayBufferView)=`
	The key to use. Cannot be used if the keyPath was specified for the object store. If the keyPath was not specified but autoIncrement was not enabled, it must be used.

Returns

goog.async.Deferred

The deferred put request.

VIEW SOURCE

Removes an object from the store. No-op if there is no object present with the given key.

Parameters

`keyOrRange`	`(number\|string\|Date\|Array<?>\|ArrayBuffer\|ArrayBufferView\|goog.db.KeyRange)`
	The key or range to remove objects under.

Returns

goog.async.Deferred

The deferred remove request.

VIEW SOURCE

goog.db.ObjectStore

new ObjectStore( `store` )

Instance Methods

`this.`add( `value`, `opt_key` ) `→` `goog.async.Deferred`

`this.`clear() `→` `goog.async.Deferred`

`this.`count( `opt_range` ) `→` `goog.async.Deferred`

`this.`createIndex( `name`, `keyPath`, `opt_parameters` ) `→` `goog.db.Index`

`this.`deleteIndex( `name` ) `→` `void`

`this.`get( `key` ) `→` `goog.async.Deferred`

`this.`getAll( `opt_key`, `opt_count` ) `→` `goog.async.Deferred`

`this.`getAllKeys( `opt_key`, `opt_count` ) `→` `goog.async.Deferred`

`this.`getIndex( `name` ) `→` `goog.db.Index`

`this.`getName() `→` `string`

`this.`openCursor( `opt_range`, `opt_direction` ) `→` `goog.db.Cursor`

`this.`put( `value`, `opt_key` ) `→` `goog.async.Deferred`

`this.`remove( `keyOrRange` ) `→` `goog.async.Deferred`

goog.db.ObjectStore

new ObjectStore( store )

Instance Methods

this.add( value, opt_key ) → goog.async.Deferred

this.clear() → goog.async.Deferred

this.count( opt_range ) → goog.async.Deferred

this.createIndex( name, keyPath, opt_parameters ) → goog.db.Index

this.deleteIndex( name ) → void

this.get( key ) → goog.async.Deferred

this.getAll( opt_key, opt_count ) → goog.async.Deferred

this.getAllKeys( opt_key, opt_count ) → goog.async.Deferred

this.getIndex( name ) → goog.db.Index

this.getName() → string

this.openCursor( opt_range, opt_direction ) → goog.db.Cursor

this.put( value, opt_key ) → goog.async.Deferred

this.remove( keyOrRange ) → goog.async.Deferred

new ObjectStore( `store` )

`this.`add( `value`, `opt_key` ) `→` `goog.async.Deferred`

`this.`clear() `→` `goog.async.Deferred`

`this.`count( `opt_range` ) `→` `goog.async.Deferred`

`this.`createIndex( `name`, `keyPath`, `opt_parameters` ) `→` `goog.db.Index`

`this.`deleteIndex( `name` ) `→` `void`

`this.`get( `key` ) `→` `goog.async.Deferred`

`this.`getAll( `opt_key`, `opt_count` ) `→` `goog.async.Deferred`

`this.`getAllKeys( `opt_key`, `opt_count` ) `→` `goog.async.Deferred`

`this.`getIndex( `name` ) `→` `goog.db.Index`

`this.`getName() `→` `string`

`this.`openCursor( `opt_range`, `opt_direction` ) `→` `goog.db.Cursor`

`this.`put( `value`, `opt_key` ) `→` `goog.async.Deferred`

`this.`remove( `keyOrRange` ) `→` `goog.async.Deferred`