README.md 2.54 KB
Newer Older
Dave Griffiths's avatar
docs  
Dave Griffiths committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
Symbai/Starwisp
===============

This is a data syncing application for remote use with a raspberry pi and
android devices.

Development notes
=================

Data model
----------

The sqlite database is using an entity-attribute-value system so data types can
be added dynamically, with only an android application update required.

Each item in the database is an entity, which contains a version number,
a local id (the primary key) which is defined on the local database only
and a unique-id which is common to all databases across the
network. Entities are split into different types, and are associated
with attributes which make up their contents. The attributes of the
entity are stored in key-type-value attributes (ktv). Entities are
comprised of multiple ktv attributes.

When an entity is edited, it's flagged as dirty - along with the
individual attributes which are changed.

The entity dirty flag is used to determine which entities need to be
sent to the server when syncing, and the attribute's dirty flags
indicate which individual items need sending.

The server increments the entity version number on reciept of a changed
values, which is used to determine which entities are needed updating on
other clients.

In this way, data changes are merged and propagated through the system.


Dave Griffiths's avatar
docs  
Dave Griffiths committed
38 39
Syncing algorithm
-----------------
Dave Griffiths's avatar
docs  
Dave Griffiths committed
40

Dave Griffiths's avatar
docs  
Dave Griffiths committed
41
Sending data from client to server is all about dirty flags:
Dave Griffiths's avatar
docs  
Dave Griffiths committed
42 43 44 45 46 47 48

| Android (client)              |   Raspberry Pi (server       |
|-------------------------------|------------------------------|
| Data edited or created - cause entities and attributes to be flagged as 'dirty' |      |
| For each dirty entity, send all dirty attributes | Return message to confirm reciept |
|                               | Overwrite all dirty attributes, increment version number |

Dave Griffiths's avatar
docs  
Dave Griffiths committed
49 50
Receiving changes from the server to the client is all about version numbers:

Dave Griffiths's avatar
docs  
Dave Griffiths committed
51 52 53 54 55 56 57
| Android (client)              |   Raspberry Pi (server       |
|-------------------------------|------------------------------|
| Request all entity version numbers | Send versions...      |
| Check each local entity, request updates | Send complete entity, with all attributes |
| Overwrite/add new entities    |  |


Dave Griffiths's avatar
docs  
Dave Griffiths committed
58 59
Code dependancies
-----------------
Dave Griffiths's avatar
docs  
Dave Griffiths committed
60

Dave Griffiths's avatar
docs  
Dave Griffiths committed
61
Common code is stored in /eavdb and is platform independant, running on android (tinyscheme) and raspberry pi (racket).
Dave Griffiths's avatar
docs  
Dave Griffiths committed
62

Dave Griffiths's avatar
docs  
Dave Griffiths committed
63 64 65 66 67 68 69
         ktv ---> ktv-list      sql/racket-fix
          \         |              /
           \        V             /
            --> entity-values  <--
                    |
                    V
                 entity-insert