Archive. Posts from 2004 to 2016, kept as they were written. My current blog is at dariuszparys.com.

MIt HTML5 Labs stellen wir HTML5 Prototyp Implementierungen zur Verfügung. Ich habe mir mal die IndexedDB Implementierung angeschaut. Zuerst muss man sich die Frage stellen, wie erweitert man die JavaScript Funktionalität des Internet Explorers? Die Antwort heißt: Component Object Model oder kurz COM.

Installation

Die Implementierung kommt mit zwei COM Objekten daher die unter der Haube den SQL Server Compact 4 benutzen. Einmal mit einer Synchronen Schnittstelle und mit der asynchronen Variante. DIe Installation des Prototypen ist einfach. Zuerst lädt man sich das Paket herunter, danach registriert man in einem elevierten Kommandofenster die entsprechende COM dll mittels regsvr32.

regsvr32 sqlcejse40.dll

Nach der Registrierung muss man den IE9 allerdings auch priviligiert starten um mit dem Prototyp zu arbeiten.

Man benötigt immer ein Initialisierungsskript. Schliesslich ist die Funktionalität in der COM Komponente drinnen und wir möchten das ganze aus JavaScript nutzen. Das Paket kommt mit einem solchen Skript mit und nennt sich bootidb.js. Ein Blick in die entsprechende Codezeile verrät uns auch das auf dem window Element entsprechend eine Eigenschaft indexedDB hinzugefügt wird:

if (!window.indexedDB) {
    window.indexedDB = new ActiveXObject("SQLCE.Factory.4.0");
    window.indexedDBSync = new ActiveXObject("SQLCE.FactorySync.4.0");

Was mir so nie bewußt war ist die Möglichkeit jedes IDispatch fähige Objekt in das HTML DOM des Browser zu stecken. Schaut man sich nämlich mal die Typelibrary der COM Objekte an so sieht man die Methoden die man schliesslich aus JavaScript heraus direkt benutzt:

[
  odl,
  uuid(567270C8-E61A-4A8D-9C2E-2D2EC47D8704),
  helpstring("ObjectStore - Asynchronous interface"),
  dual,
  nonextensible,
  oleautomation
]
interface IDBObjectStoreRequest : IDBObjectStore {
    [id(0x60040000)]
    HRESULT put(
                    [in] VARIANT value,
                    [in, optional] VARIANT key,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040001)]
    HRESULT add(
                    [in] VARIANT value,
                    [in, optional] VARIANT key,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040002)]
    HRESULT get(
                    [in] VARIANT key,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040003)]
    HRESULT remove(
                    [in] VARIANT key,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040004)]
    HRESULT createIndex(
                    [in] BSTR name,
                    [in] BSTR keyPath,
                    [in, optional] VARIANT unique,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040005)]
    HRESULT index(
                    [in] BSTR indexName,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040006)]
    HRESULT deleteIndex(
                    [in] BSTR indexName,
                    [out, retval] IDBRequest** ppWebRequest);
    [id(0x60040007)]
    HRESULT openCursor(
                    [in, optional] VARIANT range,
                    [in, optional] VARIANT direction,
                    [out, retval] IDBRequest** ppWebRequest);
};

Ach ja, ich möchte noch folgendes Erwähnen.

Wichtig: Diese Registrierung ist nur Notwendig für diese Prototyp Implementierung. Falls IndexedDB in einen stabilen Spec Zustand kommt und die Funktionalität in den Browser wandert, so wird die Implementierung Bestandteil des Browsers und kann somit auch direkt aus JavaScript heraus genutzt werden ohne irgendwelche Hacks wie es jetzt bei der Prototyp Implementierung der Fall ist! Wollte das nur mal Klarstellen.

IndexedDB in Action

Nach der Installation können wir auch die Funktionalität direkt nutzen. Im Paket sind neben den Readme’s und der DLL auch Beispiele enthalten. Eines der Beispiele ist ein BugTracking System. Lädt man die Seite nun lokal in den Browser so kann man direkt Bugs erfassen und auch wieder suchen.

bugtracking with indexeddb

Das untere Bild zeigt wie man nach dem “Test Projekt” sucht und die Ergebnisse angezeigt bekommt:

searching in indexeddb

Die Daten werden letztlich in einer SQL CE Datebank abgelegt und zwar als serialisiertes JSON (JavaScript Object Notation). Mittels eines SQL Server Management Studios kann man auch einen Blick in die Datenbank werfen. Diese findet man unter

%localappdata%\Microsoft\IndexedDatabase

und öffent diese einfach über den Dialog des Management Studios und schon hat man Zugriff auf die Datebank.

indexeddb in sql management studio

Aufgrund der Binär Felder die im Schema benutzt werden kann man allerdings ohne Konvertierungen die Werte nicht direkt einsehen.

indexeddb quried in sql management studio

Unter der Haube

Die Funktionalität der BugTracker Beispielanwendung ist schnell ausprobiert, doch jetzt möchte ich selbst mal eine Datenbank anlegen und Daten speichern. Zuerst einmal entscheide ich mich für die Asynchrone Variante der API. Einfach aus dem Grund da jeder synchrone Aufruf den Browser Request blocken kann. Das möchte man nicht. Man möchte eine Webseite haben die, wie sagt man so schön, “Responsive” ist.

Eine einfache TODO Liste soll hier als Beispiel dienen. Zuerst definiere ich das UI:

<!DOCTYPE html>

<html lang="en">
    <head>
        <meta charset="utf-8" />
        <title></title>
    </head>
    <body>
        <input type=text id=todoitem />
        <input type=submit value=add id=actionAdd />
        <div id=todos></div>
    </body>
</html>

Um IndexedDB zu benutzen brauche ich das Init Script, das füge ich hinzu. Zudem setze ich einen Handler auf den Submit Button der aufgerufen wird sobald dieser gedrückt wird.

<script type="text/javascript" src="bootidb.js"></script>
<script type="text/javascript" src="http://ajax.microsoft.com/ajax/jquery/jquery-1.4.4.min.js"></script>
<script type="text/javascript">
    $(document).ready( function()
    {
        $("#actionAdd").click(function() {
        });
    });
</script>

Der Rahmen ist gelegt, nun geht es um die Daten. Im Beispiel das mitgeliefert wird, wird ein JavaScript Objekt erzeugt das Variablen und Funktionen vorhält. Ich habe mich an diese Vorgehensweise gehalten, da es durchaus sinnvoll ist bei asynchronen Aufrufen alles in einander wiederzuverwenden.

Die eigentliche Implementierung bedient sich auch ein paar Hilfsfunktionen, aber im großen und ganzen läuft es auf diesen Code zum erstellen der Datenbank hinaus:

requestDatabase = window.indexedDB.open(todoDB.db, 'Todo Database');

Das öffnen der Datenbank legt auch gleichzeitig diese an, falls nicht vorhanden. Nun muss man prüfen ob die Tabelle mit der man arbeiten möchte schon erzeugt ist. Die Prüfung ist im Gesamtcode zum Blogpost enthalten, ich möchte nur noch aufzeigen wie man dann letztlich die Tabelle anlegt und gleich noch einen Index hinzufügt.

requestObjectStore = database.createObjectStore(
                                todoDB.objectStore,
                                todoDB.keyPath,
                                true );
requestObjectStore.onsuccess = function(evt)
{
    store = evt.result;
    requestIndex = store.createIndex(
                            todoDB.indexTodo,
                            todoDB.indexTodoKeyPath,
                            false);
    requestIndex.onsuccess = function(evt)
    {
        whenReady();
    }
}

Zur Vereinfachung habe ich die onerror Methoden entfernt. Zeile 1 legt die Tabelle an, Zeile 8 den entsprechenden Index auf ein Tabellenfeld. Benutzt man einen Index hat man die Möglichkeit mit dem Cursor gezielt zu arbeiten und bei einer Suche auch nur Teilbereiche zu ermitteln. Anders ist es wenn man keinen Index hat, da macht man einfach einen Tablescan bis man den gesuchten Datensatz hat.

Auf der anderen Seite bietet die IndexedDB auch die Möglichkeit immer über den Primärschlüssel direkt auf einen Datensatz zuzugreifen. Zum Beispiel ein Datensatz mit dem Primary Key Id 723 kann mittels

store.get(723)

geholt werden. ISAM Datenbanken lassen grüßen.

Der Komplettheit nun der vollständige Code einer einfachen HTML5 TODO List.

Das UI ist nicht sonderlich hübsch, aber es geht ja erstmal nur um die Funktionalität

todo-list-in-action

Fazit

Eine Indexbasierte Datenbank im Browser des Clients zu haben kann für manche Anwendungsszenarien sinnvoll sein. So können zukünftige HTML 5 Anwendungen offline betrieben werden (ja, auch dafür gibt es Specs) die z.B. auch Referenzdaten benötigen. Die Verwendung der API ist Stand heute noch ein wenig mühselig, auch direktes Tooling im Browser fehlt noch komplett, trotzdem ist es ein erster funktionaler Ansatz, der auf Feedback wartet.