bundles/org.simantics.scl.db/scl/Simantics/DB.md

   1 # DB module documentation
   2
   3 ::data[Resource]
   4
   5 ## Reading
   6
   7 ### URIs
   8
   9 ::value[resource, possibleResource, relativeResource]
  10
  11 ### Graph hierarchy
  12
  13 ::class[Browsable]
  14
  15 ### Objects
  16
  17 ::value[#, singleObject, possibleObject]
  18 ::value[objectsWithType]
  19
  20 ### Statements
  21
  22 ::data[Statement]
  23 ::value[subjectOf, predicateOf, objectOf]
  24 ::value[statements, singleStatement]
  25
  26 ### Special objects
  27
  28 ::value[singleTypeOf, possibleTypeOf]
  29 ::value[inverseOf]
  30
  31 ### Literals
  32
  33 ::value[relatedValue, possibleRelatedValue]
  34 ::value[relatedValue2]
  35 ::value[untypedValueOf, untypedRelatedValue, untypedPossibleRelatedValue]
  36
  37 ### Predicates
  38
  39 ::value[isInstanceOf, isSubrelationOf, isInheritedFrom, isParent]
  40 ::value[existsStatement, existsStatement3]
  41
  42 ### Special resources
  43
  44 ::value[currentModel, currentProject, getRootLibrary, listOntologies]
  45
  46 ### Resource id
  47
  48 ::value[resourceId, resourceFromId]
  49
  50 ## Writing
  51
  52 ### Adding statements
  53
  54 ::value[newResource]
  55 ::value[claim]
  56 ::value[deny, denyByPredicate, denyAllStatements]
  57 ::value[claimAssertion]
  58
  59 ### Writing literals
  60
  61 ::value[claimRelatedValue, claimRelatedValueWithType]
  62 ::value[untypedClaimRelatedValue]
  63 ::value[denyValue]
  64
  65 ## Ordered sets
  66
  67 ::value[addToOrderedSet]
  68 ::value[setOrderedSet]
  69 ::value[elementsOfOrderedSet]
  70 ::value[parentOrderedSet]
  71
  72 ## Transactions
  73
  74 ::value[syncRead, asyncRead]
  75 ::value[syncWrite, asyncWrite]
  76 ::value[virtualSyncWriteMem, virtualSyncWriteWS]
  77 ::value[lift1Read, lift2Read, lift3Read]
  78 ::value[lift1Write, lift2Write, lift3Write]
  79 ::value[addCommentMetadata]
  80 ::value[makeSynchronous]
  81 ::value[enableDependencies, disableDependencies]
  82
  83 ## Undo
  84
  85 ::value[markUndoPoint, startUndoPoint]
  86 ::value[undo, redo, undoOperations]
  87
  88 ## Generation of resource names
  89
  90 ::value[findFreshName, findFreshEscapedName]
  91
  92 ## Helper functions for handling URIs
  93
  94 ::value[escapeURI, unescapeURI, splitURI]
  95
  96 ## Structured graph writing
  97
  98 ::value[newEntity]
  99 ::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent]
 100
 101 ## Clusters
 102
 103 ::value[newClusterSet, selectClusterSet, sortByCluster]
 104
 105 ## Debugging
 106
 107 ::value[queryDebugSupport, queryListSupport]
 108
 109 ## Miscellaneous functions
 110
 111 ::undocumented[]