mirror of https://gitee.com/bigwinds/arangodb
Doc - added documentation for ArangoShell `print` function (#4397)
This commit is contained in:
parent
c06c552359
commit
6d8dfe57c0
|
@ -1,6 +1,33 @@
|
||||||
ArangoDB Shell Output
|
ArangoDB Shell Output
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
|
The ArangoDB shell will print the output of the last evaluated expression
|
||||||
|
by default:
|
||||||
|
|
||||||
|
@startDocuBlockInline lastExpressionResult
|
||||||
|
@EXAMPLE_ARANGOSH_OUTPUT{lastExpressionResult}
|
||||||
|
42 * 23
|
||||||
|
@END_EXAMPLE_ARANGOSH_OUTPUT
|
||||||
|
@endDocuBlock lastExpressionResult
|
||||||
|
|
||||||
|
In order to prevent printing the result of the last evaluated expression,
|
||||||
|
the expression result can be captured in a variable, e.g.
|
||||||
|
|
||||||
|
@startDocuBlockInline lastExpressionResultCaptured
|
||||||
|
@EXAMPLE_ARANGOSH_OUTPUT{lastExpressionResultCaptured}
|
||||||
|
var calculationResult = 42 * 23
|
||||||
|
@END_EXAMPLE_ARANGOSH_OUTPUT
|
||||||
|
@endDocuBlock lastExpressionResultCaptured
|
||||||
|
|
||||||
|
There is also the `print` function to explicitly print out values in the
|
||||||
|
ArangoDB shell:
|
||||||
|
|
||||||
|
@startDocuBlockInline printFunction
|
||||||
|
@EXAMPLE_ARANGOSH_OUTPUT{printFunction}
|
||||||
|
print({ a: "123", b: [1,2,3], c: "test" });
|
||||||
|
@END_EXAMPLE_ARANGOSH_OUTPUT
|
||||||
|
@endDocuBlock printFunction
|
||||||
|
|
||||||
By default, the ArangoDB shell uses a pretty printer when JSON documents are
|
By default, the ArangoDB shell uses a pretty printer when JSON documents are
|
||||||
printed. This ensures documents are printed in a human-readable way:
|
printed. This ensures documents are printed in a human-readable way:
|
||||||
|
|
||||||
|
@ -14,7 +41,7 @@ printed. This ensures documents are printed in a human-readable way:
|
||||||
@endDocuBlock usingToArray
|
@endDocuBlock usingToArray
|
||||||
|
|
||||||
While the pretty-printer produces nice looking results, it will need a lot of
|
While the pretty-printer produces nice looking results, it will need a lot of
|
||||||
screen space for each document. Sometimes, a more dense output might be better.
|
screen space for each document. Sometimes a more dense output might be better.
|
||||||
In this case, the pretty printer can be turned off using the command
|
In this case, the pretty printer can be turned off using the command
|
||||||
*stop_pretty_print()*.
|
*stop_pretty_print()*.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue