© 2001 The dbXML Group L.L.C.
This documentation is a work in progress. Links to the most current version can be found at http://www.dbxml.org/docs/
$Id: ToolsReference.xml,v 1.21 2001/08/15 09:49:52 kstaken Exp $
Adds a new collection to the database. When adding a collection under an existing collection hierarchy all parent collections must already exist in the database.
-c The collection context under which to create the new collection. |
-n The name of the collection to create |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Deletes a collection or subcollection from the database. If deleting a collection that has subcollections and documents they will also be deleted.
-c The collection context under which to delete the collection. |
-n The name of the collection to delete. |
-y Do not ask for confirmation of delete |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
List all collections under the collection context given. If no collection is given then the root collection will be asumed.
-c The collection context under which all sub collections are listed |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Adds a document to a collection or nested collection. Adding a document requires two parameters - the collection it will be stored under, and the file path to the document. If a document key is not provided an auto-generated system key will be used for the document. Documents cannot be added to collections that do not already exist. When entering the file path be sure to include the path and file extension.
-c The collection context under which to add the document |
-f The complete file path to the document being added |
-n The key to assign to the document |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Adds multiple documents to a collection or a nested collection. This command requires two arguments: the collection to store the documents under and the directory path containing the documents. Documents can be added to collections as well as subcollections as long as they exist. Documents added will be assigned their file name as the document key. The optional "extension" parameter can be used to import documents with a certain file extension. Document keys are shown as they are created.
-c The collection context under which to add the documents |
-f The path to the directory to import documents from |
-e The file extension to use when importing documents |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Deletes an existing document from a collection or nested collection within the database.
-c The collection context under which to delete the document |
-n The key of the document to be deleted |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Retrieves an existing document from a collection or nested collection within the database. The complete path where the document will be stored is required. If the file path passed in does not exist, it will be created . If the file argument given already exists, it will be overwritten automatically.
-c The collection context under which to retrieve the document |
-n The key of the document to be retrieved |
-f The file path to store the document under |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Adds multiple documents into a collection or a nested collection within the database, copying the directory structure into the database as collections. This command is designed to take a directory and create a collection from it's name. Directories under the directory will also be created as collections, duplicating the directory tree. The files within the specified directory are converted into Documents and then stored into the newly created collection with their filenames as the document keys. The optional "extension" parameter can be used to only import documents with a certain file extension. If the collection name used already exists it will be overwritten. Collection and document keys will are shown as they are created.
-c The collection context under which to import the documents |
-f The path to the documents being added |
-e The file extension to use when importing documents |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Creates an identical directory tree from a collection including any subcollections. The directory tree will be created starting at the directory passed in as an argument. This command requires the collection which you are eporting and the directory to export to as arguments.
-c The collection context under which to export the document tree |
-f The directory to create the collection structure under |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Adds a new XmlObject or nested XmlObject to the database. Adding an XmlObject requires an implementing class and a name. In order to add the XmlObject the collection that it is being added to must already exist. to sucessfully complete this topertation, the implementing class must be in the server's classpath.
-c The collection context under which to add the XmlObject |
-i The fully qualified class name for the implementing class |
-n The name to assign to the XmlObject |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Deletes an XmlObject or nested XmlObject from the database. Deleting an XmlObject requires the collection name and the XmlObject name.
-c The collection context under which to delete the XmlObject |
-n The name of the XmlObject to delete |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Lists all XmlObjects or nested XmlObjects in the database. The listing of XmlObjects works in a similar fashion to listing collections.
-c The collection context under which to list the XmlObjects |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Allows the invocation of an XmlObject in the database. This command requires two arguments - the collection to invoke the object under and the URI for the XmlObject. The URI given can be either relative or the absolute path. (See the users guide for more information on URI's)
-c The collection context under which to invoke the XmlObject |
-o The XmlObject that is being invoked |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Adds a new collection index or nested collection index to the database. In order to add the collection index, the collection it is being added to must already exist. This command allows you to supply optional parameters for setting the index page size, setting the maximum key size for the index, and the index data type.
-c The collection context under which to add the indexer |
-n The name of the index being added |
-p The pattern used to create the index |
--maxkeysize The MaxKeySize for the index ( default: 0 = none ) |
--pagesize The PageSize for the index ( default: 4096) |
-t The data type for the index to create. Possible values are:
string Non-normalized string value trimmed Normalized (whitespace stripped) string value short 16-bit signed short integer int 32-bit signed integer long 64-bit signed integer float 32-bit floating point value double 64-bit floating point value (XPath number) byte 8-bit signed byte char 16-bit signed character boolean 8-bit boolean value name Store document keys that contain the pattern |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Deletes a collection index or a nested collection index from the database. Deleting an index requires the collection and index name. If a collection index is deleted, the collection will still remain.
-c The collection context under which to delete the index |
-n The name of the indexer being deleted |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Lists all collection indexers or nested collection indexes in the database. The listing of indexes works in a similar fashion to listing collections
-c The collection context under which to list the indexers |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Execute an Xpath query against a collection or nested collection. The command requires two arguments : the collection to query against and the query string to use.
-c The collection context under which to execute the query |
-q The query to execute against the collection |
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |
Shutdown the dbXML server
-v Show verbose output |
-u The URI for the dbXML host to use. http://host:[port] |