Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scl.db / scl / Simantics / DB.md

diff --git a/bundles/org.simantics.scl.db/scl/Simantics/DB.md b/bundles/org.simantics.scl.db/scl/Simantics/DB.md
new file mode 100644 (file)
index 0000000..dd6e5d0
--- /dev/null
+++ b/bundles/org.simantics.scl.db/scl/Simantics/DB.md
@@ -0,0 +1,111 @@
+# DB module documentation\r
+\r
+::data[Resource]\r
+\r
+## Reading\r
+\r
+### URIs\r
+\r
+::value[resource, possibleResource, relativeResource]\r
+\r
+### Graph hierarchy\r
+\r
+::class[Browsable]\r
+\r
+### Objects\r
+\r
+::value[#, singleObject, possibleObject]\r
+::value[objectsWithType]\r
+\r
+### Statements\r
+\r
+::data[Statement]\r
+::value[subjectOf, predicateOf, objectOf]\r
+::value[statements, singleStatement]\r
+\r
+### Special objects\r
+\r
+::value[singleTypeOf, possibleTypeOf]\r
+::value[inverseOf]\r
+\r
+### Literals\r
+\r
+::value[relatedValue, possibleRelatedValue]\r
+::value[relatedValue2]\r
+::value[untypedValueOf, untypedRelatedValue, untypedPossibleRelatedValue]\r
+\r
+### Predicates\r
+\r
+::value[isInstanceOf, isSubrelationOf, isInheritedFrom, isParent]\r
+::value[existsStatement, existsStatement3]\r
+\r
+### Special resources\r
+\r
+::value[currentModel, currentProject, getRootLibrary, listOntologies]\r
+\r
+### Resource id\r
+\r
+::value[resourceId, resourceFromId]\r
+\r
+## Writing\r
+\r
+### Adding statements\r
+\r
+::value[newResource]\r
+::value[claim]\r
+::value[deny, denyByPredicate, denyAllStatements]\r
+::value[claimAssertion]\r
+\r
+### Writing literals\r
+\r
+::value[claimRelatedValue, claimRelatedValueWithType]\r
+::value[untypedClaimRelatedValue]\r
+::value[denyValue]\r
+\r
+## Ordered sets\r
+\r
+::value[addToOrderedSet]\r
+::value[setOrderedSet]\r
+::value[elementsOfOrderedSet]\r
+::value[parentOrderedSet]\r
+\r
+## Transactions\r
+\r
+::value[syncRead, asyncRead]\r
+::value[syncWrite, asyncWrite]\r
+::value[virtualSyncWriteMem, virtualSyncWriteWS] \r
+::value[lift1Read, lift2Read, lift3Read]\r
+::value[lift1Write, lift2Write, lift3Write]\r
+::value[addCommentMetadata]\r
+::value[makeSynchronous]\r
+::value[enableDependencies, disableDependencies]\r
+\r
+## Undo\r
+\r
+::value[markUndoPoint, startUndoPoint]\r
+::value[undo, redo, undoOperations]\r
+\r
+## Generation of resource names\r
+\r
+::value[findFreshName, findFreshEscapedName]\r
+\r
+## Helper functions for handling URIs\r
+\r
+::value[escapeURI, unescapeURI, splitURI]\r
+\r
+## Structured graph writing\r
+\r
+::value[newEntity]\r
+::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent]\r
+\r
+## Clusters\r
+\r
+::value[newClusterSet, selectClusterSet, sortByCluster]\r
+\r
+## Debugging\r
+\r
+::value[queryDebugSupport, queryListSupport]\r
+\r
+## Miscellaneous functions\r
+\r
+::undocumented[]
\ No newline at end of file