db.Transaction Extends goog.events.EventTarget
Creates a new transaction. Transactions contain methods for accessing object stores and are created from the database object. Should not be created directly, open a database and call createTransaction on it.

Inheritance

Constructor

goog.db.Transaction(txdb)

Parameters

tx : !IDBTransaction
IndexedDB transaction to back this wrapper.
db : !goog.db.IndexedDb
The database that this transaction modifies.

Instance Methods

Public Protected Private
abort()
Aborts this transaction. No pending operations will be applied to the database. Dispatches an ABORT event.
code »
dispatchError_(ev)
Dispatches an error event based on the given event, wrapping the error if necessary.
Arguments:
ev : Event
The error event given to the underlying IDBTransaction.
code »
disposeInternal()
No description.
code »
getDatabase() !goog.db.IndexedDb
No description.
Returns: !goog.db.IndexedDb  The database that this transaction modifies.
code »
getMode() goog.db.Transaction.TransactionMode
No description.
Returns: goog.db.Transaction.TransactionMode  The transaction's mode.
code »
objectStore(name) !goog.db.ObjectStore
Opens an object store to do operations on in this transaction. The requested object store must be one that is in this transaction's scope.
Arguments:
name : string
The name of the requested object store.
Returns: !goog.db.ObjectStore  The wrapped object store.
code »
wait() !goog.async.Deferred
No description.
Returns: !goog.async.Deferred  A deferred that will fire once the transaction is complete. It fires the errback chain if an error occurs in the transaction, or if it is aborted.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() goog.events.EventTarget
Returns the parent of this event target to use for bubbling.
Returns: goog.events.EventTarget  The parent EventTarget or null if there is no parent.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
opt_capture : boolean=
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope : Object=
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
The database that this transaction modifies.
Code »
eventHandler_ : goog.events.EventHandler
Event handler for this transaction.
Code »
tx_ :
Underlying IndexedDB transaction object.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.db.Transaction.superClass_ :
No description.
Code »

Enumerations

goog.db.Transaction.EventTypes :
Event types the Transaction can dispatch. COMPLETE events are dispatched when the transaction is committed. If a transaction is aborted it dispatches both an ABORT event and an ERROR event with the ABORT_ERR code. Error events are dispatched on any error.
Constants:
ABORT
No description.
COMPLETE
No description.
ERROR
No description.
Code »
goog.db.Transaction.TransactionMode :
The three possible transaction modes.
Constants:
READ_ONLY
No description.
READ_WRITE
No description.
VERSION_CHANGE
No description.
Code »

Package db

Package Reference