docs/javascript_driver.markdown · project-m36

git.iko.soy/project-m36

project-m36/docs/javascript_driver.markdown

21 lines 1.1 kB history raw

1# Project:M36 JavaScript Driver

3## Introduction

5 The JavaScript database driver for Project:M36 is a fully-featured database driver for the Project:M36 Relational Algebra Engine DBMS. The driver's only dependency is a working websockets implementation which is provided by virtually any modern web browser and node.js. The API is callback-based.

7 ## Usage

91. [Download the driver](/src/bin/ProjectM36/Websocket/project-m36.js).

101. Connect to the websocket server with a ```new ProjectM36Connection(..)``` including the asynchronous callback functions.

111. When the ```openCallback``` is called, the database is ready to execute TutorialD sing the ```executeTutorialD()``` function.

121. Implement ```statusCallback``` to update your user interface for expected and asynchronous event handling.

14## Example

16A fully-functioning interactive websocket client is available:

18* [websocket-client.html](/src/bin/ProjectM36/Server/WebSocket/websocket-client.html)

19* [websocket-client.js](/src/bin/ProjectM36/Server/WebSocket/websocket-client.js)

21This example also powers [try.project-m36.io](https://try.project-m36.io).