Changes

Jump to navigation Jump to search
89 bytes added ,  17:03, 9 August 2012
no edit summary
The main options are only available from the [[Standalone Mode]] and [[Database Server]] instances of BaseX, i.e., they cannot be changed by database clients. They are stored in the [[Configuration#Configuration Files|.basex config file]], which is opened by every new BaseX instance:
 
==General==
===DBPATH===
=Create Options=
==General=CHOP==={||-| width='90' | '''Signature'''|{{Code|CHOP}}|-| '''Default'''|{{Code|true}}|-| '''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%.|}
===INTPARSECREATEONLY==={||-| width='90' | '''Signature'''|{{Code|INTPARSE}}|-| '''Default'''|{{Code|true}}|-| '''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.|}
===STRIPNS===
{{Mark|Introduced with Version 7.4:}}
{|
|-
| width='90' | '''Signature'''
|{{Code|STRIPNSCREATEONLY}}
|-
| '''Default'''
|-
| '''Summary'''
|Strips all namespaces from an XML document before adding it By default, newly created databases will automatically be opened in order to a databasebe available for further processing steps. By setting the flag to {{Code|true}}, this will be prevented.
|}
===DTDMAINMEM===
{|
|-
| width='90' | '''Signature'''
|{{Code|DTDMAINMEM}}
|-
| '''Default'''
|-
| '''Summary'''
|Parses referenced DTDs and resolves XML entities. By default, If this option is switched to {{Code|false}}, as many DTDs are located externallyturned on, which may completely block the process of creating new databaseswill 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 [[#CATFILE|CATFILE]] value of this option can will be assigned once to a new database, and cannot be changed to locally resolve DTDsafter that.
|}
===CATFILEGC==={{Mark|Introduced with Version 7.4:}}
{|
|-
| width='90' | '''Signature'''
|{{Code|CATFILE GC [pathnumber]}}
|-
| '''Default'''
|''empty2''
|-
| '''Summary'''
|Specifies a catalog file Number of explicit consecutive garbage collections runs to locally resolve DTDs; see be executed when memory gets low during the entry on [[Catalog Resolver]]s for more detailsconstruction of index structures.
|}
 
==Parsing==
===CREATEFILTER===
| '''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.
|}
 
===CREATEONLY===
 
{{Mark|Introduced with Version 7.4:}}
 
{|
|-
| width='90' | '''Signature'''
|{{Code|CREATEONLY}}
|-
| '''Default'''
|{{Code|false}}
|-
| '''Summary'''
|By default, newly created databases will automatically be opened in order to be available for further processing steps. By setting the flag to {{Code|true}}, this will be prevented.
|}
|}
==XML Parsing=GC= ===CHOP==={||-| width='90' | '''Signature'''|{{Code|CHOP}}|-| '''Default'''|{{Code|true}}|-| '''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%.|} ===INTPARSE==={||-| width='90' | '''Signature'''|{{Code|INTPARSE}}|-| '''Default'''|{{Code|true}}|-| '''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.|} ===STRIPNS===
{{Mark|Introduced with Version 7.4:}}
{|
|-
| width='90' | '''Signature'''
|{{Code|GC [number]STRIPNS}}
|-
| '''Default'''
|''2''{{Code|false}}
|-
| '''Summary'''
|Number of explicit consecutive garbage collections runs Strips all namespaces from an XML document before adding it to be executed when memory gets low during the construction of index structuresa database.
|}
=Database Options==DTD==={||-| width='90' | '''Signature'''|{{Code|DTD}}|-| '''Default'''|{{Code|false}}|-| '''Summary'''|Parses referenced DTDs and resolves XML entities. By default, this option is switched to {{Code|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.|}
===MAINMEMCATFILE===
{|
|-
| width='90' | '''Signature'''
|{{Code|MAINMEMCATFILE [path]}}
|-
| '''Default'''
|{{Code|false}}''empty''
|-
| '''Summary'''
|If this option is turned Specifies a catalog file to locally resolve DTDs; see the entry 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[[Catalog Resolver]]s for more details.
|}
 
==Indexing==
===PATHINDEX===
|}
===WRITEBACK==={||-| width='90' | '''Signature'''|{{Code|WRITEBACK}}|-| '''Default'''|{{Code|false}}|-| '''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.|} ===AUTOFLUSH==={||-| width='90' | '''Signature'''|{{Code|AUTOFLUSH}}|-| '''Default'''|{{Code|true}}|-| '''Summary'''|Flushes database buffers to disk after each update. If this option is set to {{Code|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.|} ===MAXSTAT==={||-| width='90' | '''Signature'''|{{Code|MAXSTAT [num]}}|-| '''Default'''|{{Code|30}}|-| '''Summary'''|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.|} =Full-Text Options==
===STEMMING===
|}
===LSERRORWRITEBACK===
{|
|-
| width='90' | '''Signature'''
|{{Code|LSERROR [error]WRITEBACK}}
|-
| '''Default'''
|{{Code|0false}}
|-
| '''Summary'''
|This option specifies Updates on XML nodes are written back to the maximum Levenshtein error for the BaseX-specific fuzzy match input files. Note that no backups of your original files will be created if this option. See the page on [[Full-Text#Fuzzy_Querying|Full-Texts]] for more information is turned on fuzzy querying.
|}
| '''Summary'''
|By activating this option, the XQuery {{Code|doc()}} and {{Code|collection()}} functions will create database instances for the addressed input files.
|}
 
===AUTOFLUSH===
{|
|-
| width='90' | '''Signature'''
|{{Code|AUTOFLUSH}}
|-
| '''Default'''
|{{Code|true}}
|-
| '''Summary'''
|Flushes database buffers to disk after each update. If this option is set to {{Code|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.
|}
 
===MAXSTAT===
{|
|-
| width='90' | '''Signature'''
|{{Code|MAXSTAT [num]}}
|-
| '''Default'''
|{{Code|30}}
|-
| '''Summary'''
|Specifies the maximum number of index occurrences printed by the <code>[[Commands#INFO|INFO INDEX]]</code> command.
|}
 
===LSERROR===
{|
|-
| width='90' | '''Signature'''
|{{Code|LSERROR [error]}}
|-
| '''Default'''
|{{Code|0}}
|-
| '''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.
|}
|-
| '''Summary'''
|Specify number of runs a query is executedby the [[Commands#XQUERY|XQUERY]] command. Results are printed a single time The result is only serialized once, and evaluation the measured times are averages of all runs.
|}
Bureaucrats, editor, reviewer, Administrators
12,250

edits

Navigation menu