src/third_party/WebKit/Source/modules/indexeddb/IDBObjectStore.idl

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 [
  27     WillBeGarbageCollected
  28 ] interface IDBObjectStore {
  29     [TreatReturnedNullStringAs=Null] readonly attribute DOMString name;
  30     [CallWith=ScriptState] readonly attribute any keyPath;
  31     readonly attribute DOMStringList indexNames;
  32     readonly attribute IDBTransaction transaction;
  33     readonly attribute boolean autoIncrement;
  34
  35     [CallWith=ExecutionContext, RaisesException] IDBRequest put(any value, [Default=Undefined] optional any key);
  36     [CallWith=ExecutionContext, RaisesException] IDBRequest add(any value, [Default=Undefined] optional any key);
  37     [CallWith=ExecutionContext, ImplementedAs=deleteFunction, RaisesException] IDBRequest delete(any key);
  38     [CallWith=ExecutionContext, RaisesException] IDBRequest clear();
  39     [CallWith=ExecutionContext, RaisesException] IDBRequest get(any key);
  40     [CallWith=ExecutionContext, RaisesException] IDBRequest openCursor([Default=Undefined] optional any range, [Default=NullString] optional DOMString direction);
  41     [CallWith=ExecutionContext, RaisesException, RuntimeEnabled=IndexedDBExperimental] IDBRequest openKeyCursor([Default=Undefined] optional any range, [Default=NullString] optional DOMString direction);
  42
  43     [CallWith=ScriptState, RaisesException] IDBIndex createIndex(DOMString name, sequence<DOMString> keyPath, optional Dictionary options);
  44     [CallWith=ScriptState, RaisesException] IDBIndex createIndex(DOMString name, DOMString keyPath, optional Dictionary options);
  45     [RaisesException] IDBIndex index(DOMString name);
  46     [RaisesException] void deleteIndex(DOMString name);
  47     [CallWith=ExecutionContext, RaisesException] IDBRequest count([Default=Undefined] optional any key);
  48 };