Store Module - Revision history

CG: Text replacement - "" to ""

2023-12-01T16:37:10Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:29:38Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG at 12:53, 31 October 2023

2023-10-31T12:53:34Z

CG at 10:35, 28 September 2023

2023-09-28T10:35:14Z

Andy Bunce: signature formating

2023-07-03T11:58:56Z

signature formating

Andy Bunce: store:get-or-put signature

2023-07-03T11:54:06Z

store:get-or-put signature

Andy Bunce: sigs remove
add missing optionals

2023-07-03T11:47:21Z

sigs remove <br/> add missing optionals

Andy Bunce: store:get sig remove br

2023-07-03T11:27:50Z

store:get sig remove br

CG at 14:09, 9 March 2023

2023-03-09T14:09:56Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:07:42Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

@@ Line 167: / Line 167: @@
 (: serialize configuration to disk :)
 store:write()
-</syntaxhighlight>
+</pre>
 The configuration can be requested by further operations, e.g. a client request:
@@ Line 173: / Line 173: @@
 <pre lang='xquery'>
 store:get('version')
-</syntaxhighlight>
+</pre>
 The store will still be available if BaseX is restarted until it is cleared.
@@ Line 187: / Line 187: @@
+)
 return store:put('religions', $map)
-</syntaxhighlight>
+</pre>
 A subsequent query can be used to access its contents:
@@ Line 193: / Line 193: @@
 <pre lang='xquery'>
 store:get('religions')?Buddhism
-</syntaxhighlight>
+</pre>
 Note that the store will eventually be written to disk unless it is invalidated before closing the GUI.

@@ Line 157: / Line 157: @@
 '''Use Case 1: Create/update a system configuration in a running BaseX server instance:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 (: store an integer :)
 store:put('version', 1),
@@ Line 171: / Line 171: @@
 The configuration can be requested by further operations, e.g. a client request:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 store:get('version')
 </syntaxhighlight>
@@ Line 179: / Line 179: @@
 '''Use Case 2: Create index for fast lookup operations in the GUI:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $map := map:merge(
    for $country in db:get('factbook')//country
@@ Line 191: / Line 191: @@
 A subsequent query can be used to access its contents:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 store:get('religions')?Buddhism
 </syntaxhighlight>

@@ Line 5: / Line 5: @@
 In addition, custom stores can be read and written. Custom stores have filenames with the pattern {{Code|store-NAME.basex}}. The implicit write of the standard store at shutdown time will be disabled if a custom store is used.
-Functions of this module are non-deterministic and side-effecting: Updates will immediately be visible, and a repeated call of the same function may yield different results if the contents of the store have changed.
+Functions of this module are nondeterministic and side-effecting: Updates will immediately be visible, and a repeated call of the same function may yield different results if the contents of the store have changed.
 =Conventions=

@@ Line 100: / Line 100: @@
 | width='120' | '''Signature'''
 |<pre>store:read(
-       $name  as xs:string?  := ()
+  $name  as xs:string?  := ()
 ) as empty-sequence()</pre>
 |- valign="top"

@@ Line 100: / Line 100: @@
 | width='120' | '''Signature'''
 |<pre>store:read(
-        $name  as xs:string? :=()
+        $name  as xs:string?  := ()
 ) as empty-sequence()</pre>
 |- valign="top"
@@ Line 116: / Line 116: @@
 | width='120' | '''Signature'''
 |<pre>store:write(
-    $name  as xs:string? :=()
+    $name  as xs:string?  := ()
 ) as empty-sequence()</pre>
 |- valign="top"

@@ Line 50: / Line 50: @@
 |<pre>store:get-or-put(
    $key  as xs:string,
-   $put  as function()
+   $put  as function(*)
 ) as item()*</pre>
 |- valign="top"

@@ Line 20: / Line 20: @@
 |<pre>store:get(
    $key  as xs:string
-) as item()*<br/ ></pre>
+) as item()*</pre>
 |- valign="top"
 |'''Summary'''

@@ Line 17: / Line 17: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:get(
    $key  as xs:string
@@ Line 30: / Line 30: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:put(
    $key    as xs:string
@@ Line 47: / Line 47: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:get-or-put(
    $key  as xs:string
@@ Line 61: / Line 61: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:remove(
    $key  as xs:string
@@ Line 74: / Line 74: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:keys() as xs:string*</pre>
 |- valign="top"
@@ Line 85: / Line 85: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:clear() as empty-sequence()<br/ ></pre>
 |- valign="top"
@@ Line 98: / Line 98: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:read() as empty-sequence()<br/ >{{Func</pre>
 |- valign="top"
@@ Line 112: / Line 112: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:write() as empty-sequence()<br/ >{{Func</pre>
 |- valign="top"
@@ Line 126: / Line 126: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:list() as xs:string*</pre>
 |- valign="top"
@@ Line 137: / Line 137: @@
 {| width='100%'
 |- valign="top"
-| width='120' | '''Signatures'''
+| width='120' | '''Signature'''
 |<pre>store:delete(
    $name  as xs:string

Store Module - Revision history

CG: Text replacement - "" to ""

CG: Text replacement - "" to ""

CG at 12:53, 31 October 2023

CG at 10:35, 28 September 2023

Andy Bunce: signature formating

Andy Bunce: store:get-or-put signature

Andy Bunce: sigs remove add missing optionals

Andy Bunce: store:get sig remove br

CG at 14:09, 9 March 2023

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

CG: Text replacement - "" to "
"

Andy Bunce: sigs remove
add missing optionals