X-Git-Url: https://gerrit.simantics.org/r/gitweb?p=simantics%2Fplatform.git;a=blobdiff_plain;f=bundles%2Forg.simantics.scl.db%2Fscl%2FSimantics%2FDB.md;h=d51ecddd8977de485193dade48f218dc19ed3bc7;hp=dd6e5d0bccf51f7453077bd71e438b76e1440610;hb=refs%2Fchanges%2F25%2F2625%2F1;hpb=969bd23cab98a79ca9101af33334000879fb60c5 diff --git a/bundles/org.simantics.scl.db/scl/Simantics/DB.md b/bundles/org.simantics.scl.db/scl/Simantics/DB.md index dd6e5d0bc..d51ecddd8 100644 --- a/bundles/org.simantics.scl.db/scl/Simantics/DB.md +++ b/bundles/org.simantics.scl.db/scl/Simantics/DB.md @@ -1,111 +1,118 @@ -# DB module documentation - -::data[Resource] - -## Reading - -### URIs - -::value[resource, possibleResource, relativeResource] - -### Graph hierarchy - -::class[Browsable] - -### Objects - -::value[#, singleObject, possibleObject] -::value[objectsWithType] - -### Statements - -::data[Statement] -::value[subjectOf, predicateOf, objectOf] -::value[statements, singleStatement] - -### Special objects - -::value[singleTypeOf, possibleTypeOf] -::value[inverseOf] - -### Literals - -::value[relatedValue, possibleRelatedValue] -::value[relatedValue2] -::value[untypedValueOf, untypedRelatedValue, untypedPossibleRelatedValue] - -### Predicates - -::value[isInstanceOf, isSubrelationOf, isInheritedFrom, isParent] -::value[existsStatement, existsStatement3] - -### Special resources - -::value[currentModel, currentProject, getRootLibrary, listOntologies] - -### Resource id - -::value[resourceId, resourceFromId] - -## Writing - -### Adding statements - -::value[newResource] -::value[claim] -::value[deny, denyByPredicate, denyAllStatements] -::value[claimAssertion] - -### Writing literals - -::value[claimRelatedValue, claimRelatedValueWithType] -::value[untypedClaimRelatedValue] -::value[denyValue] - -## Ordered sets - -::value[addToOrderedSet] -::value[setOrderedSet] -::value[elementsOfOrderedSet] -::value[parentOrderedSet] - -## Transactions - -::value[syncRead, asyncRead] -::value[syncWrite, asyncWrite] -::value[virtualSyncWriteMem, virtualSyncWriteWS] -::value[lift1Read, lift2Read, lift3Read] -::value[lift1Write, lift2Write, lift3Write] -::value[addCommentMetadata] -::value[makeSynchronous] -::value[enableDependencies, disableDependencies] - -## Undo - -::value[markUndoPoint, startUndoPoint] -::value[undo, redo, undoOperations] - -## Generation of resource names - -::value[findFreshName, findFreshEscapedName] - -## Helper functions for handling URIs - -::value[escapeURI, unescapeURI, splitURI] - -## Structured graph writing - -::value[newEntity] -::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent] - -## Clusters - -::value[newClusterSet, selectClusterSet, sortByCluster] - -## Debugging - -::value[queryDebugSupport, queryListSupport] - -## Miscellaneous functions - +# DB module documentation + +::data[Resource] + +## Reading + +### URIs + +::value[resource, possibleResource, relativeResource] + +### Graph hierarchy + +::class[Browsable] + +### Objects + +::value[#, singleObject, possibleObject] +::value[objectsWithType] + +### Statements + +::data[Statement] +::value[subjectOf, predicateOf, objectOf] +::value[statements, singleStatement] + +### Special objects + +::value[singleTypeOf, possibleTypeOf] +::value[inverseOf] + +### Literals + +::value[relatedValue, possibleRelatedValue] +::value[relatedValue2] +::value[untypedValueOf, untypedRelatedValue, untypedPossibleRelatedValue] + +### Predicates + +::value[isInstanceOf, isSubrelationOf, isInheritedFrom, isParent] +::value[existsStatement, existsStatement3] + +### Special resources + +::value[currentModel, currentProject, getRootLibrary, listOntologies] + +### Resource id + +::value[resourceId, resourceFromId] + +## Writing + +### Adding statements + +::value[newResource] +::value[claim] +::value[deny, denyByPredicate, denyAllStatements] +::value[claimAssertion] + +### Writing literals + +::value[claimRelatedValue, claimRelatedValueWithType] +::value[untypedClaimRelatedValue] +::value[denyValue] + +## Ordered sets + +::value[addToOrderedSet,addFirstToOrderedSet,addAfterToOrderedSet,addBeforeToOrderedSet] +::value[removeFromOrderedSet] +::value[setOrderedSet] +::value[elementsOfOrderedSet] +::value[parentOrderedSet] + +## Linked List + +::value[elementsOfList,createList,createListWithType] +::value[insertListBack,insertListFront,removeListElement] +::value[swapListElementWithPrevious,swapListElementWithNext] + +## Transactions + +::value[syncRead, asyncRead] +::value[syncWrite, asyncWrite] +::value[virtualSyncWriteMem, virtualSyncWriteWS] +::value[lift1Read, lift2Read, lift3Read] +::value[lift1Write, lift2Write, lift3Write] +::value[addCommentMetadata] +::value[makeSynchronous] +::value[enableDependencies, disableDependencies] + +## Undo + +::value[markUndoPoint, startUndoPoint] +::value[undo, redo, undoOperations] + +## Generation of resource names + +::value[findFreshName, findFreshEscapedName] + +## Helper functions for handling URIs + +::value[escapeURI, unescapeURI, splitURI] + +## Structured graph writing + +::value[newEntity] +::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent] + +## Clusters + +::value[newClusterSet, selectClusterSet, sortByCluster] + +## Debugging + +::value[queryDebugSupport, queryListSupport] + +## Miscellaneous functions + ::undocumented[] \ No newline at end of file