Options

This page is linked from the Getting Started Section.

The options listed on this page influence the way how database commands are executed and XQuery expressions are evaluated. Two kinds of options exist:


 * Global Options are valid for all BaseX instances in the same JVM. This is particularly relevant if you are working with the client/server architecture.
 * Local options (all remaining ones) are specific to a client or session.

Values of options are either strings, numbers or booleans. Options are static and not bound to a single operation (for example, the next command). Various ways exist to access and change options:


 * The current value of an option can be requested with the command. Local options can be changed via  (all global options, except for, can only be changed at startup time). If an option is of type boolean, and if no value is specified, its current value will be inverted.


 * The .basex configuration file is parsed by every new local BaseX instance. It contains all global options. Local options can be specified at the end of the file after the Local Options comment:

 DEBUG = false ...
 * 1) General Options

CHOP = false
 * 1) Local Options


 * Initial values for global options can also be specified via system properties, which can e.g. be passed on with the -D flag on command line, or using System.setProperty before creating a BaseX instance. The specified keys need to be prefixed with org.basex.. An example:

 java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop" CHOP: false


 * If using the Mac OS X packaged application then global options can be set within the Info.plist file within the Contents folder of the application package. For example:

 JVMOptions -Dorg.basex.CHOP=false


 * In a Web Application, the default can be adjusted in the web.xml file as follows:

  org.basex.chop false 


 * In XQuery, local options can be set via option declarations and pragmas.

If options are changed by operations in the GUI, the underlying commands will be listed in the Info View.

=Global Options=

Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the DEBUG option, which can also be changed at runtime by users with admin permissions.

HTTP Services
Most HTTP options are defined in the jetty.xml and web.xml configuration files in the  directory. Some additional BaseX-specific options exist that will be set before the web server is started:

STOPPORT
=Create Options=

Indexing
The following options control the creation of index structures. The current values will be considered if a new database is created. See Indexes for more details.

STOPWORDS
=Query Options=

COPYNODE
=Serialization Options=

FULLPLAN
=Other Options=

MAXSTAT
=Changelog=


 * Version 9.3
 * Added: ,


 * Version 9.2
 * Added: ,
 * Removed: ,


 * Version 9.0
 * Added:, ,


 * Version 8.6
 * Added: ,
 * Removed: GLOBALLOCK (exclusive use of database lock)
 * Removed: QUERYPATH (will now be internally assigned)
 * Removed: CACHERESTXQ (replaced with PARSERESTXQ)


 * Version 8.5


 * Added: ,
 * Updated: : custom value added.


 * Version 8.4


 * Added: ,
 * Added: (replacing   and  )
 * Removed: ,


 * Version 8.3


 * Added:, , , ,


 * Version 8.2


 * Removed: ,


 * Version 8.1


 * Added: ,


 * Version 8.0


 * Added:, , ,
 * Updated: : default set to 0; will be ignored., : empty strings will be ignored.


 * Version 7.8.1
 * Updated: : parsing of TAR and TGZ files.


 * Version 7.8


 * Added:, , , , , , ,
 * Updated: only applies to main-memory document instances.
 * Updated: option can be changed at runtime by users with admin permissions.
 * Updated: default of is now false.
 * Removed:  (replaced with ),   (replaced with parser-specific options),  ,


 * Version 7.7


 * Added:, , ,


 * Version 7.6


 * Added:
 * Added: store local options in configuration file after # Local Options comments.


 * Version 7.5


 * Added: options can now be set via system properties
 * Added: a pragma expression can be used to locally change database options
 * Added:, , , , , , ,
 * Removed: HTTPPATH; HTTPPORT: jetty.xml configuration file is used instead
 * Removed: global options cannot be changed anymore during the lifetime of a BaseX instance


 * Version 7.3


 * Updated:, : default values changed
 * Removed: WILDCARDS; new index supports both fuzzy and wildcard queries
 * Removed: SCORING; new scoring model will focus on lengths of text nodes and match options


 * Version 7.2


 * Added:, , ,
 * Updated: : ignore timeout for admin users


 * Version 7.1


 * Added:, , ,
 * Updated:


 * Version 7.0


 * Added:, , ,