Rename linked list functions that are overlapping or are too generic
[simantics/platform.git] / 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,addFirstToOrderedSet,addAfterToOrderedSet,addBeforeToOrderedSet]
68 ::value[removeFromOrderedSet]
69 ::value[setOrderedSet]
70 ::value[elementsOfOrderedSet]
71 ::value[parentOrderedSet]
72
73 ## Linked List
74
75 ::value[elementsOfList,createList,createListWithType]
76 ::value[insertListBack,insertListFront,removeListElement]
77 ::value[swapListElementWithPrevious,swapListElementWithNext]
78
79 ## Transactions
80
81 ::value[syncRead, asyncRead]
82 ::value[syncWrite, asyncWrite]
83 ::value[virtualSyncWriteMem, virtualSyncWriteWS] 
84 ::value[lift1Read, lift2Read, lift3Read]
85 ::value[lift1Write, lift2Write, lift3Write]
86 ::value[addCommentMetadata]
87 ::value[makeSynchronous]
88 ::value[enableDependencies, disableDependencies]
89
90 ## Undo
91
92 ::value[markUndoPoint, startUndoPoint]
93 ::value[undo, redo, undoOperations]
94
95 ## Generation of resource names
96
97 ::value[findFreshName, findFreshEscapedName]
98
99 ## Helper functions for handling URIs
100
101 ::value[escapeURI, unescapeURI, splitURI]
102
103 ## Structured graph writing
104
105 ::value[newEntity]
106 ::value[hasStatement, hasName, hasType, hasLabel, hasProperty, hasTypedProperty, hasPossibleProperty, hasParent]
107
108 ## Clusters
109
110 ::value[newClusterSet, selectClusterSet, sortByCluster]
111
112 ## Debugging
113
114 ::value[queryDebugSupport, queryListSupport]
115
116 ## Miscellaneous functions
117
118 ::undocumented[]