Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Commit 87eac36

Browse files
authored
Add DATE_ROUND() function to docs (#254)
* Fix anchor link behavior * improve button "show example result" * clean up whitespace related to examples
1 parent c00ec65 commit 87eac36

File tree

240 files changed

+2826
-562
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

240 files changed

+2826
-562
lines changed

3.3/administration-arangosh-output.md

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ArangoDB Shell Output
77

88
The ArangoDB shell will print the output of the last evaluated expression
99
by default:
10+
1011
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
1112
@startDocuBlockInline lastExpressionResult
1213
@EXAMPLE_ARANGOSH_OUTPUT{lastExpressionResult}
@@ -15,8 +16,10 @@ by default:
1516
@endDocuBlock lastExpressionResult
1617
{% endarangoshexample %}
1718
{% include arangoshexample.html id=examplevar script=script result=result %}
19+
1820
In order to prevent printing the result of the last evaluated expression,
1921
the expression result can be captured in a variable, e.g.
22+
2023
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
2124
@startDocuBlockInline lastExpressionResultCaptured
2225
@EXAMPLE_ARANGOSH_OUTPUT{lastExpressionResultCaptured}
@@ -25,8 +28,10 @@ the expression result can be captured in a variable, e.g.
2528
@endDocuBlock lastExpressionResultCaptured
2629
{% endarangoshexample %}
2730
{% include arangoshexample.html id=examplevar script=script result=result %}
31+
2832
There is also the `print` function to explicitly print out values in the
2933
ArangoDB shell:
34+
3035
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
3136
@startDocuBlockInline printFunction
3237
@EXAMPLE_ARANGOSH_OUTPUT{printFunction}
@@ -35,8 +40,10 @@ ArangoDB shell:
3540
@endDocuBlock printFunction
3641
{% endarangoshexample %}
3742
{% include arangoshexample.html id=examplevar script=script result=result %}
43+
3844
By default, the ArangoDB shell uses a pretty printer when JSON documents are
3945
printed. This ensures documents are printed in a human-readable way:
46+
4047
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
4148
@startDocuBlockInline usingToArray
4249
@EXAMPLE_ARANGOSH_OUTPUT{usingToArray}
@@ -48,6 +55,7 @@ printed. This ensures documents are printed in a human-readable way:
4855
@endDocuBlock usingToArray
4956
{% endarangoshexample %}
5057
{% include arangoshexample.html id=examplevar script=script result=result %}
58+
5159
While the pretty-printer produces nice looking results, it will need a lot of
5260
screen space for each document. Sometimes a more dense output might be better.
5361
In this case, the pretty printer can be turned off using the command

3.3/administration-arangosh.md

+5
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ server after the password was entered.
4242

4343
To change the current database after the connection has been made, you
4444
can use the `db._useDatabase()` command in arangosh:
45+
4546
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
4647
@startDocuBlockInline shellUseDB
4748
@EXAMPLE_ARANGOSH_OUTPUT{shellUseDB}
@@ -53,6 +54,7 @@ can use the `db._useDatabase()` command in arangosh:
5354
@endDocuBlock shellUseDB
5455
{% endarangoshexample %}
5556
{% include arangoshexample.html id=examplevar script=script result=result %}
57+
5658
To get a list of available commands, arangosh provides a *help()* function.
5759
Calling it will display helpful information.
5860

@@ -66,6 +68,7 @@ be used for switching to a different database and managing collections inside th
6668
current database.
6769

6870
For a list of available methods for the *db* object, type
71+
6972
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
7073
@startDocuBlockInline shellHelp
7174
@EXAMPLE_ARANGOSH_OUTPUT{shellHelp}
@@ -74,8 +77,10 @@ For a list of available methods for the *db* object, type
7477
@endDocuBlock shellHelp
7578
{% endarangoshexample %}
7679
{% include arangoshexample.html id=examplevar script=script result=result %}
80+
7781
you can paste multiple lines into arangosh, given the first line ends with an
7882
opening brace:
83+
7984
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
8085
@startDocuBlockInline shellPaste
8186
@EXAMPLE_ARANGOSH_OUTPUT{shellPaste}

3.3/administration-configuration-general-arangod.md

+7
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ generator and the Mersenne Twister.
192192

193193

194194
### Enable/disable authentication
195+
195196
{% docublock server_authentication %}
196197

197198
### JWT Secret
@@ -224,6 +225,7 @@ The default value is *false*.
224225
domain sockets.
225226

226227
### Enable/disable authentication for system API requests only
228+
227229
{% docublock serverAuthenticateSystemOnly %}
228230

229231

@@ -329,9 +331,11 @@ to the web interface (/_admin/aardvark) and related areas.
329331
Sessions are only used when authentication is turned on.
330332

331333
### Foxx queues
334+
332335
{% docublock foxxQueues %}
333336

334337
### Foxx queues poll interval
338+
335339
{% docublock foxxQueuesPollInterval %}
336340

337341
### Directory
@@ -376,14 +380,17 @@ in a specific state on startup. the options for this value are:
376380

377381

378382
### Journal size
383+
379384
{% docublock databaseMaximalJournalSize %}
380385

381386

382387
### Wait for sync
388+
383389
{% docublock databaseWaitForSync %}
384390

385391

386392
### Force syncing of properties
393+
387394
{% docublock databaseForceSyncProperties %}
388395

389396

3.3/administration-managing-users-in-arangosh.md

+16
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ to grant the access rights for one or more databases using
7474
[grantDatabase](#grant-database).
7575

7676
*Examples*
77+
7778
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
7879
@startDocuBlockInline USER_02_saveUser
7980
@EXAMPLE_ARANGOSH_OUTPUT{USER_02_saveUser}
@@ -82,6 +83,7 @@ to grant the access rights for one or more databases using
8283
@endDocuBlock USER_02_saveUser
8384
{% endarangoshexample %}
8485
{% include arangoshexample.html id=examplevar script=script result=result %}
86+
8587
Grant Database
8688
--------------
8789

@@ -145,6 +147,7 @@ database.
145147
**Note**: this function will not work from within the web interface
146148

147149
*Examples*
150+
148151
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
149152
@startDocuBlockInline USER_03_replaceUser
150153
@EXAMPLE_ARANGOSH_OUTPUT{USER_03_replaceUser}
@@ -153,6 +156,7 @@ database.
153156
@endDocuBlock USER_03_replaceUser
154157
{% endarangoshexample %}
155158
{% include arangoshexample.html id=examplevar script=script result=result %}
159+
156160
Update
157161
------
158162

@@ -173,6 +177,7 @@ or given in a wrong format, or if the specified user cannot be found in the
173177
database.
174178

175179
*Examples*
180+
176181
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
177182
@startDocuBlockInline USER_04_updateUser
178183
@EXAMPLE_ARANGOSH_OUTPUT{USER_04_updateUser}
@@ -181,6 +186,7 @@ database.
181186
@endDocuBlock USER_04_updateUser
182187
{% endarangoshexample %}
183188
{% include arangoshexample.html id=examplevar script=script result=result %}
189+
184190
isValid
185191
-------
186192

@@ -194,6 +200,7 @@ Each call to this function is penalized by the server sleeping a random
194200
amount of time.
195201

196202
*Examples*
203+
197204
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
198205
@startDocuBlockInline USER_05_isValidUser
199206
@EXAMPLE_ARANGOSH_OUTPUT{USER_05_isValidUser}
@@ -202,6 +209,7 @@ amount of time.
202209
@endDocuBlock USER_05_isValidUser
203210
{% endarangoshexample %}
204211
{% include arangoshexample.html id=examplevar script=script result=result %}
212+
205213
Remove
206214
------
207215

@@ -215,6 +223,7 @@ the database.
215223
This method will fail if the user cannot be found in the database.
216224

217225
*Examples*
226+
218227
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
219228
@startDocuBlockInline USER_07_removeUser
220229
@EXAMPLE_ARANGOSH_OUTPUT{USER_07_removeUser}
@@ -223,6 +232,7 @@ This method will fail if the user cannot be found in the database.
223232
@endDocuBlock USER_07_removeUser
224233
{% endarangoshexample %}
225234
{% include arangoshexample.html id=examplevar script=script result=result %}
235+
226236
Document
227237
--------
228238

@@ -235,6 +245,7 @@ The user name must be specified in *user*.
235245
This method will fail if the user cannot be found in the database.
236246

237247
*Examples*
248+
238249
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
239250
@startDocuBlockInline USER_04_documentUser
240251
@EXAMPLE_ARANGOSH_OUTPUT{USER_04_documentUser}
@@ -243,6 +254,7 @@ This method will fail if the user cannot be found in the database.
243254
@endDocuBlock USER_04_documentUser
244255
{% endarangoshexample %}
245256
{% include arangoshexample.html id=examplevar script=script result=result %}
257+
246258
All
247259
---
248260

@@ -251,6 +263,7 @@ All
251263
Fetches all existing ArangoDB users from the database.
252264

253265
*Examples*
266+
254267
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
255268
@startDocuBlockInline USER_06_AllUsers
256269
@EXAMPLE_ARANGOSH_OUTPUT{USER_06_AllUsers}
@@ -259,6 +272,7 @@ Fetches all existing ArangoDB users from the database.
259272
@endDocuBlock USER_06_AllUsers
260273
{% endarangoshexample %}
261274
{% include arangoshexample.html id=examplevar script=script result=result %}
275+
262276
Reload
263277
------
264278

@@ -271,6 +285,7 @@ cached after that. When users get added or deleted, a cache flush is done
271285
automatically, and this can be performed by a call to this method.
272286

273287
*Examples*
288+
274289
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
275290
@startDocuBlockInline USER_03_reloadUser
276291
@EXAMPLE_ARANGOSH_OUTPUT{USER_03_reloadUser}
@@ -293,6 +308,7 @@ the collection name.
293308
This method will fail if the user cannot be found in the database.
294309

295310
*Examples*
311+
296312
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
297313
@startDocuBlockInline USER_05_permission
298314
@EXAMPLE_ARANGOSH_OUTPUT{USER_05_permission}

3.3/appendix-deprecated-actions-html-example.md

+8
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ ArangoDB is stored in a collection *_routing*. Each entry in this collections
3232
describes how to deal with a particular request path.
3333

3434
For the above example, add the following document to the _routing collection:
35+
3536
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
3637
@startDocuBlockInline HTML_01_routingCreateHtml
3738
@EXAMPLE_ARANGOSH_OUTPUT{HTML_01_routingCreateHtml}
@@ -48,8 +49,10 @@ For the above example, add the following document to the _routing collection:
4849
@endDocuBlock HTML_01_routingCreateHtml
4950
{% endarangoshexample %}
5051
{% include arangoshexample.html id=examplevar script=script result=result %}
52+
5153
In order to activate the new routing, you must either restart the server or call
5254
the internal reload function.
55+
5356
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
5457
@startDocuBlockInline HTML_02_routingReload
5558
@EXAMPLE_ARANGOSH_OUTPUT{HTML_02_routingReload}
@@ -58,9 +61,11 @@ the internal reload function.
5861
@endDocuBlock HTML_02_routingReload
5962
{% endarangoshexample %}
6063
{% include arangoshexample.html id=examplevar script=script result=result %}
64+
6165
Now use the browser and access http:// localhost:8529/hello/world
6266

6367
You should see the *Hello World* in our browser:
68+
6469
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
6570
@startDocuBlockInline HTML_03_routingCurlHtml
6671
@EXAMPLE_ARANGOSH_RUN{HTML_03_routingCurlHtml}
@@ -253,6 +258,7 @@ Remember that the more specific match wins.
253258
right.
254259

255260
Consider the following definitions
261+
256262
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
257263
@startDocuBlockInline HTML_04_routingCreateMultiPath
258264
@EXAMPLE_ARANGOSH_OUTPUT{HTML_04_routingCreateMultiPath}
@@ -273,7 +279,9 @@ Consider the following definitions
273279
@endDocuBlock HTML_04_routingCreateMultiPath
274280
{% endarangoshexample %}
275281
{% include arangoshexample.html id=examplevar script=script result=result %}
282+
276283
Then
284+
277285
{% arangoshexample examplevar="examplevar" script="script" result="result" %}
278286
@startDocuBlockInline HTML_05_routingGetMultiPath
279287
@EXAMPLE_ARANGOSH_RUN{HTML_05_routingGetMultiPath}

0 commit comments

Comments
 (0)