First test on Simantics documentation using gitbook

[simantics/platform.git] / docs / Developer / Database / InterfaceSummary.md

diff --git a/docs/Developer/Database/InterfaceSummary.md b/docs/Developer/Database/InterfaceSummary.md
new file mode 100644 (file)
index 0000000..bb42d56
--- /dev/null
+++ b/docs/Developer/Database/InterfaceSummary.md
@@ -0,0 +1,25 @@
+# Interface summary\r
+\r
+## General\r
+\r
+### org.simantics.Simantics\r
+\r
+This static class can be used to obtain the active Session.\r
+\r
+### org.simantics.db.Session\r
+\r
+The Session interface represents the connection into the semantic database. Implements e.g. `RequestProcessor` and serves various special interfaces via the `getService`-method.\r
+\r
+## Reading and writing\r
+\r
+### org.simantics.db.RequestProcessor\r
+\r
+`RequestProcessor` is a synchronous interface for making read queries and writes to the semantic database. Main implementations are `Session`, `ReadGraph` and `WriteGraph`.\r
+\r
+### org.simantics.db.Read\r
+\r
+The interface Read represents a query, which produces a single result. Main implementations are `ResourceRead*` and `*naryRead`.\r
+\r
+### org.simantics.db.Write\r
+\r
+The interface `Write` represents a modification into the semantic database. Main implementation is `WriteRequest`.\r