You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vxquery.apache.org by pr...@apache.org on 2012/08/22 00:02:28 UTC
svn commit: r1375819 - in /incubator/vxquery/trunk/vxquery: docs/README
src/site/apt/development_tips.apt src/site/apt/index.apt src/site/site.xml
Author: prestonc
Date: Tue Aug 21 22:02:28 2012
New Revision: 1375819
URL: http://svn.apache.org/viewvc?rev=1375819&view=rev
Log:
VXQUERY-51 Finished the basic developer documentation.
Modified:
incubator/vxquery/trunk/vxquery/docs/README
incubator/vxquery/trunk/vxquery/src/site/apt/development_tips.apt
incubator/vxquery/trunk/vxquery/src/site/apt/index.apt
incubator/vxquery/trunk/vxquery/src/site/site.xml
Modified: incubator/vxquery/trunk/vxquery/docs/README
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/docs/README?rev=1375819&r1=1375818&r2=1375819&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/docs/README (original)
+++ incubator/vxquery/trunk/vxquery/docs/README Tue Aug 21 22:02:28 2012
@@ -8,9 +8,33 @@ Requirements:
2. Apache Maven >= 2.0
-Building:
+Setup:
-1. Type "mvn test" in the vxquery base folder.
+VXQuery is currently only located in SVN. The following instructions are to check out the
+active version under active development. In addition to VXQuery, the current release of
+Hyracks needs to be set up for VXQuery to run properly. The following steps are to be followed
+from the command line.
+
+1. Create a folder for all the VXQuery files.
+
+$ mkdir /path/to/VXQuery
+$ cd /path/to/VXQuery
+
+2. Download and install the Hyracks Asterix Stabilization branch.
+
+$ svn checkout https://hyracks.googlecode.com/svn/branches/hyracks_asterix_stabilization hyracks_asterix_stabilization
+(Accept the certificate information for *.googlecode.com.)
+$ cd hyracks_asterix_stabilization
+$ mvn install -DskipTests
+$ cd ..
+
+3. Download and install the Apache VXQuery Incubating.
+
+$ svn checkout https://svn.apache.org/repos/asf/incubator/vxquery/trunk/ apache_vxquery_incubating
+(Accept the certificate information for *.apache.org.)
+$ cd apache_vxquery_incubating/vxquery
+$ mvn package -DskipTests
+$ cd ../..
Running:
@@ -21,46 +45,19 @@ TODO: Add Windows batch files
1. Command line client (vxq)
-Type target/scripts/vxq without any arguments for help on executing the command line client.
+Type "sh apache_vxquery_incubating/vxquery/vxquery-cli/target/appassembler/bin/vxq" without any
+arguments for help on executing the command line client.
2. XQTS test driver (xtest)
The xtest test driver can be used to execute XQuery tests from the XQTS suite.
-Type target/scripts/xtest without any arguments for help on executing xtest.
-
-Note: XQTS test suite needs to be obtained through CVS
-Do NOT use the XQTS zip files available from the XQTS web site. They are too old.
-
-There are 2 way to get a current version of the files:
-
-a) via regular CVS
-
-Assume you are in $XQTS_HOME (location where you want to checkout XQTS).
-
-$ export CVSROOT=":pserver:anonymous@dev.w3.org:/sources/public"
-$ cvs login
-(Logging in to anonymous@dev.w3.org)
-CVS password: anonymous
-$ cvs get 2006/xquery-test-suite/TestSuiteStagingArea
- ...
-
-Once the testsuite is checked out locally, xtest should be passed the -xqtsbase argument with the absolute path to the folder that contains XQTSCatalog.xml
-
-$ cd $VXQUERY_HOME
-$ target/scripts/xtest -xqtsbase $XQTS_HOME/2006/xquery-test-suite/TestSuiteStagingArea ...
-
-b) via CVS web access
-
-Version history:
-http://dev.w3.org/cvsweb/2006/xquery-test-suite/PublicPagesStagingArea/XQTS_current.zip
-Latest Version:
-http://dev.w3.org/cvsweb/~checkout~/2006/xquery-test-suite/PublicPagesStagingArea/XQTS_current.zip
-
-Eclipse "integration":
+Type "sh apache_vxquery_incubating/vxquery/vxquery-xtest/target/appassembler/bin/xtest" without
+any arguments for help on executing xtest.
-The eclipse files in the project rely on the availability of the classpath variable M2_REPO that needs to point to the local maven repository.
-M2_REPO can be added to the eclipse workspace using the maven-eclispe-plugin:
+Typically the test suite will need extra memory to run and output can be stored in html for easy viewing.
+Sample Test Command: JAVA_OPTS="-Xmx1024m" sh apache_vxquery_incubating/vxquery/vxquery-xtest/target/appassembler/bin/xtest -xqtsbase apache_vxquery_incubating/testsuites/XQTS/ -htmlreport /tmp/full_report.html
+The result can be viewed at file:///tmp/full_report.html
-$ mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
+Note: XQTS test suite is set up as part of the Apache VXQuery Incubating setup process.
\ No newline at end of file
Modified: incubator/vxquery/trunk/vxquery/src/site/apt/development_tips.apt
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/apt/development_tips.apt?rev=1375819&r1=1375818&r2=1375819&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/apt/development_tips.apt (original)
+++ incubator/vxquery/trunk/vxquery/src/site/apt/development_tips.apt Tue Aug 21 22:02:28 2012
@@ -26,7 +26,16 @@ Developer Tips
Hyracks supports several basic data types stored in byte arrays. The byte arrays can be
accessed through objects referred to as pointables. The pointable helps with tracking the
bytes stored in a larger storage array. Some pointables support converting the byte array
- into a desired format such as for numeric type.
+ into a desired format such as for numeric type. The most basic pointable has three values
+ stored in the object.
+
+ * byte array
+
+ * starting offset
+
+ * length
+
+ []
In VXQuery the TaggedValuePointable is used to read a result from this byte array. The
first byte defines the data type and alerts us to what pointable to use for reading the
@@ -44,29 +53,29 @@ Developer Tips
*-------------------------+----------------------+---------------:
| xs:byte | BytePointable | 1 |
*-------------------------+----------------------+---------------:
-| xs:date | XSDatePointable | 6 |
+| xs:date | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDatePointable.java}XSDatePointable}} | 6 |
*-------------------------+----------------------+---------------:
-| xs:dateTime | XSDateTimePointable | 12 |
+| xs:dateTime | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDateTimePointable.java}XSDateTimePointable}} | 12 |
*-------------------------+----------------------+---------------:
-| xs:dayTimeDuration | IntegerPointable | 4 |
+| xs:dayTimeDuration | LongPointable | 8 |
*-------------------------+----------------------+---------------:
-| xs:decimal | XSDecimalPointable | 9 |
+| xs:decimal | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDecimalPointable.java}XSDecimalPointable}} | 9 |
*-------------------------+----------------------+---------------:
| xs:double | DoublePointable | 8 |
*-------------------------+----------------------+---------------:
-| xs:duration | XSDurationPointable | 8 |
+| xs:duration | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDurationPointable.java}XSDurationPointable}} | 12 |
*-------------------------+----------------------+---------------:
| xs:float | FloatPointable | 4 |
*-------------------------+----------------------+---------------:
-| xs:gDay | XSDatePointable | 6 |
+| xs:gDay | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDatePointable.java}XSDatePointable}} | 6 |
*-------------------------+----------------------+---------------:
-| xs:gMonth | XSDatePointable | 6 |
+| xs:gMonth | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDatePointable.java}XSDatePointable}} | 6 |
*-------------------------+----------------------+---------------:
-| xs:gMonthDay | XSDatePointable | 6 |
+| xs:gMonthDay | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDatePointable.java}XSDatePointable}} | 6 |
*-------------------------+----------------------+---------------:
-| xs:gYear | XSDatePointable | 6 |
+| xs:gYear | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDatePointable.java}XSDatePointable}} | 6 |
*-------------------------+----------------------+---------------:
-| xs:gYearMonth | XSDatePointable | 6 |
+| xs:gYearMonth | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSDatePointable.java}XSDatePointable}} | 6 |
*-------------------------+----------------------+---------------:
| xs:int | IntegerPointable | 4 |
*-------------------------+----------------------+---------------:
@@ -82,7 +91,7 @@ Developer Tips
*-------------------------+----------------------+---------------:
| xs:short | ShortPointable | 2 |
*-------------------------+----------------------+---------------:
-| xs:time | XSTimePointable | 8 |
+| xs:time | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSTimePointable.java}XSTimePointable}} | 8 |
*-------------------------+----------------------+---------------:
| xs:unsignedByte | ShortPointable | 2 |
*-------------------------+----------------------+---------------:
@@ -104,7 +113,7 @@ Developer Tips
storing three strings right after each other.
Please note that all strings are stored in UTF8. The UTF8 characters range in size from one
- to three bytes. UTF9StringWriter supports writing a character sequence into the
+ to three bytes. UTF8StringWriter supports writing a character sequence into the
UTF8StringPointable format.
*-------------------------+----------------------+---------------+
@@ -112,13 +121,13 @@ Developer Tips
*-------------------------+----------------------+---------------:
| xs:anyURI | UTF8StringPointable | 2 + length |
*-------------------------+----------------------+---------------:
-| xs:base64Binary | XSBinaryPointable | 2 + length |
+| xs:base64Binary | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSBinaryPointable.java}XSBinaryPointable}} | 2 + length |
*-------------------------+----------------------+---------------:
-| xs:hexBinary | XSBinaryPointable | 2 + length |
+| xs:hexBinary | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSBinaryPointable.java}XSBinaryPointable}} | 2 + length |
*-------------------------+----------------------+---------------:
| xs:NOTATION | UTF8StringPointable | 2 + length |
*-------------------------+----------------------+---------------:
-| xs:QName | XSQNamePointable | 6 + length |
+| xs:QName | {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/datamodel/accessors/atomic/XSQNamePointable.java}XSQNamePointable}} | 6 + length |
*-------------------------+----------------------+---------------:
| xs:string | UTF8StringPointable | 2 + length |
*-------------------------+----------------------+---------------:
@@ -131,17 +140,19 @@ Developer Tips
returns the next character or an end of string value. Stacking iterators can be used to alter
the string into a desired form.
- * LowerCaseStringCharacterIterator
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/ICharacterIterator.java}ICharacterIterator}}
- * SubstringAfterStringCharacterIterator
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/LowerCaseCharacterIterator.java}LowerCaseStringCharacterIterator}}
- * SubstringBeforeStringCharacterIterator
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/SubstringAfterCharacterIterator.java}SubstringAfterStringCharacterIterator}}
- * SubstringStringCharacterIterator
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/SubstringBeforeCharacterIterator.java}SubstringBeforeStringCharacterIterator}}
- * UpperCaseStringCharacterIterator
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/SubstringCharacterIterator.java}SubstringStringCharacterIterator}}
- * UTF8StringCharacterIterator
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/UTF8StringCharacterIterator.java}UTF8StringCharacterIterator}}
+
+ * {{{https://svn.apache.org/repos/asf/incubator/vxquery/trunk/vxquery/vxquery-core/src/main/java/org/apache/vxquery/runtime/functions/strings/UpperCaseCharacterIterator.java}UpperCaseStringCharacterIterator}}
* Array Backed Value Store
Modified: incubator/vxquery/trunk/vxquery/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/apt/index.apt?rev=1375819&r1=1375818&r2=1375819&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/apt/index.apt (original)
+++ incubator/vxquery/trunk/vxquery/src/site/apt/index.apt Tue Aug 21 22:02:28 2012
@@ -17,10 +17,10 @@ Apache VXQuery
Apache VXQuery will be a standards compliant XML Query processor implemented in Java.
The focus is on the evaluation of queries on large amounts of XML data.
- Specifially the goal is to evaluate queries on large collections of relatively small XML documents.
+ Specifically the goal is to evaluate queries on large collections of relatively small XML documents.
To achieve this queries will be evaluated on a cluster of shared nothing machines.
- There are lots of large colletions of relatively small documents like e.g. the {{{http://www.sec.gov/info/edgar/ednews/dissemin.htm}EDGAR dataset}} or the {{{http://wiki.openstreetmap.org/wiki/Download}OpenStreetMap dataset}}.
+ There are lots of large collections of relatively small documents like e.g. the {{{http://www.sec.gov/info/edgar/ednews/dissemin.htm}EDGAR dataset}} or the {{{http://wiki.openstreetmap.org/wiki/Download}OpenStreetMap dataset}}.
However there are no XQuery processors available today that are capable of processing these datasets in parallel and making the contained information accessible.
* Incubation Disclaimer
Modified: incubator/vxquery/trunk/vxquery/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/vxquery/trunk/vxquery/src/site/site.xml?rev=1375819&r1=1375818&r2=1375819&view=diff
==============================================================================
--- incubator/vxquery/trunk/vxquery/src/site/site.xml (original)
+++ incubator/vxquery/trunk/vxquery/src/site/site.xml Tue Aug 21 22:02:28 2012
@@ -28,8 +28,12 @@ limitations under the License.
</bannerRight>
<body>
- <menu ref="reports"/>
- <menu ref="modules"/>
+ <menu ref="reports"/>
+ <menu ref="modules"/>
+
+ <menu name="For Developers">
+ <item name="Development Tips" href="development_tips.html"/>
+ </menu>
</body>
</project>