From b47e6592e81a59402bedea7d97fe0882d03a8ccf Mon Sep 17 00:00:00 2001 From: Christian Mollekopf Date: Wed, 10 Feb 2016 12:29:48 +0100 Subject: Docs --- docs/design.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') 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 @@ Sink is a data access layer that additionally handles synchronization with external sources and indexing of data for efficient queries. -## Client API -The client facing API hides all Sink internals from the applications and emulates a unified store that provides data through a standardized interface. +## Store +The client facing Store API hides all Sink internals from the applications and emulates a unified store that provides data through a standardized interface. This allows applications to transparently use various data sources with various data source formats. ## Resource 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. -## Store / Indexes +## Storage / Indexes 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. -The store consits of revisions with every revision containing one entity. +The store consists of revisions with every revision containing one entity. The store additionally contains various secondary indexes for efficient lookups. -- cgit v1.2.3