Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
=Main Options=
The main options are only available in the [[Standalone Tutorial|standalone]] and [[Server Tutorial|server]] instance of BaseX; , i.e., they cannot be changed by database clients:
===LANGDBPATH===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>LANG DBPATH [languagepath]</code>
|-
| valign='top' | '''Default'''
|<code>English[[Configuration#Database Directory|{home}/BaseXData]] or [[Configuration#Database Directory|{home}/data]]</code>
|-
| valign='top' | '''Summary'''
|Set Points to the interface languagedirectory in which all databases are located. Currently, seven languages are available: <br/> 'English', 'GermanNote:', 'French', 'Dutch'this option can only be changed if no database is currently opened. If the option is changed, 'Italian', 'Japanese', and 'Vietnamese'. BaseX needs to existing databases will not be restarted in order moved to activate the new languagelocation.
|}
===LANGKEYREPOPATH===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>LANGKEYREPOPATH [path]</code>
|-
| valign='top' | '''Default'''
|<code>false[[Configuration#Database Directory|{home}/BaseXRepo]]</code>
|-
| valign='top' | '''Summary'''
|Prefix Points to the repository directory, in which all texts with [[Packaging|XQuery Packages]] are located.<br/>'''Note:''' if the internal language keys. This option is helpful for creating new translations. changed, BaseX needs to be restarted in order to activate this optionexisting packages and avoid side effects.
|}
===DBPATHDEBUG===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>DBPATH [path]DEBUG</code>
|-
| valign='top' | '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXData]]false</code>
|-
| valign='top' | '''Summary'''
|Set a new database pathSends internal debug info to STDERR. Note: if the database path is changed, existing databases have to This option can be manually moved turned of to the new locationget additional information for development and debugging purposes.
|}
===REPOPATHLANG===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>REPOPATH LANG [pathlanguage]</code>
|-
| valign='top' | '''Default'''
|<code>[[Configuration#Database Directory|{home}/BaseXRepo]]English</code>
|-
| valign='top' | '''Summary'''
|This <code>path</code> points 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 XQuery package repositorynew language.
|}
===DEBUGLANGKEY===
{|
|-
| valign='top' width='90' | '''Signature'''
|<code>DEBUGLANGKEY</code>
|-
| valign='top' | '''Default'''
|-
| valign='top' | '''Summary'''
|Show Prefixes all texts with the internal debug infolanguage keys. This option is helpful if BaseX is translated into another language, usually used for development of new featuresand if you want to see where particular texts are displayed. BaseX needs to be restarted in order to activate this option.
|}
|-
| valign='top' | '''Summary'''
|Host This is the host name or ip address the server is bound to. Introduced with {{Version|7.0}}The server will be open to all clients if the option is set to an empty string.
|}
|-
| valign='top' | '''Summary'''
|Port of This port is used by the client, listening to listen for [[Events|server events]]. This port is will only used be bound if a client attaches itself to a database event.
|}
|-
| valign='top' | '''Summary'''
|Port of This port is used by the [[Startup#BaseX HTTP server to address Server|HTTP Server]], which offers the [[WebDAV]] and [[REST]] services.
|}
|-
| valign='top' | '''Summary'''
|This local <code>path</code> points Points to the HTTP directory, in which is used query files are stored, which are evaluated by the [[REST]] service.
|}
|-
| valign='top' | '''Summary'''
|Set Denotes the maximum allowed <code>number</code> of parallel readersread [[Transaction Management|transactions]].
|}
|-
| valign='top' | '''Summary'''
|Client timeoutSpecifies the maximum time a read-only transaction may take. If a client process an operation takes longer than the specified timeout, it will be aborted. Database updates Write operations will not be affected by this timeout, as they this would endanger corrupt the integrity of the database integrity. The timeout is deactivated if <code>seconds</code> the timeout is set to <code>{{mono|0</code>}}.
|}
|-
| valign='top' | '''Summary'''
|Keepalive timeoutSpecifies 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 timeoutoption. The keepalive check is deactivated if <code>seconds</code> the value is set to <code>0</code>. Introduced with {{Versionmono|7.0}}.
|}
|-
| valign='top' | '''Summary'''
|Chop Chops all leading and trailing whitespaces from text nodes while building a database, and discard discards empty text nodes. This option often reduces the database size by up to 50%.
|}
|-
| valign='top' | '''Summary'''
|Use 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.
|}
|-
| valign='top' | '''Summary'''
|Parse Parses referenced DTDs and resolve 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.
|}
|-
| valign='top' | '''Summary'''
|Specify Specifies a catalog file to locally resolve DTDs; see the Wikipedia entry on [http://en.wikipedia.org/wiki/XML_Catalog XML Catalogs[Catalog Resolver]] s for more details.
|}
|-
| valign='top' | '''Summary'''
|Glob syntax for filtering files that are processed by File filter in the [[Commands#CREATEGlob Syntax|CREATE]Glob Syntax] , which is applied whenever new databases are created, or [[Commands#ADD|ADD]] commandsresources are added to a database.
|}
|-
| valign='top' | '''Summary'''
|Parse If this option is set to {{mono|true}}, files within archives (ZIP, GZIP, DOCX, GZIP, etc.) while creating are parsed whenever new database are created or resources are added to a database or adding new documents.
|}
|-
| valign='top' | '''Summary'''
|Skip Skips corrupt (i.e., non-not well-formed) files while creating a database or adding new documents. If this option is usedactivated, database creation is 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.
|}
|-
| valign='top' | '''Summary'''
|Define import Defines a [[Parsers|parser]]for importing new files to the database. As <code>TYPE</code> are available Currently, 'XML', 'CSV' or , 'TEXT', 'HTML' are available as parsers. If HTML will be parsed as normal XML files if [http://home.ccil.org/~cowan/XML/tagsoup/ Tagsoup] is not found in the classpath, 'HTML' is also available.
|}
|-
| valign='top' | '''Summary'''
|Define Defines parser-specific options. See ; see [[Parsers|parsers]] page for more information.
|}
|-
| valign='top' | '''Summary'''
|Create Creates a path index whenever a new database is created. A path index helps to optimize location paths; see [[Indexes]] for paths and speedup path based queriesmore details.
|}
|-
| valign='top' | '''Summary'''
|Create Creates a text index for whenever a new database is created. A text nodes and speedup index speeds up queries querying the entire with equality comparisons on text of a nodenodes; see [[Indexes]] for more details.
|}
|-
| valign='top' | '''Summary'''
|Create Creates an attribute index for whenever a new database is created. An attribute values and speedup index speeds up queries querying with equality comparisons on attribute values; see [[Indexes]] for more details.
|}
|-
| valign='top' | '''Summary'''
|Create Creates a full-text index for fulltext and speedup whenever a new database is created. A full-text index speeds up queries querying with full -textexpressions; see [[Indexes]] for more details.
|}
|-
| valign='top' | '''Summary'''
|Write original Updates on XML nodes are written back to the input files back after updates. As Note that, if this option is turned on, no backups of your original files will alter your input file make sure you have a backup before you use this optionbe created.
|}
|-
| valign='top' | '''Summary'''
|Use main-memory mode. Now all data If this option is turned on, new databases will be exclusively stored created in main memory. Some Most queries will be evaluated even fasterin main memory mode, but the all data is lost if BaseX is shut down.
|}
|-
| valign='top' | '''Summary'''
|Force By activating this option, the XQuery {{mono|doc()}} and {{mono|collection()}} functions will create database creation instances for unknown documents specified in XQuery expressionsthe addressed input files.
|}
|-
| valign='top' | '''Summary'''
|Flush Flushes database buffers to disk after each update. If this option is set to <code>{{mono|false</code>}}, some update operations will be evaluated much faster. As a drawback, but the chance of data loss increases if the database is always kept open and not explicitly flushed via the [[Commands (Snapshot)#FLUSH|FLUSH]] command. Introduced with {{Version|7.0}}.
|}
|-
| valign='top' | '''Summary'''
|Set Specifies the maximum number of index occurrences to print through printed by the command <code>info index[[Commands#INFO|INFO INDEX]]</code>command.
|}
|-
| valign='top' | '''Summary'''
|Create wildcard optimized If a new full -text index that is especially tuned created, it will be particularly optimized for querying full text using wildcards expressions. See the page on [[Full-Text]]s for more information on XQuery Full Text.
|}
|-
| valign='top' | '''Summary'''
|Stemm A new full -text index will stem all tokens before indexing and decrease index sizespeed up queries on stemmed tokens. Should only be assigned for full text queries using The same stemming, otherwise the full text index could not normalization will be assigned for applied to all query speedupstokens that are checked against tokens in this index.
|}
|-
| valign='top' | '''Summary'''
|Case sensitive A new full -text indexing, iindex will preserve the case of all tokens.e. full text The same case normalization will be applied to all query tokens that are stored case sensitive and enables the assignment of the full text checked against tokens in this index for case sensitive queries.
|}
|-
| valign='top' | '''Summary'''
|Diacritic sensitive A new full -text indexing, iindex will preserve the diacritics of all tokens.e. full text The same diacritics normalization will be applied to all query tokens that are stored with diacritics and enables the assignment of the full text checked against tokens in this index for diacritic queries.
|}
|-
| valign='top' | '''Summary'''
|Language used for creating a A new full-text search indexwill use the given language to normalize all tokens. Can e.g. This option is mainly important if tokens are to be set to <code>de</code> stemmed, or <code>German</code>if the tokenization of a language differs from Western languages.
|}
|-
| valign='top' | '''Summary'''
|Precalculation of A new full -text scores and storage within the index will pre-calculate full -text index structurescores. Enables This option enables TF/IDF /based scores in full -text queries and increases main memory consumption while indexing. <code>MODE</code> can be set to <code>1</code> for document based scoring, <code>2</code> for text node based scoring and <code>0</code> See the [[Full-Text#Scoring|Scoring]] for non more information on different scoringtypes.
|}
|-
| valign='top' | '''Summary'''
|Specify stop word A new full-text index will drop tokens that are listed in the specified stopword list at <code>PATH</code>, that could be used e.g. to A stopword list may decrease the size of the full text index size. The A standard stopword list (english) for English texts is provided at in the directory <code>'etc/xml/stopWords'stopwords.txt</code>in the official releases.
|}
|-
| valign='top' | '''Summary'''
|This option specifies the maximum Levenshtein default error used for the BaseX-specific fuzzy search with BaseX specialized own FTMatchOption, ematch option.g. error could be <code>2</code> See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information on fuzzy querying.
|}
|-
| valign='top' | '''Summary'''
|Show (all) process infoPrints more information on internal query rewritings, optimizations, and performance.
|}
|-
| valign='top' | '''Summary'''
|Enable/disable Enables all [http://www[XQuery 3.w30]] features supported by BaseX.org/TR/xquery-30/ If this option is set to {{mono|false}}, the XQuery parser will only accept expressions of the XQuery 31.0] functionsspecification.
|}
|-
| valign='top' | '''Summary'''
|Flag for serialization Results of query results. I.e. there are any results printed XQuery expressions will be serialized if serialization this option is turned offon. For debugging purposes and performance measurements, this option can be set to {{mono|false}}.
|}
|-
| valign='top' | '''Summary'''
|Contains external variables to be bound to the a query. Keys Variable names and values are separated by equality signs, and multiple variables are separated delimited by commas. Variables may optionally be introduced with a leading dollar sign.|-| valign='top' | '''Examples'''|<code>$a=1,$b=2</code> : binds the values {{mono|1}} and {{mono|2}} to the variables $a and $b.
|}
|-
| valign='top' | '''Summary'''
|Parameters Contains parameters for serializing queries; see [[Serialization]] for more details. Keys and values are separated by equality signs, and multiple parameters are separated 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.
|}
|-
| valign='top' | '''Summary'''
|Parameters Contains parameters for exporting the documentsall resources of a database; see [[Serialization]] for more details. Keys and values are separated by equality signs, multiple parameters are separated delimited by commas.
|}
|-
| valign='top' | '''Summary'''
|Contains the path (''base uriURI'') to the executed query. Introduced with {{Version|7.0}} (default: ''empty''). This directory will be used to resolve relative paths to documents, query modules, and other resources addressed in a query.
|}
|-
| 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).
|}
|-
| valign='top' | '''Summary'''
|Print query Prints the execution plan as xml documentof an XQuery expression in its XML representation.
|}
|-
| valign='top' | '''Summary'''
|Create Creates the query plan before or after the compilation - query plan step. Query plans might change due to optimizations.
|}
|-
| valign='top' | '''Summary'''
|Create query plans visualized Visualizes the execution plan of an XQuery expression with [http://www.graphviz.org dotty], see <code>'plan.and saves its dot'</code> file in your project folderthe query directory.
|}
|-
| valign='top' | '''Summary'''
|Compact Chooses a compact dot representation.
|}
|-
| valign='top' | '''Summary'''
|Display Visualizes the dot representation after the query execution.
|}
|-
| valign='top' | '''Summary'''
|Program <code>PATH</code> Location of the {{mono|dotty }} executable.
|}
