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

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