zorba man page

Zorba — Zorba

Description

Zorba NoSQL Query Processor, Version: 3.0.0 Available options:

--as-files, -f Treat all -q arguments as file paths instead of URIs or inline queries. This option is deprecated and will be defaulted to true in the future, so any entry in the command line is going to be treated as files.

--base-uri <uri> Set the base URI property of the static context.

--boundary-space {strip|preserve} Set the boundary-space policy in the static context.

--byte-order-mark Set the byte-order-mark for the serializer.

--classpath <path> Set the JVM classpath to be used by modules using Java implementations.

--compile-only Only compile (don't execute).

--compile-plan Do not execute the query; just compile it and save the execution plan in the file specified with the -o option.

--construction-mode {strip|preserve} Set the construction mode in the static context.

--context-item <item> Set the context item to the XML document in a given file.

--debug, -d Launch the Zorba debugger server and connect to a DBGP-enabled debugger client.

--debug-file <file> Sets the file to write developer debugging information to.

--debug-stream {1|cout|stdout|2|cerr|stderr} Sets the stream to write developer debugging information to.

--debug-host, -h <host> The host where the DBGP-enabled debugger client listens for connections; default: 127.0.0.1.

--debug-port, -p <port> The port on which the DBGP-enabled debugger client listens for connections; defaults: 28028.

--default-collation <collation> Add the given collation and set the value of the default collation in the static context to the given collation.

--disable-http-resolution Do not use HTTP to resolve URIs.

--dump-lib Dump function library.

--execute-plan Do not compile the query; instead load the execution plan from the file specified by the -f -q options (or by any file specified without any other argument), and execute the loaded plan.

--external-variable, -e <name>{=<file>|:=<value>} Set the value for an externsl variable.

--force-gflwor Force the compiler to generate GFLWOR iterators.

--help Print this help message.

--indent, -i Indent output.

--infer-joins Infer joins.

--inline-udf Inline user-defined functions.

--iterator-tree {dot|json|xml}> Print the iterator tree in the given format.

--jsoniq, -j Force queries to be considered JSONiq.

--lib-module, -l Query compiler option to treat the query as a library module. If this is set --compile-only option is also set to true.

--lib-path <path> Library path (list of directories) where Zorba will look for dynamic libraries (e.g., module external function implementations.

--loop-hosting Hoist expressions out of loops.

--max-udf-call-depth <depth> Maximum stack depth of user-defined function calls.

--module-path <path> Path (list of directories) to add to both the URI and Library paths.

--multiple, -m Execute the given queries multiple times.

--no-copy-optim Apply the no-copy optimization.

--no-logo Print no logo when starting.

--no-serializer Do not serialize (discard) result.

--no-tree-ids Suppress IDs and locations from compiler tree dumps.

--omit-xml-declaration, -r Omit the XML declaration from the result.

--optimization-level, -O {0|1|2}> Optimization level for the query compiler, default: 1.

--option <option>=<value> Set an XQuery option in the static context. The QName of the option is passed as a string in the notation by James Clark (i.e. {namespace}localname). For example, --option {http://zorba.io/}option=value

--ordering-mode {ordered|unordered} Set the ordering mode in the static context.

--output-file, -o <file> Write the result to the given file.

--parse-only Stop after parsing the query.

--print-ast Print the abstract syntax tree.

--print-errors-as-xml, -x Print the errors as XML.

--print-intermediate-opt Print intermediate optimizations.

--print-item-flow Print items produced by all iterators.

--print-iterator-tree Print the iterator tree.

--print-locations Print parser locations for compiler expressions.

--print-optimized Print the optimized expression tree.

--print-query Print the queries.

--print-static-types Print static type inference.

--print-translated Print the normalized expression tree.

--profile Enable profiling.

--query, -q Query test or file URI (file://...)

--serialization-parameter, -z <name>=<value> Set serialization parameter (see http://www.w3.org/TR/xslt-xquery-serial…, e.g.: -z method=xhtml -z doctype-system=DTD/xhtml1-strict.dtd -z indent=yes).

--serialize-html Serialize the result as HTML.

--serialize-plan, -s Serialize and then load the query execution plan.

--serialize-only-query Serialize only query.

--serialize-plan, s Serialize and then load the query execution plan.

--serialize-text Serialize the result as text.

--stable-iterator-ids Print the iterator plan with stable IDs.

--stop-words <uri>:=<value> Mapping specifying a stop-words URI to another.

--thesaurus <uri>:=<value> Mapping specifying a thesaurus URI to another.

--timing, -t Print timing information. In case of multiple queries, the timing information is provided per query. Both wallclock time and user time (which excludes I/O, network delays and other kernel waits) are shown.

--timeout <seconds> Specify a timeout in seconds. After the specified time, the execution of the query will be aborted.

--trace-parsing Trace parsing.

--trace-scanning Trace scanning.

--trailing-nl, -n Print a trailing newline after the result of the query.

--uri-path <path> URI path (list of directories) added to the built-in URI resolver, i.e. where to find modules/schemas to import.

--version, -v Print the version number and exit.

Info

July 2016 FLWOR Foundation User Commands