]> gerrit.simantics Code Review - simantics/platform.git/blob - docs/Developer/Database/InterfaceSummary.md
First test on Simantics documentation using gitbook
[simantics/platform.git] / docs / Developer / Database / InterfaceSummary.md
1 # Interface summary\r
2 \r
3 ## General\r
4 \r
5 ### org.simantics.Simantics\r
6 \r
7 This static class can be used to obtain the active Session.\r
8 \r
9 ### org.simantics.db.Session\r
10 \r
11 The Session interface represents the connection into the semantic database. Implements e.g. `RequestProcessor` and serves various special interfaces via the `getService`-method.\r
12 \r
13 ## Reading and writing\r
14 \r
15 ### org.simantics.db.RequestProcessor\r
16 \r
17 `RequestProcessor` is a synchronous interface for making read queries and writes to the semantic database. Main implementations are `Session`, `ReadGraph` and `WriteGraph`.\r
18 \r
19 ### org.simantics.db.Read\r
20 \r
21 The interface Read represents a query, which produces a single result. Main implementations are `ResourceRead*` and `*naryRead`.\r
22 \r
23 ### org.simantics.db.Write\r
24 \r
25 The interface `Write` represents a modification into the semantic database. Main implementation is `WriteRequest`.\r