Difference between pages "Options" and "Git"

From BaseX Documentation
(Difference between pages)
Jump to navigation Jump to search
 
m
Tags: Mobile web edit Mobile edit
 
Line 1: Line 1:
This page is linked from the [[Getting Started]] Section.
+
This page is part of the [[Developer Section]]. It describes how to use [http://git-scm.com/ git] to manage the BaseX sources.
  
The options listed on this page influence the way how database [[Commands|commands]] are executed and XQuery expressions are evaluated. Two kinds of options exist:
+
==Using Git to contribute to BaseX ==
  
* '''[[#Global Options|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.
+
Our team uses git and [https://github.com GitHub] to manage the source code. All team members have read/write access to the repository, and external contributors are welcome to fork the project.  
* '''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:
+
Git makes it easy to retain a full copy of the repository for yourself. To get started and running, simply ''fork'' BaseX:
  
* The current value of an option can be requested with the {{Command|GET}} command. Local options can be changed via {{Command|SET}} (all global options, except for {{Option|DEBUG}}, 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.
+
# Head over to https://github.com and create an account
 +
# Fork https://github.com/BaseXdb/basex, so you have a version on your own
 +
# The forked project can then be cloned on your local machine, and changes can be pushed back to your remote repository
  
* The {{Code|.basex}} [[Configuration#Configuration Files|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 {{Code|Local Options}} comment:
+
==Using Git & Eclipse==
  
<pre class="brush:perl">
+
<table cellspacing='0' cellpadding='0' width='100%'>
# General Options
+
<tr><td valign='top'>
DEBUG = false
+
[[File:Git01.png|border|300px|left]]
...
+
[[File:Git02.png|border|300px|left]]
 +
[[File:Git03.png|border|300px|left]]
 +
[[File:Git04.png|border|300px|left]]
 +
[[File:Git05.png|border|300px|left]]
 +
[[File:Git06.png|border|300px|left]]
 +
[[File:Git07.png|border|300px|left]]
 +
[[File:Git08.png|border|300px|left]]
 +
[[File:Git09.png|border|300px|left]]
 +
[[File:Git10.png|border|300px|left]]
 +
</td><td valign='top'>
  
# Local Options
+
===Clone===
CHOP = false
 
</pre>
 
  
* Initial values for global options can also be specified via system properties, which can e.g. be passed on with the [http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/java.html#options -D flag] on command line, or using [http://docs.oracle.com/javase/6/docs/api/java/lang/System.html#setProperty(java.lang.String,%20java.lang.String) System.setProperty()] before creating a BaseX instance. The specified keys need to be prefixed with {{Code|org.basex.}}. An example:
+
* In the '''Package Explorer''' to the left, use right-click and choose '''Import...'''
 +
* Select '''Projects from Git''' and click '''Next &gt;'''
 +
* Choose the '''Clone''' option to create a local copy of the remote repository. This copy will include the full project history
 +
* Copy & Paste the GitHub URI in the Location field. If you want to use SSH, make sure you provided GitHub with your public key to allow write-access. If in doubt, use the https URI and authenticate yourself with your GitHub credentials. The read-only URI of the repository is {{Code|https://github.com/BaseXdb/basex.git}}.
 +
* Select the master branch (or arbitrary branches you like)  
 +
* Now choose a location where the local repository is stored: Create &lt;workspace&gt;'''/repos/BaseX''' and click "'''Finish'''".  
  
<pre class="brush:xquery">
+
===Create the project ===
java -Dorg.basex.CHOP=false -cp basex.jar org.basex.BaseX -c"get chop"
 
CHOP: false
 
</pre>
 
  
* 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:
+
* Select our newly cloned repository and click Next
 +
* Select "'''Import Existing Projects'''" and depending on your Eclipse version enable automatic sharing. More recent versions will not offer this feature as sharing is enabled by default.
 +
* Click next to select the Project to import
 +
* Check "basex" to checkout and click finish
 +
* You are now ready to contribute.  
  
<pre class="brush:xml">
+
===EGit & SSH===
<key>JVMOptions</key>
 
<array>
 
  <string>-Dorg.basex.CHOP=false</string>
 
</array>
 
</pre>
 
  
* In a [[Web Application]], the default can be adjusted in the {{Code|web.xml}} file as follows:
+
The Eclipse git plugin uses the [http://www.jcraft.com/jsch JSch] library, which had [https://bugs.eclipse.org/bugs/show_bug.cgi?id=326526 problems with RSA SSH keys] in Linux and possibly other platforms. If the problem persists, the path to the native SSH executable can be assigned to the {{Code|GIT_SSH}} variable. According to [http://egit.eclipse.org/r/#change,2037 this] change in EGit, the plugin will try to use a native SSH implementation instead of JSch.
  
<pre class="brush:xml">
+
==Using Git on Command-Line==
<context-param>
 
  <param-name>org.basex.chop</param-name>
 
  <param-value>false</param-value>
 
</context-param>
 
</pre>
 
  
* In XQuery, local options can be set via option declarations and [[XQuery Extensions#Pragmas|pragmas]].
+
'''Note''': this is not intended to be a complete git reference; it's purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project.
  
If options are changed by operations in the [[GUI]], the underlying commands will be listed in the [[GUI#Visualizations|Info View]].<br/><br/>
+
===Preparation===
  
=Global Options=
+
# Create a GitHub user account: [https://github.com/signup/free here] (your github user name will be referenced as $username)
 +
# Set up SSH access to GitHub as described [http://help.github.com/key-setup-redirect here]
 +
# Create a fork of one of the BaseXdb projects (it will be referenced as $project)
 +
# Choose a directory where the project will be created and make it your working directory (e. g. /home/user/myprojects)
  
Global options are constants. They can only be set in the configuration file or via system properties (see above). One exception is the [[#debug|DEBUG]] option, which can also be changed at runtime by users with [[User Management|admin permissions]].
+
===Clone Repository===
  
==General Options==
+
<pre class="brush:shell">
 +
$ git clone git@github.com:$username/$project.git
 +
Cloning into $project...
 +
Enter passphrase for key '/home/user/.ssh/id_rsa':
 +
...
  
===DEBUG===
+
$ ls -d -1 $PWD/*
 +
/home/user/myprojects/$project
 +
</pre>
 +
Note that git automatically creates a directory where the repository content will be checked out.
  
{| width='100%'
+
===List Remote Repositories===
|-
 
| width='120' | '''Signature'''
 
|{{Code|DEBUG [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Sends internal debug info to STDERR. This option can be turned on to get additional information for development and debugging purposes. It can also be triggered on [[Command-Line Options#BaseX Standalone|command line]] via <code>-d</code>.
 
|}
 
  
===DBPATH===
+
<pre class="brush:shell">
 +
$ git remote -v
 +
origin  git@github.com:$username/$project.git (fetch)
 +
origin  git@github.com:$username/$project.git (push)
 +
</pre>
 +
Currently, there is only one remote repository; it is automatically registered during the clone operation. Git remembers this repository as the default repository for push/pull operations.
  
{| width='100%'
+
===List Local Changes===
|-
 
| width='120' | '''Signature'''
 
|{{Code|DBPATH [path]}}
 
|-
 
| '''Default'''
 
|<code><code>[[Configuration#Database Directory|{home}/data]]</code>
 
|-
 
| '''Summary'''
 
|Points to the directory in which all databases are located.
 
|}
 
  
===LOGPATH===
+
After some files have been changed locally, the changes can be seen as follows:
 +
<pre class="brush:shell">
 +
$ git diff
 +
diff --git a/readme.txt b/readme.txt
 +
index fabaeaa..cd09568 100644
 +
--- a/readme.txt
 +
+++ b/readme.txt
 +
@@ -49,6 +49,10 @@ ADDING CHECKSTYLE --------------------------------------------------------------
 +
  - Enter the URL: http://eclipse-cs.sourceforge.net/update
 +
  - Follow the installation procedure and restart Eclipse
 +
 +
+USING GIT ----------------------------------------------------------------------
 +
 +
  Any kind of feedback is welcome; please check out the online documentation at
 +
</pre>
  
{| width='100%'
+
===Commit to Local Repository===
|-
 
| width='120' | '''Signature'''
 
|{{Code|LOGPATH [path]}}
 
|-
 
| '''Default'''
 
|<code>.logs</code>
 
|-
 
| '''Summary'''
 
|Points to the directory in which all [[Logging|log files]] are stored. Relative paths will be resolved against the {{Option|DBPATH}} directory.
 
|}
 
  
===REPOPATH===
+
'''Note''': this commit operation does '''not''' commit into the remote repository!
  
{| width='100%'
+
First, it is needed to select the modified files which should be committed:
|-
+
<pre class="brush:shell">
| width='120' | '''Signature'''
+
$ git add readme.txt
|{{Code|REPOPATH [path]}}
+
</pre>
|-
 
| '''Default'''
 
|<code>[[Configuration#Database Directory|{home}/repo]]</code>
 
|-
 
| '''Summary'''
 
|Points to the [[Repository]], in which all XQuery modules are located.
 
|}
 
  
===LANG===
+
Then perform the actual commit:
 +
<pre class="brush:shell">
 +
$ git commit
 +
[master 0fde1fb] Added TODO in section "USING GIT"
 +
1 files changed, 4 insertions(+), 0 deletions(-)
 +
</pre>
 +
Before executing the actual commit, git will open the default shell editor (determined using the $EDITOR variable, usually vi) to enter a message describing the commit changes.
  
{| width='100%'
+
Alternative way is to commit all changed files, i. e. it is not needed to explicitly add the changed files:
|-
+
<pre class="brush:shell">
| width='120' | '''Signature'''
+
$ git commit -a
|{{Code|LANG [language]}}
+
[master 0fde1fb] Added TODO in section "USING GIT"
|-
+
1 files changed, 4 insertions(+), 0 deletions(-)
| '''Default'''
+
</pre>
|{{Code|English}}
 
|-
 
| '''Summary'''
 
|Specifies the interface language. Currently, seven languages are available: 'English', 'German', 'French', 'Dutch', 'Italian', 'Japanese', and 'Vietnamese'.
 
|}
 
  
===LANGKEY===
+
===Pushing Changes to Remote Repository===
  
{| width='100%'
+
<pre class="brush:shell">
|-
+
$ git push
| width='120' | '''Signature'''
+
Enter passphrase for key '/home/user/.ssh/id_rsa':
|{{Code|LANGKEY [boolean]}}
+
Everything up-to-date
|-
+
</pre>
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''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.
 
|}
 
  
===FAIRLOCK===
+
===Pulling Changes from Remote Repository===
  
{| width='100%'
+
<pre class="brush:shell">
|-
+
$ git pull
| width='120' | '''Signature'''
+
Enter passphrase for key '/home/user/.ssh/id_rsa':  
|{{Code|FAIRLOCK [boolean]}}
+
Already up-to-date.
|-
+
</pre>
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Defines the locking strategy:
 
* By default, non-fair is used. Read transactions will be favored, and transactions that access no databases can be evaluated even if the limit of parallel transactions (specified via {{Option|PARALLEL}}) has been reached. This prevents update operations from blocking all other requests. For example, the DBA can further be used to see which jobs are running, even if the queue is full.
 
* If fair locking is enabled, read and write transactions will be treated equally (first in, first out). This avoids starvation of update operations, and it should be used if the prompt evaluation of update operations is critical.
 
|}
 
  
===CACHETIMEOUT===
+
===Add Upstream Repository===
  
{| width='100%'
+
The upstream repository is the one from which the BaseX releases are made and the one from which the personal repository was forked.
|-
 
| width='120' | '''Signature'''
 
|{{Code|CACHETIMEOUT [seconds]}}
 
|-
 
| '''Default'''
 
|{{Code|3600}}
 
|-
 
| '''Summary'''
 
|Specifies how many seconds the results of queries, which have been queued by the [[Jobs Module|asynchronously executed]], will be cached in main memory.
 
|}
 
  
==Client/Server Architecture==
+
<pre class="brush:shell">
 +
$ git remote add upstream git@github.com:BaseXdb/$project.git
  
===HOST===
+
$ git remote -v
 +
origin  git@github.com:$username/$project.git (fetch)
 +
origin  git@github.com:$username/$project.git (push)
 +
upstream        git@github.com:BaseXdb/$project.git (fetch)
 +
upstream        git@github.com:BaseXdb/$project.git (push)
 +
</pre>
  
{| width='100%'
+
===Pulling Changes from Upstream to Local Repository===
|-
 
| width='120' | '''Signature'''
 
|{{Code|HOST [host]}}
 
|-
 
| '''Default'''
 
|{{Code|localhost}}
 
|-
 
| '''Summary'''
 
|This host name is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-n</code>.
 
|}
 
  
===PORT===
+
When some changes are made in the upstream repository, they can be pulled to the local repository as follows:
  
{| width='100%'
+
<pre class="brush:shell">
|-
+
$ git pull upstream master
| width='120' | '''Signature'''
+
Enter passphrase for key '/home/user/.ssh/id_rsa':
|{{Code|PORT [port]}}
+
From github.com:BaseXdb/$project
|-
+
* branch            master    -> FETCH_HEAD
| '''Default'''
+
Already up-to-date.
|{{Code|1984}}
+
</pre>
|-
 
| '''Summary'''
 
|This port is used by the client when connecting to a server. This option can also be changed when running the client on [[Command-Line Options#BaseX Client|command line]] via <code>-p</code>.
 
|}
 
  
===SERVERPORT===
+
The changes can then be pushed in the personal repository:
 +
<pre class="brush:shell">
 +
$ git push
 +
</pre>
  
{| width='100%'
+
Check out the links at the end of the page for more git options.
|-
+
</td></tr></table>
| width='120' | '''Signature'''
 
|{{Code|SERVERPORT [port]}}
 
|-
 
| '''Default'''
 
|{{Code|1984}}
 
|-
 
| '''Summary'''
 
|This is the port the database server will be listening to. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-p</code>.
 
|}
 
  
===USER===
+
===Developing a new feature or bug fix===
  
{| width='100%'
+
It is always a good idea to create a new branch for a new feature or a big fix you are working on. So first, let's make sure you have the most up-to-date source code. We assume, that you added BaseX as upstream repository as described above and you are currently in the ''master'' branch:
|-
 
| width='120' | '''Signature'''
 
|{{Code|USER [name]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Represents a user name, which is used for accessing the server or an HTTP service:
 
* The default value will be overwritten if a client specifies its own credentials.
 
* If the default value is empty, login will only be possible if the client specifies credentials.
 
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-U</code>.
 
|}
 
  
===PASSWORD===
+
<pre class="brush:shell">
 +
$ git pull upstream master
 +
</pre>
  
{| width='100%'
+
Now, we create a new branch, based on the master branch
|-
 
| width='120' | '''Signature'''
 
|{{Code|PASSWORD [password]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Represents a password, which is used for accessing the server:
 
* The default value will be overwritten if a client specifies its own credentials.
 
* If the default value is empty, login will only be possible if the client specifies credentials.
 
* The option can also be changed on [[Command-Line Options#BaseX Client|command line]] via <code>-P</code>.
 
* Please note that it is a security risk to specify your password in plain text.
 
|}
 
  
===AUTHMETHOD===
+
<pre class="brush:shell">
 
+
$ git checkout -b new-feature
{| width='100%'
+
Switched to a new branch 'new-feature'
|-
+
</pre>
| width='120' | '''Signature'''
 
|{{Code|AUTHMETHOD [method]}}
 
|-
 
| '''Default'''
 
|''Basic''
 
|-
 
| '''Summary'''
 
|Specifies the default authentication method, which will be used by the [[Web Application|HTTP server]] for negotiating credentials. Allowed values are {{Code|Basic}}, {{Code|Digest}}, and {{Code|Custom}}:<br/>
 
* If basic access is chosen, the client can still request digest authentication.
 
* This is different for digest access, which cannot be overwritten.
 
* With custom authentication, the server will not do any authentication.
 
|}
 
 
 
===SERVERHOST===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|SERVERHOST [host&#x7c;ip]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|This is the host name or ip address the server is bound to. If the option is set to an empty string (which is the default), the server will be open to all clients.
 
|}
 
 
 
===PROXYHOST===
 
 
 
{| width='100%' width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|PROXYHOST [host]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|This is the host name of a proxy server. If the value is an empty string, it will be ignored.
 
|}
 
 
 
===PROXYPORT===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|PROXYPORT [port]}}
 
|-
 
| '''Default'''
 
|{{Code|0}}
 
|-
 
| '''Summary'''
 
|This is the port number of a proxy server. If the value is set to {{Code|0}}, it will be ignored.
 
|}
 
 
 
===NONPROXYHOSTS===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|NONPROXYHOSTS [hosts]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|This is a list of hosts that should be directly accessed. If the value is an empty string, it will be ignored.
 
|}
 
 
 
===IGNOREHOSTNAME===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|IGNOREHOSTNAME [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If this option is enabled, hostnames of certificates will not be verified. Use {{Option|IGNORECERT}} to completely disable certificate verification.
 
|}
 
 
 
===IGNORECERT===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|IGNORECERT [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|This option can be turned on to ignore untrusted certificates when connecting to servers. Use {{Option|IGNOREHOSTNAME}} to suppress only the hostname verification.
 
|}
 
 
 
===TIMEOUT===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TIMEOUT [seconds]}}
 
|-
 
| '''Default'''
 
|{{Code|30}}
 
|-
 
| '''Summary'''
 
|Specifies the maximum time a transaction triggered by a client may take. If an operation takes longer than the specified number of seconds, it will be aborted. Active update operations will not be affected by this timeout, as this would corrupt the integrity of the database. The timeout is deactivated if the timeout is set to {{Code|0}}. It is ignored for operations with [[User Management|admin permissions]].
 
|}
 
 
 
===KEEPALIVE===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|KEEPALIVE [seconds]}}
 
|-
 
| '''Default'''
 
|{{Code|600}}
 
|-
 
| '''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 {{Code|0}}.
 
|}
 
 
 
===PARALLEL===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|PARALLEL [number]}}
 
|-
 
| '''Default'''
 
|{{Code|8}}
 
|-
 
| '''Summary'''
 
|Denotes the maximum allowed number of parallel [[Transaction Management|transactions]]:
 
* If {{Option|FAIRLOCK}} is enabled, the number of parallel transactions will never exceed the specified value.
 
* If the option is disabled (which is the default), the limit only applies to transactions that access databases.
 
* The main reason for allowing parallel operations is to prevent slow transactions from blocking all other operations. A higher number of parallel operations may increase disk activity and thus slow down queries. In some cases, a single transaction may even give you better results than any parallel activity.
 
|}
 
 
 
===LOG===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|LOG [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Turns [[Logging]] of server operations and HTTP requests on/off. This option can also be changed when running the server on [[Command-Line Options#BaseX Server|command line]] via <code>-z</code>.
 
|}
 
 
 
===LOGMSGMAXLEN===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|LOGMSGMAXLEN [length]}}
 
|-
 
| '''Default'''
 
|{{Code|1000}}
 
|-
 
| '''Summary'''
 
|Specifies the maximum length of a single [[Logging|log message]].
 
|}
 
 
 
==HTTP Services==
 
 
 
Most HTTP options are defined in the {{Code|jetty.xml}} and {{Code|web.xml}} configuration files in the <code>[https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/webapp/WEB-INF webapp/WEB-INF]</code> directory. Some additional BaseX-specific options exist that will be set before the web server is started:
 
 
 
===WEBPATH===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|WEBPATH [path]}}
 
|-
 
| '''Default'''
 
|<code>[[Configuration#Database Directory|{home}/webapp]]</code>
 
|-
 
| '''Summary'''
 
|Points to the directory in which all the [[Web Application]] contents are stored, including XQuery, Script, [[RESTXQ]] and configuration files. This option is ignored if BaseX is deployed as [[Web Application#Servlet_Container|web servlet]].
 
|}
 
 
 
===RESTXQPATH===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|RESTXQPATH [path]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Points to the directory which contains the [[RESTXQ]] modules of a web application. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
 
|}
 
 
 
===PARSERESTXQ===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|PARSERESTXQ}}
 
|-
 
| '''Default'''
 
|{{Code|3}}
 
|-
 
| '''Summary'''
 
|Timeout after which the RESTXQ directory will be parsed for changes:
 
* If {{Code|0}} is specified, the directory will be parsed every time a RESTXQ function is called.
 
* A positive value defines the idle time in seconds after which parsing will be enforced. The default value is {{Code|3}}: Changes in the RESTXQ directory will be detected after 3 seconds without RESTXQ function calls.
 
* Monitoring is completely disabled if a negative value is specified.
 
 
 
See [[RESTXQ#Preliminaries|RESTXQ Preliminaries]] for more details.
 
|}
 
 
 
===RESTXQERRORS===
 
 
 
{{Mark|Introduced with Version 9.2.}}
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|RESTXQERRORS}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Reports parsing errors in XQuery modules in the RESTXQ directory back to the client. By default, this option is enabled. On productive systems, it can be disabled in order to suppress errors that should not be seen by the client.
 
|}
 
 
 
===RESTPATH===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|RESTPATH [path]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Points to the directory which contains XQuery files and command scripts, which can be evaluated via the [[REST#GET Requests|REST run operation]]. Relative paths will be resolved against the {{Option|WEBPATH}} directory.
 
|}
 
 
 
===HTTPLOCAL===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|HTTPLOCAL [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|By default, if BaseX is run as [[Web Application]], a database server instance will be started as well. The server can then be addressed by other BaseX clients in parallel to the HTTP services.<br/>If the option is set to {{Code|true}}, the database server will be disabled.
 
|}
 
 
 
===STOPPORT===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|STOPPORT [port]}}
 
|-
 
| '''Default'''
 
|{{Code|8985}}
 
|-
 
| '''Summary'''
 
|This is the port on which the [[Startup#BaseX HTTP Server|HTTP Server]] can be locally closed:
 
* The listener for stopping the web server will only be started if the specified value is greater than {{Code|0}}.
 
* The option is ignored if BaseX is used as a [[Web Application]] or started via [[Web Application#Maven|Maven]].
 
* This option can also be changed when running the HTTP server on [[Command-Line Options#BaseX Server|command line]] via <code>-s</code>.
 
|}
 
 
 
=Create Options=
 
 
 
==General==
 
 
 
===MAINMEM===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|MAINMEM [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If this option is turned on, new databases will be created in main memory:
 
* Most queries will be evaluated faster in main-memory mode, but all data is lost if the BaseX instance in which the database was created is shut down.
 
* It is not possible to store binary resources in a main-memory database.
 
* A main-memory database will have no disk representation. However, it is possible to export the database via the {{Command|EXPORT}} command, and create a new database from the exported file in a second step.
 
* This option will not be available for [[Database Module#db:create|db:create]], because the database would not be accessible anymore after database creation, i. e., outside the query scope.
 
|}
 
 
 
===ADDCACHE===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ADDCACHE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If this option is activated, data structures of documents will first be cached to disk before being added to the final database. This option is helpful when larger documents need to be added, and if the existing heuristics cannot estimate the input size (e.g. when adding directories or sending input streams).
 
|}
 
 
 
==Parsing==
 
 
 
===CREATEFILTER===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|CREATEFILTER [filter]}}
 
|-
 
| '''Default'''
 
|{{Code|*.xml}}
 
|-
 
| '''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.
 
|}
 
 
 
===ADDARCHIVES===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ADDARCHIVES [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|If this option is set to {{Code|true}}, files within archives (ZIP, GZIP, TAR, TGZ, DOCX, etc.) are parsed whenever new databases are created or resources are added to a database.
 
|}
 
 
 
===ARCHIVENAME===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ARCHIVENAME [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If this option is set to {{Code|true}}, the file name of parsed archives will be included in the document paths.
 
|}
 
 
 
===SKIPCORRUPT===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|SKIPCORRUPT [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''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.
 
|}
 
 
 
===ADDRAW===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ADDRAW [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If this option is enabled, all resources that are filtered out by the {{Option|CREATEFILTER}} option while being added to a database will be stored as [[Binary Data|raw files]] instead (i.e., in their binary representation).
 
|}
 
 
 
===PARSER===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|PARSER [type]}}
 
|-
 
| '''Default'''
 
|{{Code|XML}}
 
|-
 
| '''Summary'''
 
|Defines a [[Parsers|parser]] for importing new files to the database. Available parsers are {{Code|XML}}, {{Code|JSON}}, {{Code|CSV}}, {{Code|TEXT}}, and {{Code|HTML}}. HTML will be parsed as normal XML files if [[Parsers#HTML_Parser|Tagsoup]] is not found in the classpath.
 
|}
 
 
 
===CSVPARSER===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|CSVPARSER [options]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Specifies the way how CSV data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[CSV Module#Options|CSV Module]].
 
|-
 
| '''Examples'''
 
|<code>encoding=CP1252,header=true</code> parses the input as CP1252 and the first line as header.
 
|}
 
 
 
===JSONPARSER===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|JSONPARSER [options]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Specifies the way how JSON data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options (except for the additional <code>encoding</code> option) are described in the [[JSON Module#Options|JSON Module]].
 
|-
 
| '''Examples'''
 
|<code>format=jsonml,lax=yes</code> interprets the input as JSONML and uses lax parsing.
 
|}
 
 
 
===HTMLPARSER===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|HTMLPARSER [options]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Specifies the way how HTML data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are described in the [[Parsers#Options|Parsers]] article.
 
|-
 
| '''Examples'''
 
|
 
* <code>encoding=Shift-JIS,nons=true</code> parses the input as Sihft-JIS and suppresses namespaces.
 
* <code>lexical=true</code> preserves comments.
 
|}
 
 
 
===TEXTPARSER===
 
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TEXTPARSER [options]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Specifies the way how TEXT data will be parsed. Keys and values are delimited with <code>=</code>, and multiple options are delimited with <code>,</code>. The available options are listed in the [[Parsers]] article.
 
|-
 
| '''Examples'''
 
|<code>lines=true</code> creates a single element for each line of text.
 
|}
 
 
 
==XML Parsing==
 
 
 
===CHOP===
 
  
{| width='100%'
+
Your are now automatically switched to the ''new-feature'' branch. Now you can make all your changes in one or several commits. You can commit all changes using
|-
 
| width='120' | '''Signature'''
 
|{{Code|CHOP [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Many XML documents include whitespaces that have been added to improve readability. This option controls the [http://www.w3.org/TR/REC-xml/#sec-white-space white-space processing mode] of the XML parser:
 
* With the default value {{Code|true}}, leading and trailing whitespaces from text nodes will be chopped and all empty text nodes will be discarded.
 
* The flag should be turned off if a document contains [[Full-Text#Mixed Content|mixed content]].
 
* The flag can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-w</code>.
 
* If the <code>xml:space="preserve"</code> attribute is attached to an element, chopping will be turned off for all descendant text nodes.
 
  
In the following example document, the whitespaces in the text nodes of the {{Code|text}} element will not be chopped:
+
<pre class="brush:shell">
<pre class="brush:xml">
+
$ git commit -a
<xml>
 
  <title>
 
    Demonstrating the CHOP flag
 
  </title>
 
  <text xml:space="preserve">To <b>be</b>, or not to <b>be</b>, that is the question.</text>
 
</xml>
 
 
</pre>
 
</pre>
It is recommendable to additionally assign <code>indent=no</code> to the {{Option|SERIALIZER}} option; otherwise the serialized documents will automatically be indented.
 
|}
 
 
===STRIPNS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|STRIPNS [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Strips all namespaces from an XML document and all elements while parsing.
 
|}
 
 
===INTPARSE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|INTPARSE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Uses the internal XML parser instead of the standard Java XML parser. Here are some reasons for using the internal parser:
 
* Performance: Documents (in particular small ones) will be parsed faster
 
* Fault tolerance: invalid characters will automatically be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;)
 
* Entities: around 250 HTML entities will be detected and decoded
 
You will be able to correctly parse most XML documents with the internal parser. Java’s Xerces parser is still used as default, however, because it supports all features of the XML standard and advanced DTD features, such as recursive entity expansion.
 
|}
 
 
===DTD===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|DTD [boolean]}}
 
|-
 
| '''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 {{Option|CATFILE}} option can be changed to locally resolve DTDs.
 
|}
 
 
===XINCLUDE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|XINCLUDE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Resolves XInclude inclusion tags and merges referenced XML documents. By default, this option is switched to {{Code|true}}. This option is only available if the standard Java XML Parser is used (see {{Option|INTPARSE}}).
 
|}
 
 
===CATFILE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|CATFILE [path]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Semicolon-separated list of XML catalog files to resolve URIs. See [[Catalog Resolver]]s for more details.
 
|}
 
 
==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.
 
 
===TEXTINDEX===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TEXTINDEX [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Creates a text index whenever a new database is created. A text index speeds up queries with equality comparisons on text nodes. See [[Index#Text Index|Text Index]] for more details.
 
|}
 
 
===ATTRINDEX===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ATTRINDEX [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Creates an attribute index whenever a new database is created. An attribute index speeds up queries with equality comparisons on attribute values. See [[Index#Attribute Index|Attribute Index]] for more details.
 
|}
 
 
===TOKENINDEX===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TOKENINDEX [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Creates a token index whenever a new database is created. A token index speeds up searches for single tokens in attribute values. See [[Index#Token Index|Token Index]] for more details.
 
|}
 
 
===FTINDEX===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|FTINDEX [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Creates a full-text index whenever a new database is created. A full-text index speeds up queries with full-text expressions. See [[Index#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
 
===TEXTINCLUDE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TEXTINCLUDE [names]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
 
===ATTRINCLUDE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ATTRINCLUDE [names]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Defines name patterns for the attributes to be indexed. By default, all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
 
===TOKENINCLUDE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TOKENINCLUDE [names]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Defines name patterns for the attributes to be indexed. By default, tokens in all attribute nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
 
===FTINCLUDE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|FTINCLUDE [names]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Defines name patterns for the parent elements of texts that are indexed. By default, all text nodes will be indexed.<br/>Name patterns are separated by commas. See [[Indexes#Selective Indexing|Selective Indexing]] for more details.
 
|}
 
 
===MAXLEN===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|MAXLEN [int]}}
 
|-
 
| '''Default'''
 
|{{Code|96}}
 
|-
 
| '''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.
 
|}
 
 
===MAXCATS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|MAXCATS [int]}}
 
|-
 
| '''Default'''
 
|{{Code|100}}
 
|-
 
| '''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.
 
|}
 
 
===UPDINDEX===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|UPDINDEX [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If turned on, incremental indexing will be enabled:
 
* The current value of this option will be assigned to new databases. It can be changed for existing databases by running {{Command|OPTIMIZE}} with the {{Code|ALL}} keyword or [[Database_Module#db:optimize|db:optimize($db, true())]].
 
* After each update, the value indexes will be refreshed as well. Incremental updates are currently not available for the full-text index and database statistics.
 
* Find more details in the article on [[Index#Updates|Index Structures]].
 
|}
 
 
===AUTOOPTIMIZE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|AUTOOPTIMIZE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If turned on, auto optimization will be applied to new databases:
 
* With each update, outdated indexes and database statistics will be recreated.
 
* As a result, the index structures will always be up-to-date.
 
* However, updates can take much longer, so this option should only be activated for medium-sized databases.
 
* The value of this option will be assigned once to a new database. It can be reassigned by running {{Command|OPTIMIZE}} or [[Database_Module#db:optimize|db:optimize]].
 
|}
 
 
===SPLITSIZE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|SPLITSIZE [num]}}
 
|-
 
| '''Default'''
 
|{{Code|0}}
 
|-
 
| '''Summary'''
 
|This option affects the [[Indexes#Performance|construction]] of new value indexes. It controls the number of index build operations that are performed before writing partial index data to disk:
 
* The larger the assigned value is, the less splits will take place, and the more main memory will be required.
 
* By default, if the value is set to {{Code|0}}, some heuristics are applied, based on the current memory consumption. Usually, this works fine. If explicit garbage collection is disabled when running Java (e.g. via the JVM option {{Code|-XX:+DisableExplicitGC}}), you may need to choose a custom split size.
 
|}
 
 
==Full-Text Indexing==
 
 
===STEMMING===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|STEMMING [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If {{Code|true}}, all tokens will be stemmed during full-text indexing, using a language-specific stemmer implementation. By default, tokens will not be stemmed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
 
===CASESENS===
 
 
{| width='100%'
 
 
| width='120' | '''Signature'''
 
|{{Code|CASESENS [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If {{Code|true}}, the case of tokens will be preserved during full-text indexing. By default, case will be ignored (all tokens will be indexed in lower case). See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
 
===DIACRITICS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|DIACRITICS [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If set to {{Code|true}}, diacritics will be preserved during full-text indexing. By default, diacritics will be removed. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
 
===LANGUAGE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|LANGUAGE [lang]}}
 
|-
 
| '''Default'''
 
|{{Code|en}}
 
|-
 
| '''Summary'''
 
|The specified language will influence the way how texts will be tokenized and stemmed. It can be the name of a language or a language code. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
 
===STOPWORDS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|STOPWORDS [path]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''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. See [[Indexes#Full-Text Index|Full-Text Index]] for more details.
 
|}
 
 
=Query Options=
 
 
===QUERYINFO===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|QUERYINFO [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Prints more information on internal query rewritings, optimizations, and performance. By default, this info is shown in the [[GUI#Visualizations|Info View]] in the GUI. It can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-V</code>.
 
|}
 
 
===MIXUPDATES===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|MIXUPDATES}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Allows queries to both contain updating and non-updating expressions. All updating constraints will be turned off, and nodes to be returned will be copied before they are modified by an updating expression. By default, in compliance with the XQuery Update Facility, this option is set to {{Code|false}}. See [[XQuery Update#Returning Results|return results]] for more details.
 
|}
 
  
===BINDINGS===
+
Now, you want to push these changes to the repository on GitHub. Remember, that up to now your changes just reside on your local drive, so now you want to push it to your remote fork of BaseX. Simply do:
  
{| width='100%'
+
<pre class="brush:shell">
|-
+
$ git push origin new-feature
| width='120' | '''Signature'''
+
Counting objects: 318, done.
|{{Code|BINDINGS [vars]}}
+
Delta compression using up to 4 threads.
|-
+
Compressing objects: 100% (107/107), done.
| '''Default'''
+
Writing objects: 100% (154/154), 22.96 KiB | 0 bytes/s, done.
|''empty''
+
Total 154 (delta 93), reused 81 (delta 26)
|-
+
To git@github.com:$username/basex.git
| '''Summary'''
+
* [new branch]     new-feature -> new-feature
|Contains external variables to be bound to a query. The string must comply with the following rules:
 
* Variable names and values must be separated by equality signs.
 
* Multiple variables must be delimited by commas.
 
* Commas in values must be duplicated.
 
* Variables may optionally be introduced with a leading dollar sign.
 
* 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].
 
This option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-b</code>.
 
|-
 
| '''Examples'''
 
|
 
* <code>$a=1,$b=2</code> &nbsp; binds the values {{Code|1}} and {{Code|2}} to the variables $a and $b
 
* <code>a=1,,2</code> &nbsp; binds the value {{Code|1,2}} to the variable $a
 
* <code>{URI}a=x</code> &nbsp; binds the value {{Code|x}} to the variable $a with the namespace {{Code|URI}}.
 
* In the following [[Commands#Command_Scripts| Command Script]], the value {{Code|hello world!}} is bound to the variable $GREETING:
 
<pre class="brush:xml">
 
SET BINDINGS GREETING="hello world!"
 
XQUERY declare variable $GREETING external; $GREETING
 
 
</pre>
 
</pre>
|}
 
 
===INLINELIMIT===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|INLINELIMIT}}
 
|-
 
| '''Default'''
 
|{{Code|100}}
 
|-
 
| '''Summary'''
 
|This option controls inlining of XQuery functions:
 
* The XQuery compiler inlines functions to speed up query evaluation.
 
* Inlining will only take place if a function body is not too large (i.e., if it does not contain too many expressions).
 
* With this option, this maximum number of expressions can be specified.
 
* Function inlining can be turned off by setting the value to {{Code|0}}.
 
* The limit can be locally overwritten via the [[XQuery Extensions#Function Inlining|%basex:inline]] annotation (follow the link to get more information on function inlining).
 
|}
 
 
===TAILCALLS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|TAILCALLS}}
 
|-
 
| '''Default'''
 
|{{Code|256}}
 
|-
 
| '''Summary'''
 
|Specifies how many stack frames of [http://en.wikipedia.org/wiki/Tail_call tail-calls] are allowed on the stack at any time. When this limit is reached, tail-call optimization takes place and some call frames are eliminated. The feature can be turned off by setting the value to {{Code|-1}}.
 
|}
 
 
===WITHDB===
 
 
{{Mark|Introduced with Version 9.3.}}
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|WITHDB}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|By default, URIs specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will also be resolved against existing databases. If {{Function|Database|db:open}} is consistently used to access database documents, it is recommendable to disable this option:
 
* Access to local and external resources will be faster, as the database lookup will be skipped.
 
* No locks will be created by the two functions (see [[Transaction Management#Limitations|limitations of database locking]] for more details).
 
|}
 
 
===DEFAULTDB===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|DEFAULTDB}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|If this option is turned on, paths specified in the [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] functions will first be resolved against a database that has been opened in the global context outside the query (e.g. by the {{Command|OPEN}} command). If the path does not match any existing resources, it will be resolved as described in the article on [[Databases#Access Resources|accessing database resources]].
 
|}
 
 
===FORCECREATE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|FORCECREATE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|By activating this option, database instances will be created with the XQuery functions [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]].
 
|}
 
 
===CHECKSTRINGS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|CHECKSTRINGS [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|By default, characters from external sources that are invalid in XML will trigger an error. If the option is set to <code>false</code>, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;). The option affects [[Java Bindings]] and string conversion and input functions such as [[Archive Module#archive:create|archive:create]], [[Archive Module#archive:extract-text|archive:extract-text]], [[Archive Module#archive:update|archive:update]], and [[ZIP Module#zip:text-entry|zip:text-entry]].
 
|}
 
 
===LSERROR===
 
 
{| width='100%'
 
|-
 
| width='120' | '''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.
 
|}
 
 
===RUNQUERY===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|RUNQUERY [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Specifies if a query will be executed or parsed only. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-R</code>.
 
|}
 
 
===RUNS===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|RUNS [num]}}
 
|-
 
| '''Default'''
 
|{{Code|1}}
 
|-
 
| '''Summary'''
 
|Specifies how often a query will be evaluated. The result is serialized only once, and the measured times are averages of all runs. This option can also be changed on [[Command-Line Options#BaseX Standalone|command line]] via <code>-r</code>.
 
|}
 
 
===ENFORCEINDEX===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|ENFORCEINDEX [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Enforces index rewritings in path expressions (see [[Indexes#Enforce Rewritings|Enforce Rewritings]] for details).
 
|}
 
 
===COPYNODE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|COPYNODE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|When creating new nodes in XQuery via [https://www.w3.org/TR/xquery-31/#id-constructors Node Constructors], all enclosed nodes will be copied, and all resulting nodes will get new node identities. This step can be very expensive, and it can be disabled with this option. The option should be used carefully, as it changes the standard behavior of XQuery. It should preferrably be used in [[XQuery Extensions#Database Pragmas|Pragmas]].
 
|}
 
 
=Serialization Options=
 
 
===SERIALIZE===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|SERIALIZE [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''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 {{Code|false}}. It can also be turned off on [[Command-Line Options#BaseX Standalone|command line]] via <code>-z</code>.
 
|}
 
 
===SERIALIZER===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|SERIALIZER [params]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Parameters for [[Serialization|serializing]] query results. The string must comply with the following rules:
 
* Variable names and values must be separated by equality signs.
 
* Multiple variables must be delimited by commas.
 
* Commas in values must be duplicated.
 
The option can also be used on [[Command-Line Options#BaseX Standalone|command line]] with the flag <code>-s</code>.
 
|-
 
| '''Examples'''
 
|
 
* <code>indent=no</code> : disables automatic indentation of XML nodes. This is usually a good choice when working with [[Full-Text#Mixed Content|Mixed-Content Data]].
 
* <code>encoding=US-ASCII,omit-xml-declaration=no</code> : sets the encoding to {{Code|US-ASCII}} and prints the XML declaration.
 
* <code>item-separator=,,</code> : separates serialized items by a single comma.
 
|}
 
 
===EXPORTER===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|EXPORTER [params]}}
 
|-
 
| '''Default'''
 
|''empty''
 
|-
 
| '''Summary'''
 
|Contains parameters for exporting resources of a database and writing files after updates via the {{Option|WRITEBACK}} option. Keys and values are separated by equality signs, multiple parameters are delimited by commas. See [[Serialization]] for more details.
 
|-
 
| '''Examples'''
 
|
 
* <code>indent=no,omit-xml-declaration=no</code> : disables automatic indentation of XML nodes, outputs the XML declaration.
 
|}
 
 
===XMLPLAN===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|XMLPLAN [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Prints the execution plan of an XQuery expression in its XML representation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-x</code>.
 
|}
 
 
===COMPPLAN===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|COMPPLAN [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|true}}
 
|-
 
| '''Summary'''
 
|Generates the query plan, which can be activated via {{Option|XMLPLAN}}, before or after query compilation. This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-X</code>.
 
|}
 
 
===FULLPLAN===
 
 
{{Mark|Introduced with Version 9.2:}}
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|FULLPLAN [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Attaches the file path, line and column of the expressions in the original query string to the query plan. Values (items and sequences) have no input information attached.
 
|}
 
 
=Other Options=
 
 
===AUTOFLUSH===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|AUTOFLUSH [boolean]}}
 
|-
 
| '''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 {{Command|FLUSH}} command.
 
|}
 
 
===WRITEBACK===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|WRITEBACK [boolean]}}
 
|-
 
| '''Default'''
 
|{{Code|false}}
 
|-
 
| '''Summary'''
 
|Propagates updates on main-memory instances of files that have been retrieved via [[Databases#XML Documents|fn:doc]] and [[Databases#XML Documents|fn:collection]] back to disk:
 
* This option can also be activated on [[Command-Line Options#BaseX Standalone|command line]] via <code>-u</code>.
 
* Please take in mind that no backup will be created from your original files.
 
* The serialization options can be controlled via the {{Option|EXPORTER}} option.
 
|}
 
 
===MAXSTAT===
 
 
{| width='100%'
 
|-
 
| width='120' | '''Signature'''
 
|{{Code|MAXSTAT [num]}}
 
|-
 
| '''Default'''
 
|{{Code|30}}
 
|-
 
| '''Summary'''
 
|Specifies the maximum number of index occurrences printed by the {{Command|INFO INDEX}} command.
 
|}
 
 
=Changelog=
 
 
;Version 9.3
 
* Added: {{Option|WITHDB}}
 
 
;Version 9.2
 
* Added: {{Option|RESTXQERRORS}}, {{Option|FULLPLAN}}
 
* Removed: <code>DOTPLAN</code>, <code>DOTCOMPACT</code>
 
 
;Version 9.0
 
* Added: {{Option|ENFORCEINDEX}}, {{Option|COPYNODE}}, {{Option|IGNOREHOSTNAME}}
 
 
;Version 8.6
 
* Added: {{Option|FAIRLOCK}}, {{Option|PARSERESTXQ}}
 
* Removed: {{Code|GLOBALLOCK}} (exclusive use of database lock)
 
* Removed: {{Code|QUERYPATH}} (will now be internally assigned)
 
* Removed: {{Code|CACHERESTXQ}} (replaced with PARSERESTXQ)
 
 
;Version 8.5
 
 
* Added: {{Option|CACHETIMEOUT}}, {{Option|LOGPATH}}
 
* Updated: {{Option|AUTHMETHOD}}: {{Code|custom}} value added.
 
 
;Version 8.4
 
 
* Added: {{Option|TOKENINDEX}}, {{Option|TOKENINCLUDE}}
 
* Added: {{Option|SPLITSIZE}} (replacing <code>INDEXSPLITSIZE</code> and <code>FTINDEXSPLITSIZE</code>)
 
* Removed: <code>INDEXSPLITSIZE</code>, <code>FTINDEXSPLITSIZE</code>
 
 
;Version 8.3
 
 
* Added: {{Option|CACHERESTXQ}}, {{Option|TEXTINCLUDE}}, {{Option|ATTRINCLUDE}}, {{Option|FTINCLUDE}}, {{Option|ARCHIVENAME}}
 
 
;Version 8.2
 
 
* Removed: <code>EVENTPORT</code>, <code>CACHEQUERY</code>
 
 
;Version 8.1
 
 
* Added: {{Option|IGNORECERT}}, {{Option|RESTPATH}}
 
 
;Version 8.0
 
 
* Added: {{Option|MIXUPDATES}}, {{Option|AUTOOPTIMIZE}}, {{Option|AUTHMETHOD}}, {{Option|XINCLUDE}}
 
* Updated: {{Option|PROXYPORT}}: default set to 0; will be ignored. {{Option|PROXYHOST}}, {{Option|NONPROXYHOSTS}}: empty strings will be ignored.
 
 
;Version 7.8.1
 
* Updated: {{Option|ADDARCHIVES}}: parsing of TAR and TGZ files.
 
 
;Version 7.8
 
 
* Added: {{Option|CSVPARSER}}, {{Option|JSONPARSER}}, {{Option|TEXTPARSER}}, {{Option|HTMLPARSER}}, {{Option|INLINELIMIT}}, {{Option|TAILCALLS}}, {{Option|DEFAULTDB}}, {{Option|RUNQUERY}}
 
* Updated: {{Option|WRITEBACK}} only applies to main-memory document instances.
 
* Updated: {{Option|DEBUG}} option can be changed at runtime by users with admin permissions.
 
* Updated: default of {{Option|INTPARSE}} is now {{Code|false}}.
 
* Removed: <code>HTMLOPT</code> (replaced with {{Option|HTMLPARSER}}), <code>PARSEROPT</code> (replaced with parser-specific options), <code>DOTDISPLAY</code>, <code>DOTTY</code>
 
 
;Version 7.7
 
 
* Added: {{Option|ADDCACHE}}, {{Option|CHECKSTRINGS}}, {{Option|FTINDEXSPLITSIZE}}, {{Option|INDEXSPLITSIZE}}
 
 
;Version 7.6
 
 
* Added: {{Option|GLOBALLOCK}}
 
* Added: store local options in configuration file after {{Code|# 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: {{Option|USER}}, {{Option|PASSWORD}}, {{Option|LOG}}, {{Option|LOGMSGMAXLEN}}, {{Option|WEBPATH}}, {{Option|RESTXQPATH}}{{Option|HTTPLOCAL}}, {{Option|CREATEONLY}}, {{Option|STRIPNS}}
 
* Removed: {{Code|HTTPPATH}}; {{Code|HTTPPORT}}: {{Code|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: {{Option|KEEPALIVE}}, {{Option|TIMEOUT}}: default values changed
 
* Removed: {{Code|WILDCARDS}}; new index supports both fuzzy and wildcard queries
 
* Removed: {{Code|SCORING}}; new scoring model will focus on lengths of text nodes and match options
 
  
;Version 7.2
+
You can now use your web browser and go to your fork of BaseX. You will see the following message:
  
* Added: {{Option|PROXYHOST}}, {{Option|PROXYPORT}}, {{Option|NONPROXYHOSTS}}, {{Option|HTMLOPT}}
+
[[File:Git11.png]]
* Updated: {{Option|TIMEOUT}}: ignore timeout for admin users
 
  
;Version 7.1
+
You can now click the "Compare & pull request" button. You can now review the changes you are going to push.  
  
* Added: {{Option|ADDRAW}}, {{Option|MAXLEN}}, {{Option|MAXCATS}}, {{Option|UPDINDEX}}
+
'''Please review them carefully. Also, please give a meaningful comment so we can quickly determine what your changes are doing.''' After clicking the "Create Pull request" button you are done and we will review your changes and either merge the pull request or get back to you.
* Updated: {{Option|BINDINGS}}
 
  
;Version 7.0
+
==Links==
  
* Added: {{Option|SERVERHOST}}, {{Option|KEEPALIVE}}, {{Option|AUTOFLUSH}}, {{Option|QUERYPATH}}
+
* [http://help.github.com/git-installation-redirect/ GitHub: git Installation Guide]
 +
* [http://help.github.com/ Comprehensive Getting Starting Guide on GitHub]
 +
* [http://book.git-scm.com/index.html The git book]
 +
* [http://gitcasts.com/ Gitcasts.com – Video Guides]

Revision as of 18:06, 17 February 2020

This page is part of the Developer Section. It describes how to use git to manage the BaseX sources.

Using Git to contribute to BaseX

Our team uses git and GitHub to manage the source code. All team members have read/write access to the repository, and external contributors are welcome to fork the project.

Git makes it easy to retain a full copy of the repository for yourself. To get started and running, simply fork BaseX:

  1. Head over to https://github.com and create an account
  2. Fork https://github.com/BaseXdb/basex, so you have a version on your own
  3. The forked project can then be cloned on your local machine, and changes can be pushed back to your remote repository

Using Git & Eclipse

Git01.png
Git02.png
Git03.png
Git04.png
Git05.png
Git06.png
Git07.png
Git08.png
Git09.png
Git10.png

Clone

  • In the Package Explorer to the left, use right-click and choose Import...
  • Select Projects from Git and click Next >
  • Choose the Clone option to create a local copy of the remote repository. This copy will include the full project history
  • Copy & Paste the GitHub URI in the Location field. If you want to use SSH, make sure you provided GitHub with your public key to allow write-access. If in doubt, use the https URI and authenticate yourself with your GitHub credentials. The read-only URI of the repository is https://github.com/BaseXdb/basex.git.
  • Select the master branch (or arbitrary branches you like)
  • Now choose a location where the local repository is stored: Create <workspace>/repos/BaseX and click "Finish".

Create the project

  • Select our newly cloned repository and click Next
  • Select "Import Existing Projects" and depending on your Eclipse version enable automatic sharing. More recent versions will not offer this feature as sharing is enabled by default.
  • Click next to select the Project to import
  • Check "basex" to checkout and click finish
  • You are now ready to contribute.

EGit & SSH

The Eclipse git plugin uses the JSch library, which had problems with RSA SSH keys in Linux and possibly other platforms. If the problem persists, the path to the native SSH executable can be assigned to the GIT_SSH variable. According to this change in EGit, the plugin will try to use a native SSH implementation instead of JSch.

Using Git on Command-Line

Note: this is not intended to be a complete git reference; it's purpose is to quickly introduce BaseX developers to the most commonly used git commands in the context of the BaseX project.

Preparation

  1. Create a GitHub user account: here (your github user name will be referenced as $username)
  2. Set up SSH access to GitHub as described here
  3. Create a fork of one of the BaseXdb projects (it will be referenced as $project)
  4. Choose a directory where the project will be created and make it your working directory (e. g. /home/user/myprojects)

Clone Repository

$ git clone git@github.com:$username/$project.git
Cloning into $project...
Enter passphrase for key '/home/user/.ssh/id_rsa': 
...

$ ls -d -1 $PWD/*
/home/user/myprojects/$project

Note that git automatically creates a directory where the repository content will be checked out.

List Remote Repositories

$ git remote -v
origin  git@github.com:$username/$project.git (fetch)
origin  git@github.com:$username/$project.git (push)

Currently, there is only one remote repository; it is automatically registered during the clone operation. Git remembers this repository as the default repository for push/pull operations.

List Local Changes

After some files have been changed locally, the changes can be seen as follows:

$ git diff
diff --git a/readme.txt b/readme.txt
index fabaeaa..cd09568 100644
--- a/readme.txt
+++ b/readme.txt
@@ -49,6 +49,10 @@ ADDING CHECKSTYLE --------------------------------------------------------------
  - Enter the URL: http://eclipse-cs.sourceforge.net/update
  - Follow the installation procedure and restart Eclipse
 
+USING GIT ----------------------------------------------------------------------
 
  Any kind of feedback is welcome; please check out the online documentation at

Commit to Local Repository

Note: this commit operation does not commit into the remote repository!

First, it is needed to select the modified files which should be committed:

$ git add readme.txt

Then perform the actual commit:

$ git commit
[master 0fde1fb] Added TODO in section "USING GIT"
 1 files changed, 4 insertions(+), 0 deletions(-)

Before executing the actual commit, git will open the default shell editor (determined using the $EDITOR variable, usually vi) to enter a message describing the commit changes.

Alternative way is to commit all changed files, i. e. it is not needed to explicitly add the changed files:

$ git commit -a
[master 0fde1fb] Added TODO in section "USING GIT"
 1 files changed, 4 insertions(+), 0 deletions(-)

Pushing Changes to Remote Repository

$ git push
Enter passphrase for key '/home/user/.ssh/id_rsa': 
Everything up-to-date

Pulling Changes from Remote Repository

$ git pull
Enter passphrase for key '/home/user/.ssh/id_rsa': 
Already up-to-date.

Add Upstream Repository

The upstream repository is the one from which the BaseX releases are made and the one from which the personal repository was forked.

$ git remote add upstream git@github.com:BaseXdb/$project.git

$ git remote -v
origin  git@github.com:$username/$project.git (fetch)
origin  git@github.com:$username/$project.git (push)
upstream        git@github.com:BaseXdb/$project.git (fetch)
upstream        git@github.com:BaseXdb/$project.git (push)

Pulling Changes from Upstream to Local Repository

When some changes are made in the upstream repository, they can be pulled to the local repository as follows:

$ git pull upstream master
Enter passphrase for key '/home/user/.ssh/id_rsa': 
From github.com:BaseXdb/$project
 * branch            master     -> FETCH_HEAD
Already up-to-date.

The changes can then be pushed in the personal repository:

$ git push

Check out the links at the end of the page for more git options.

Developing a new feature or bug fix

It is always a good idea to create a new branch for a new feature or a big fix you are working on. So first, let's make sure you have the most up-to-date source code. We assume, that you added BaseX as upstream repository as described above and you are currently in the master branch:

$ git pull upstream master

Now, we create a new branch, based on the master branch

$ git checkout -b new-feature
Switched to a new branch 'new-feature'

Your are now automatically switched to the new-feature branch. Now you can make all your changes in one or several commits. You can commit all changes using

$ git commit -a

Now, you want to push these changes to the repository on GitHub. Remember, that up to now your changes just reside on your local drive, so now you want to push it to your remote fork of BaseX. Simply do:

$ git push origin new-feature
Counting objects: 318, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (107/107), done.
Writing objects: 100% (154/154), 22.96 KiB | 0 bytes/s, done.
Total 154 (delta 93), reused 81 (delta 26)
To git@github.com:$username/basex.git
 * [new branch]      new-feature -> new-feature

You can now use your web browser and go to your fork of BaseX. You will see the following message:

Git11.png

You can now click the "Compare & pull request" button. You can now review the changes you are going to push.

Please review them carefully. Also, please give a meaningful comment so we can quickly determine what your changes are doing. After clicking the "Create Pull request" button you are done and we will review your changes and either merge the pull request or get back to you.

Links