diff options
Diffstat (limited to 'docs/design.md')
-rw-r--r-- | docs/design.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/design.md b/docs/design.md index 9b64056..2890450 100644 --- a/docs/design.md +++ b/docs/design.md | |||
@@ -2,16 +2,16 @@ | |||
2 | 2 | ||
3 | Sink is a data access layer that additionally handles synchronization with external sources and indexing of data for efficient queries. | 3 | Sink is a data access layer that additionally handles synchronization with external sources and indexing of data for efficient queries. |
4 | 4 | ||
5 | ## Client API | 5 | ## Store |
6 | The client facing API hides all Sink internals from the applications and emulates a unified store that provides data through a standardized interface. | 6 | The client facing Store API hides all Sink internals from the applications and emulates a unified store that provides data through a standardized interface. |
7 | This allows applications to transparently use various data sources with various data source formats. | 7 | This allows applications to transparently use various data sources with various data source formats. |
8 | 8 | ||
9 | ## Resource | 9 | ## Resource |
10 | A resource is a plugin that provides access to an additional source. It consists of a store, a synchronizer process that executes synchronization & change replay to the source and maintains the store, as well as a facade plugin for the client api. | 10 | A resource is a plugin that provides access to an additional source. It consists of a store, a synchronizer process that executes synchronization & change replay to the source and maintains the store, as well as a facade plugin for the client api. |
11 | 11 | ||
12 | ## Store / Indexes | 12 | ## Storage / Indexes |
13 | Each resource maintains a store that can either store the full dataset for offline access or only metadata for quick lookups. Resources can define how data is stored. | 13 | Each resource maintains a store that can either store the full dataset for offline access or only metadata for quick lookups. Resources can define how data is stored. |
14 | The store consits of revisions with every revision containing one entity. | 14 | The store consists of revisions with every revision containing one entity. |
15 | 15 | ||
16 | The store additionally contains various secondary indexes for efficient lookups. | 16 | The store additionally contains various secondary indexes for efficient lookups. |
17 | 17 | ||