tsuyoshi2 / galax Goto Github PK

What is XQuery?

XQuery is a language to process XML, defined by the World-Wide Web
Consortium (W3C), under the XML activity. XQuery, which includes XPath
as a subset, allows users to access, transform, and generate XML. It
includes supports for SQL-like queries over XML data. It is a
functional language, with an extensive built-in function library, and
the ability for users to define their own functions and libraries.

What is Galax?

Galax is an implementation of XQuery designed with the following goals
in mind: completeness, conformance, performance, and
extensibility. Galax is open-source, and has been used on a large
variety of real-life XML applications. Galax relies on a formally
specified and open architecture which is particularly well suited for
users interested in teaching XQuery, or in experimenting with
extensions of the language or optimizations.

Here is a list of the main Galax features.

* Galax implements the Second Edition of the XQuery 1.0
  recommendation, dated December 14, 2010.
* Galax supports Minimal Conformance, as well as the following
  optional features: Static Typing, Full Axis, Module, and
  Serialization.
* Galax supports Unicode, with native support for the UTF-8 and
  ISO-8859-1 character encodings.
* Galax is portable and runs on most modern platforms.
* Galax includes a command-line interface, APIs for OCaml, C, and
  Java, and a simple Web-based interface.
* Galax includes partial support for the Schema Import and Schema
  Validation optional features. Unimplemented features of XML Schema
  include simple types facets and derivation by extension and
  restriction on complex types.
* Galax supports the XQuery 1.0 Update Facility
* Galax supports the XQueryP scripting extension for XQuery

How to use Galax

The Galax processor offers the following user interfaces:

* Command-line.
* Application-programming interfaces (APIs) for OCaml, C, or Java.
* Web interface.

Using Galax from the command line

A number of stand-alone command-line tools are provided with the
Galax distribution. The following examples show how to use the main
command-line tools.

* The main XQuery interpreter (glx xquery) is
  the simplest way to use Galax. For instance, the following commands:

    % echo "<two>{ 1+1 }</two>" > test.xq
    % glx xquery test.xq
    <two>2</two>

evaluates the query <two>{ 1+1 }</two> and prints the XML
result <two>2</two>.

* The Galax XML parser and XML Schema validator can be
  called as a standalone tool. For instance, the following command
  validates the document in hispo.xml against the schema in
  hispo.xsd:

    % glx xml -validate -xmlschema $GALAXHOME/examples/docs/hispo.xsd \
                               $GALAXHOME/examples/docs/hispo.xml 

* glx xmlschema is a stand-alone tool that maps XML Schema documents
  into the XQuery type system. This tool is useful for checking whether
  Galax recognizes all the constructs in your XML Schema. It also
  eliminates a lot of the "noise" in XML Schema's XML syntax. 

  For instance, this command will print out the XQuery type
  representation of the schema in hispo.xsd: 

    % glx xmlschema $GALAXHOME/examples/docs/hispo.xsd 

Language API's

Galax supports APIs for OCaml, C, and Java.  See the documentation
for how to use the APIs.
  
If you have installed the binary distribution of Galax, all three APIs
are available.

If you have intalled the source distribution of Galax, you will need
to select the language(s) for which you need API support at
configuration time. See INSTALL for details on
compiling Galax from source.

Examples of how to use Galax's APIs can be found in the following
directories:

  examples/caml_api/
  examples/c_api/
  examples/java_api/