Skip to content

Commit e6d6694

Browse files
weber-chrisbjester
authored andcommitted
adding documentation
1 parent 26606a7 commit e6d6694

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

docs/counters/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The **database ID** identifies the actual database being used by a Morango insta
1010

1111
Each syncable model instance within the database is identified by a unique **model source ID**. This is calculated randomly by default and takes the calculated partition and Morango model name into account. Models can also define their own behavior by overriding ``calculate_source_id``.
1212

13+
.. _counters:
1314
Counters
1415
--------
1516

docs/syncing/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,13 @@ In the illustration below, the application layer (on the right) is where app dat
2525

2626
.. image:: ./sync_process.png
2727

28-
Store vs. Buffer
28+
**Store, Buffer \& Dirty Bit**
2929

30-
Dirty-Bit
30+
Both store and buffer are tables in the backend database (generally either SQLite or Postgres). Check `Counters <../counters#counters>`__ for the update logic.
3131

32-
Example:
32+
* **Store**: Holds every Serializable Models in the instance and synced instances including counters / maxcounters.
33+
* **Buffer**: Holds Serializable Models marked for transfer (sending or receiving) during a sync session.
34+
* **Dirty Bit**: Flag in store that is set, when a Serializable Model was updated during a dequeue from the Buffer. Gets unset as soon as the Django Model gets updated and is consistent with the store again.
3335

3436
Orchestration
3537
-------------

0 commit comments

Comments
 (0)