IndexedDB: Support Array-type key paths
[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 module storage {
27
28     interface [
29         Conditional=INDEXED_DATABASE
30     ] IDBObjectStore {
31         readonly attribute [TreatReturnedNullStringAs=Null] DOMString name;
32         readonly attribute IDBAny keyPath;
33         readonly attribute DOMStringList indexNames;
34         readonly attribute IDBTransaction transaction;
35         readonly attribute boolean autoIncrement;
36
37         [CallWith=ScriptExecutionContext] IDBRequest put(in SerializedScriptValue value, in [Optional] IDBKey key)
38             raises (IDBDatabaseException);
39         [CallWith=ScriptExecutionContext] IDBRequest add(in SerializedScriptValue value, in [Optional] IDBKey key)
40             raises (IDBDatabaseException);
41         [CallWith=ScriptExecutionContext, ImplementedAs=deleteFunction] IDBRequest delete(in IDBKeyRange keyRange)
42             raises (IDBDatabaseException);
43         [CallWith=ScriptExecutionContext, ImplementedAs=deleteFunction] IDBRequest delete(in IDBKey key)
44             raises (IDBDatabaseException);
45         [CallWith=ScriptExecutionContext] IDBRequest clear()
46             raises (IDBDatabaseException);
47         [CallWith=ScriptExecutionContext] IDBRequest get(in IDBKeyRange key)
48             raises (IDBDatabaseException);
49         [CallWith=ScriptExecutionContext] IDBRequest get(in IDBKey key)
50             raises (IDBDatabaseException);
51         [CallWith=ScriptExecutionContext] IDBRequest openCursor(in [Optional] IDBKeyRange range, in [Optional] DOMString direction)
52             raises (IDBDatabaseException);
53         [CallWith=ScriptExecutionContext] IDBRequest openCursor(in IDBKey key, in [Optional] DOMString direction)
54             raises (IDBDatabaseException);
55
56         // FIXME: remove these when https://bugs.webkit.org/show_bug.cgi?id=85326 is fixed.
57         [CallWith=ScriptExecutionContext] IDBRequest openCursor(in [Optional] IDBKeyRange range, in [Optional] unsigned short direction)
58             raises (IDBDatabaseException);
59         [CallWith=ScriptExecutionContext] IDBRequest openCursor(in IDBKey key, in [Optional] unsigned short direction)
60             raises (IDBDatabaseException);
61
62         IDBIndex createIndex(in DOMString name, in DOMString[] keyPath, in [Optional] Dictionary options)
63             raises (IDBDatabaseException);
64         IDBIndex createIndex(in DOMString name, in DOMString keyPath, in [Optional] Dictionary options)
65             raises (IDBDatabaseException);
66         IDBIndex index(in DOMString name)
67             raises (IDBDatabaseException);
68         void deleteIndex(in DOMString name)
69             raises (IDBDatabaseException);
70         [CallWith=ScriptExecutionContext] IDBRequest count(in [Optional] IDBKeyRange range)
71             raises (IDBDatabaseException);
72         [CallWith=ScriptExecutionContext] IDBRequest count(in IDBKey key)
73             raises (IDBDatabaseException);
74     };
75 }