Qizx Manual
		Next

Qizx Manual

Xavier Franc

XMLmind

Web: http://www.xmlmind.com/qizx/
Email: <qizx-support@xmlmind.com>

Version 2.0

December 22, 2007

Table of Contents

1. Install on Linux
2. Manual install on Windows

3. Content of the distribution

II. User's Guide

4. Getting started

1. Introduction

1.1. About the data samples used in this tutorial

2. Creating an XML Library

2.1. Creating a Library using Qizx Studio
2.2. Creating a Library using the qizx command-line tool

3. Populating a Library with Collections and Documents

3.1. Importing Documents using Qizx Studio
3.2. Importing Documents using the qizx tool

4. Exporting Documents from an XML Library

4.1. Using Qizx Studio
4.2. Using the qizx command-line tool

5. Querying a Library

5.1. Writing and running queries with Qizx Studio
5.2. Running queries with the qizx command line tool

6. Copying, Renaming, Deleting Documents and Collections

6.1. Using Qizx Studio
6.2. Using the qizx command-line tool

7. Using Metadata Properties

7.1. Properties in Qizx Studio
7.2. Properties in the qizx command-line tool
7.3. Extension functions for Property handling
7.4. Using property queries to restrict the search domain of a standard query
7.5. Custom indexes

5. Configuring the indexing process

1. Introduction

2. Indexing in Qizx

2.1. Indexes

2.2. Indexing Specifications

2.2.1. General structure of an Indexing Specification
2.2.2. Global properties
2.2.3. Conversion rules
2.2.4. Rules for the conversion of simple element contents
2.2.5. Rules for the conversion of attribute values

2.3. Default Indexing Specification

3. Configuring Indexing

3.1. Writing a new Indexing Specification
3.2. Changing the Indexing Specification of a Library
3.3. Writing custom Sieves

III. Developer's Guide

6. Programming with the Qizx API

1. What you'll learn

1.1. About the data samples used in this tutorial
1.2. Compiling and running the code samples

2. Creating a Library and populating it with Collections and Documents

2.1. Creating a LibraryManager
2.2. Creating a Library
2.3. Creating Collections and importing Documents
2.4. The dual nature of the Library object: both a database and a transactional session
2.5. Compiling and running the code of this lesson

3. Retrieving Documents stored in a database

3.1. Compiling and running the code of this lesson

4. Querying a database

4.1. Compiling and running the code of this lesson

5. Deleting Documents and Collections

5.1. Compiling and running the code of this lesson

6. Modifying a Document stored in a database

6.1. Compiling and running the code of this lesson

7. Customizing the indexing of XML content

7.1. Re-indexing a Library
7.2. Writing a custom Indexing.NumberSieve
7.3. Compiling and running the code of this lesson

8. Adding metadata to Documents

8.1. Compiling and running the code of this lesson

7. Writing efficient queries

1. The problem

1.1. An example

2. Performance Guidelines

2.1. Text search

2.2. Path Expressions

2.2.1. Indexable features of Path expressions
2.2.2. Inefficient functions or expressions

2.3. Planned enhancements

IV. Reference

8. General XQuery extension functions

1. Serialization

2. XSL Transformation

3. Dynamic evaluation

4. Pattern-matching

5. Date and Time

5.1. Differences with W3C specifications
5.2. Cast Extensions
5.3. Additional constructors
5.4. Additional accessors

6. Error handling

7. Miscellaneous

9. Full-text XQuery extension functions

1. General full-text function
2. Specialized Full-text functions

10. XML Library extension functions

11. Java™ Binding

V. Tools

qizx — Qizx command line tool

Qizx Studio Help

1. The 'XML Libraries' tab

1.1. Library browser

1.2. Property display

1.3. Document display

1.3.1. Export document to file
1.3.2. View mode

2. The 'XQuery' tab

2.1. XQuery Editor

2.1.1. Query Execution
2.1.2. Stopping Query execution
2.1.3. Query history
2.1.4. Clear editor text

2.2. Result View

2.2.1. Move forward and backward in result sequence
2.2.2. Export result sequence to a file
2.2.3. Change the display style of results

2.3. Message View

3. Dialogs

3.1. 'XML Catalogs' dialog
3.2. 'Create Collection' dialog
3.3. 'Import Documents' dialog
3.4. 'Export Document' dialog
3.5. The Metadata Property Editor dialog
3.6. 'Indexing Specification' dialog
3.7. 'Backup Library' dialog
3.8. 'Error Log' dialog

A. Qizx/open Manual

1. Getting Started with Qizx/open

1.1. Writing and running queries with Qizx Studio
1.2. Running queries with the qizx command line tool

2. Programming with the Qizx/open API

2.1. Compiling and running the code samples

2.2. Creating a work session

2.3. Compiling and executing queries

2.3.1. Compiling and running the code of this lesson

3. Differences between Qizx/open and Qizx/db

3.1. Java API
3.2. Function fn:doc()
3.3. Function fn:collection()

Glossary

List of Figures

4.1. Qizx Studio first launch
4.2. Creating an XML Library
4.3. Library browser after importing documents
4.4. Exporting a Document from an XML Library
4.5. Result of a query
4.6. Adding a new property 'meta-info-1'
1. XML Libraries tab
2. XQuery tab
3. Import dialog
A.1. Qizx Studio first launch
A.2. Result of a query

List of Tables

8.1. Implemented serialization options
8.2. XSLT transform options
11.1. Types conversions
A.1. Summary of functional differences between Qizx/open and Qizx/db

		Next
		Foreword