db08796d250dfa7678fa8e54a6f30b28caec744b
[WebKit-https.git] / Source / WebCore / 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     Conditional=INDEXED_DATABASE,
28     EnabledAtRuntime=IndexedDB,
29     GenerateIsReachable=Impl,
30     JSCustomMarkFunction,
31     SkipVTableValidation,
32 ] interface IDBObjectStore {
33     readonly attribute DOMString? name;
34     [ImplementationReturnType=IDBKeyPath] readonly attribute any keyPath;
35     readonly attribute DOMStringList indexNames;
36     readonly attribute IDBTransaction transaction;
37     readonly attribute boolean autoIncrement;
38
39     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest put(any value, optional any key);
40     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest add(any value, optional any key);
41     [CallWith=ScriptState, ImplementedAs=deleteFunction, RaisesExceptionWithMessage] IDBRequest delete(IDBKeyRange? keyRange);
42     [CallWith=ScriptState, ImplementedAs=deleteFunction, RaisesExceptionWithMessage] IDBRequest delete(any key);
43     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest get(IDBKeyRange? key);
44     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest get(any key);
45     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest clear();
46     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest openCursor(optional IDBKeyRange? range = null, optional DOMString direction = "next");
47     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest openCursor(any key, optional DOMString direction = "next");
48     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBIndex createIndex(DOMString name, sequence<DOMString> keyPath, optional IDBIndexParameters options);
49     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBIndex createIndex(DOMString name, DOMString keyPath, optional IDBIndexParameters options);
50     [RaisesExceptionWithMessage] IDBIndex index(DOMString name);
51     [RaisesExceptionWithMessage] void deleteIndex(DOMString name);
52     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest count(optional IDBKeyRange? range = null);
53     [CallWith=ScriptState, RaisesExceptionWithMessage] IDBRequest count(any key);
54 };
55
56 dictionary IDBIndexParameters {
57     boolean unique = false;
58     boolean multiEntry = false;
59 };