blob: 44621e1e5d7ca265ac61586fa9578bcc6921358e [file] [log] [blame]
~~ Licensed to the Apache Software Foundation (ASF) under one or more
~~ contributor license agreements. See the NOTICE file distributed with
~~ this work for additional information regarding copyright ownership.
~~ The ASF licenses this file to You under the Apache License, Version 2.0
~~ (the "License"); you may not use this file except in compliance with
~~ the License. You may obtain a copy of the License at
~~
~~ http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing, software
~~ distributed under the License is distributed on an "AS IS" BASIS,
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~~ See the License for the specific language governing permissions and
~~ limitations under the License.
Executing a Query
* Command
----------------------------------------
sh ./apache-vxquery-X.Y-incubating/vxquery-cli/target/appassembler/bin/vxq
----------------------------------------
* Command Line Options
----------------------------------------
-O N : Optimization Level. Default: Full Optimization
-available-processors N : Number of available processors. (default java's available processors)
-client-net-ip-address VAL : IP Address of the ClusterController
-client-net-port N : Port of the ClusterController (default 1098)
-compileonly : Compile the query and stop
-frame-size N : Frame size in bytes. (default 65536)
-local-node-controllers N : Number of local node controllers (default 1)
-repeatexec N : Number of times to repeat execution
-showast : Show abstract syntax tree
-showoet : Show optimized expression tree
-showquery : Show query string
-showrp : Show Runtime plan
-showtet : Show translated expression tree
-timing : Produce timing information
----------------------------------------
* Java Options
----------------------------------------
JAVA_OPTS="-Xmx1024m"
----------------------------------------
* Example
The following example query is from {{{http://www.w3schools.com/xquery/default.asp}W3Schools XQuery Tutorial}}.
If you are new to XQuery, the W3Schools tutorial is a great place to start.
[[i]] Query file (test.xq)
----------------------------------------
for $x in doc("books.xml")/bookstore/book
where $x/price>30
order by $x/title
return $x/title
----------------------------------------
[[i]] Command line
----------------------------------------
JAVA_OPTS="-Xmx1024m" sh ./apache-vxquery-X.Y-incubating/vxquery-cli/target/appassembler/bin/vxq test.xq
----------------------------------------