Changes

Jump to navigation Jump to search
2,010 bytes removed ,  23:42, 25 May 2012
m
Text replace - "| valign='top' | " to "| "
|<code>DBPATH [path]</code>
|-
| valign='top' | '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]] or [[Configuration#Database Directory|{home}/data]]</code>
|-
| valign='top' | '''Summary'''
|Points to the directory in which all databases are located.<br/> '''Note:''' this option can only be changed if no database is currently opened. If the option is changed, existing databases will not be moved to the new location.
|}
|<code>REPOPATH [path]</code>
|-
| valign='top' | '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
|-
| valign='top' | '''Summary'''
|Points to the [[Repository]], in which all XQuery modules are located.<br/>'''Note:''' if the option is changed, BaseX needs to be restarted in order to activate existing packages and avoid side effects.
|}
|<code>DEBUG</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes.
|}
|<code>LANG [language]</code>
|-
| valign='top' | '''Default'''
|<code>English</code>
|-
| valign='top' | '''Summary'''
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to be restarted in order to activate the new language.
|}
|<code>LANGKEY</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Prefixes all texts with the internal language keys. This option is helpful if BaseX is translated into another language, and if you want to see where particular texts are displayed. BaseX needs to be restarted in order to activate this option.
|}
|<code>HOST [host]</code>
|-
| valign='top' | '''Default'''
|<code>localhost</code>
|-
| valign='top' | '''Summary'''
|This host name is used by the client when connecting to a server.
|}
|<code>PORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>1984</code>
|-
| valign='top' | '''Summary'''
|This port is used by the client when connecting to a server.
|}
|<code>SERVERPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>1984</code>
|-
| valign='top' | '''Summary'''
|This is the port the database server will be listening to.
|}
|<code>SERVERHOST [host&#x7c;ip]</code>
|-
| valign='top' | '''Default'''
|''empty'' (''wildcard'')
|-
| valign='top' | '''Summary'''
|This is the host name or ip address the server is bound to. The server will be open to all clients if the option is set to an empty string.
|}
|<code>EVENTPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>1985</code>
|-
| valign='top' | '''Summary'''
|This port is used by the client to listen for [[Events|server events]]. This port will only be bound if a client attaches itself to a database event.
|}
|<code>HTTPPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>8984</code>
|-
| valign='top' | '''Summary'''
|This is the port the [[Startup#BaseX HTTP Server|HTTP Server]] will be listening to.
|}
|<code>STOPPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>8985</code>
|-
| valign='top' | '''Summary'''
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed.
|}
|<code>HTTPPATH [path]</code>
|-
| valign='top' | '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXHTTP]]</code>
|-
| valign='top' | '''Summary'''
|Points to the HTTP root directory, in which HTML files may be stored, and query files that will be evaluated by the [[REST]] service.
|}
|<code>PROXYHOST [host]</code>
|-
| valign='top' | '''Default'''
|
|-
| valign='top' | '''Summary'''
|This is the host name of a proxy server.
|}
|<code>PROXYPORT [port]</code>
|-
| valign='top' | '''Default'''
|<code>80</code>
|-
| valign='top' | '''Summary'''
|This is the port number of a proxy server.
|}
|<code>NONPROXYHOSTS [hosts]</code>
|-
| valign='top' | '''Default'''
|
|-
| valign='top' | '''Summary'''
|This is a list of hosts that should be directly accessed.
|}
|<code>PARALLEL [number]</code>
|-
| valign='top' | '''Default'''
|<code>8</code>
|-
| valign='top' | '''Summary'''
|Denotes the maximum allowed <code>number</code> of parallel read [[Transaction Management|transactions]].
|}
|<code>TIMEOUT [seconds]</code>
|-
| valign='top' | '''Default'''
|<code>0</code> (''no timeout'')
|-
| valign='top' | '''Summary'''
|Specifies the maximum time a read-only transaction may take. If an operation takes longer than the specified timeout, it will be aborted.<br/>Write operations will not be affected by this timeout, as this would corrupt the integrity of the database.<br/>The timeout is deactivated if the timeout is set to {{mono|0}}. Since {{Version|7.2}}, it is ignored for {{Mono|ADMIN}} operations.
|}
|<code>AUTHTIMEOUT [seconds]</code>
|-
| valign='top' | '''Default'''
|<code>10</code>
|-
| valign='top' | '''Summary'''
|Specifies the maximum time reserved for creating a new session. If authentication takes longer than the specified timeout, the connection will be closed.<br/>The timeout is deactivated if the timeout is set to {{mono|0}}.
|}
|<code>KEEPALIVE [seconds]</code>
|-
| valign='top' | '''Default'''
|<code>0</code> (''no timeout'')
|-
| valign='top' | '''Summary'''
|Specifies the maximum time a client will be remembered by the server. If there has been no interaction with a client for a longer time than specified by this timeout, it will be disconnected. Running operations will not be affected by this option. The keepalive check is deactivated if the value is set to {{mono|0}}.
|}
|<code>CHOP</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Chops all leading and trailing whitespaces from text nodes while building a database, and discards empty text nodes. This option often reduces the database size by up to 50%.
|}
|<code>INTPARSE</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Uses the internal XML parser instead of the standard Java XML parser. The internal parser is faster, more fault tolerant and supports common HTML entities out-of-the-box, but it does not support all features needed for parsing DTDs.
|}
|<code>DTD</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{mono|false}}, as many DTDs are located externally, which may completely block the process of creating new databases. The [[#CATFILE|CATFILE]] option can be changed to locally resolve DTDs.
|}
|<code>CATFILE [path]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Specifies a catalog file to locally resolve DTDs; see the entry on [[Catalog Resolver]]s for more details.
|}
|<code>CREATEFILTER [filter]</code>
|-
| valign='top' | '''Default'''
|<code>*.xml</code>
|-
| valign='top' | '''Summary'''
|File filter in the [[Commands#Glob Syntax|Glob Syntax]], which is applied whenever new databases are created, or resources are added to a database.
|}
|<code>ADDARCHIVES</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|If this option is set to {{mono|true}}, files within archives (ZIP, GZIP, DOCX, etc.) are parsed whenever new database are created or resources are added to a database.
|}
|<code>SKIPCORRUPT</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Skips corrupt (i.e., not well-formed) files while creating a database or adding new documents. If this option is activated, document updates are slowed down, as all files will be parsed twice. Next, main memory consumption will be higher as parsed files will be cached in main memory.
|}
|<code>ADDRAW</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|If this option is activated, and if new resources are added to a database, all files that are not filtered by the [[#CREATEFILTER|CREATEFILTER]] option will be added as ''raw'' files (i.e., in their binary representation).
|}
|<code>PARSER [type]</code>
|-
| valign='top' | '''Default'''
|<code>XML</code>
|-
| valign='top' | '''Summary'''
|Defines a [[Parsers|parser]] for importing new files to the database. Currently, 'XML', 'JSON', 'CSV', 'TEXT', 'HTML' are available as parsers. HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath.
|}
|<code>PARSEROPT [options]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Defines parser-specific options; see [[Parsers]] for more information.
|}
|<code>HTMLOPT [options]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Allows to specify TagSoup options for HTML parsing; see [[Parsers#HTML Parser|HTML Parser]] for more information.
|}
|<code>MAINMEM</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|If this option is turned on, new databases will be exclusively created in main memory. Most queries will be evaluated faster in main memory mode, but all data is lost if BaseX is shut down. The value of this option will be assigned once to a new database, and cannot be changed after that.
|}
|<code>PATHINDEX</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Creates a path index whenever a new database is created. A path index helps to optimize location paths; see [[Indexes]] for more details.
|}
|<code>TEXTINDEX</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes; see [[Indexes]] for more details.
|}
|<code>ATTRINDEX</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values; see [[Indexes]] for more details.
|}
|<code>FTINDEX</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions; see [[Indexes]] for more details.
|}
|<code>MAXLEN</code>
|-
| valign='top' | '''Default'''
|<code>96</code>
|-
| valign='top' | '''Summary'''
|Specifies the maximum length of strings that are to be indexed by the name, path, value, and full-text index structures. The value of this option will be assigned once to a new database, and cannot be changed after that.
|}
|<code>MAXCATS</code>
|-
| valign='top' | '''Default'''
|<code>100</code>
|-
| valign='top' | '''Summary'''
|Specifies the maximum number of distinct values (categories) that will be stored together with the element/attribute names or unique paths in the [[Index#Name Index|Name Index]] or [[Index#Path Index|Path Index]]. The value of this option will be assigned once to a new database, and cannot be changed after that.
|}
|<code>UPDINDEX</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|If turned on, incremental indexing will be activated: all update operations will also update the value index structures (texts and attribute values). The value of this option will be assigned once to a new database, and cannot be changed after that. The advantage of incremental indexes is that the value index structures will always be up-to-date. The downside is that updates will take a little bit longer.
|}
|<code>WRITEBACK</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Updates on XML nodes are written back to the input files. Note that no backups of your original files will be created if this option is turned on.
|}
|<code>AUTOFLUSH</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Flushes database buffers to disk after each update. If this option is set to {{mono|false}}, bulk operations (multiple single updates) will be evaluated faster. As a drawback, the chance of data loss increases if the database is not explicitly flushed via the [[Commands#FLUSH|FLUSH]] command.
|}
|<code>MAXSTAT [num]</code>
|-
| valign='top' | '''Default'''
|<code>30</code>
|-
| valign='top' | '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
|}
|<code>STEMMING</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|A new full-text index will stem all tokens and speed up queries on stemmed tokens. The same stemming normalization will be applied to all query tokens that are checked against tokens in this index.
|}
|<code>CASESENS</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|A new full-text index will preserve the case of all tokens. The same case normalization will be applied to all query tokens that are checked against tokens in this index.
|}
|<code>DIACRITICS</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|A new full-text index will preserve the diacritics of all tokens. The same diacritics normalization will be applied to all query tokens that are checked against tokens in this index.
|}
|<code>LANGUAGE [lang]</code>
|-
| valign='top' | '''Default'''
|<code>en</code>
|-
| valign='top' | '''Summary'''
|A new full-text index will use the given language to normalize all tokens. This option is mainly important if tokens are to be stemmed, or if the tokenization of a language differs from Western languages.
|}
|<code>STOPWORDS [path]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|A new full-text index will drop tokens that are listed in the specified stopword list. A stopword list may decrease the size of the full text index. A standard stopword list for English texts is provided in the directory <code>etc/stopwords.txt</code> in the official releases.
|}
|<code>LSERROR [error]</code>
|-
| valign='top' | '''Default'''
|<code>0</code>
|-
| valign='top' | '''Summary'''
|This option specifies the maximum Levenshtein error for the BaseX-specific fuzzy match option. See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
|}
|<code>WILDCARDS</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|If a new full-text index is created, it will be particularly optimized for wildcards expressions. See the page on [[Full-Text]]s for more information on XQuery Full Text.
|}
|<code>SCORING [mode]</code>
|-
| valign='top' | '''Default'''
|<code>0</code>
|-
| valign='top' | '''Summary'''
|A new full-text index will pre-calculate full-text scores. This option enables TF/IDF/based scores in full-text queries and increases main memory consumption while indexing. See the [[Full-Text#Scoring|Scoring]] for more information on different scoring types.
|}
|<code>QUERYINFO</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Prints more information on internal query rewritings, optimizations, and performance. The query info will always be printed in the [[GUI#Visualizations|Info View]] in the GUI, or it can be activated with the [[Startup_Options#BaseX_Standalone|-V flag]] on command line.
|}
|<code>XQUERY3</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Enables all [[XQuery 3.0]] features supported by BaseX. If this option is set to {{mono|false}}, the XQuery parser will only accept expressions of the XQuery 1.0 specification.
|}
|<code>SERIALIZE</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Results of XQuery expressions will be serialized if this option is turned on. For debugging purposes and performance measurements, this option can be set to {{mono|false}}.
|}
|<code>BINDINGS [vars]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Contains external variables to be bound to a query. Variable names and values are separated by equality signs, and multiple variables are delimited by commas. Variables may optionally be introduced with a leading dollar sign. Commas that occur in the value itself are encoded by duplication. If a variable uses a namespace different to the default namespace, it can be specified with the [http://www.jclark.com/xml/xmlns.htm Clark Notation] or [http://www.w3.org/TR/xquery-30/#id-basics Expanded QName Notation].
|-
| valign='top' | '''Examples'''
|<code>$a=1,$b=2</code> &nbsp; binds the values {{mono|1}} and {{mono|2}} to the variables $a and $b<br/><code>a=1,,2</code> &nbsp; binds the value {{mono|1,2}} to the variable $a<br/><code>{URI}a=x</code> or <code>'URI':a=x</code> &nbsp; binds the value {{Mono|x}} to the variable $a with the namespace {{Mono|URI}}.
|}
|<code>SERIALIZER [params]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Contains parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, and multiple parameters are delimited by commas.
|-
| valign='top' | '''Example'''
|<code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{mono|US-ASCII}} and prints the XML declaration.
|}
|<code>EXPORTER [params]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Contains parameters for exporting all resources of a database; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are delimited by commas.
|}
|<code>QUERYPATH [path]</code>
|-
| valign='top' | '''Default'''
|''empty''
|-
| valign='top' | '''Summary'''
|Contains the path (''base URI'') to the executed query (default: ''empty''). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query.
|}
|<code>CACHEQUERY</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Caches the query results before returning them to the client. This option may be set to {{mono|true}} if the whole result is needed for further operations (such as is e.g. the case in the GUI of BaseX).
|}
|<code>FORCECREATE</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|By activating this option, the XQuery {{mono|doc()}} and {{mono|collection()}} functions will create database instances for the addressed input files.
|}
|<code>RUNS [num]</code>
|-
| valign='top' | '''Default'''
|<code>1</code>
|-
| valign='top' | '''Summary'''
|Specify number of runs a query is executed. Results are printed a single time and evaluation times are averages of all runs.
|}
|<code>XMLPLAN</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Prints the execution plan of an XQuery expression in its XML representation.
|}
|<code>COMPPLAN</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Creates the query plan before or after the compilation step. Query plans might change due to optimizations.
|}
|<code>DOTPLAN</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty] and saves its dot file in the query directory.
|}
|<code>DOTCOMPACT</code>
|-
| valign='top' | '''Default'''
|<code>false</code>
|-
| valign='top' | '''Summary'''
|Chooses a compact dot representation.
|}
|<code>DOTDISPLAY</code>
|-
| valign='top' | '''Default'''
|<code>true</code>
|-
| valign='top' | '''Summary'''
|Visualizes the dot representation after the query execution.
|}
|<code>DOTTY [path]</code>
|-
| valign='top' | '''Default'''
|<code>dotty</code>
|-
| valign='top' | '''Summary'''
|Location of the {{mono|dotty}} executable.
|}
Bureaucrats, editor, reviewer, Administrators
12,957

edits

Navigation menu