X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=docs%2FDeveloper%2FDatabase%2FInterfaceSummary.md;fp=docs%2FDeveloper%2FDatabase%2FInterfaceSummary.md;h=bb42d56ed6ac62eb7ed1f60d5ab482909d17e43a;hp=0000000000000000000000000000000000000000;hb=a9ec58f08ccc02e65b1cab6aedff25e0cf3c6444;hpb=5998374f7e179cfaf451c220216adc18c823047f diff --git a/docs/Developer/Database/InterfaceSummary.md b/docs/Developer/Database/InterfaceSummary.md new file mode 100644 index 000000000..bb42d56ed --- /dev/null +++ b/docs/Developer/Database/InterfaceSummary.md @@ -0,0 +1,25 @@ +# Interface summary + +## General + +### org.simantics.Simantics + +This static class can be used to obtain the active Session. + +### org.simantics.db.Session + +The Session interface represents the connection into the semantic database. Implements e.g. `RequestProcessor` and serves various special interfaces via the `getService`-method. + +## Reading and writing + +### org.simantics.db.RequestProcessor + +`RequestProcessor` is a synchronous interface for making read queries and writes to the semantic database. Main implementations are `Session`, `ReadGraph` and `WriteGraph`. + +### org.simantics.db.Read + +The interface Read represents a query, which produces a single result. Main implementations are `ResourceRead*` and `*naryRead`. + +### org.simantics.db.Write + +The interface `Write` represents a modification into the semantic database. Main implementation is `WriteRequest`.