Changes

Jump to navigation Jump to search
3,823 bytes removed ,  12:31, 22 June 2022
This article is part of the [[Getting Started]] Guide. It tells you how to get BaseX running.
=Getting StartedIntroduction=
First of allBaseX is very light-weight. It can be run and used in many different ways: # BaseX comes with a [[GUI|Graphical User Interface]] that offers you marvelous tools for managing, querying and visualizing your data and write complex applications in XQuery.# You can start BaseX as [http://basex[Command-Line Client]] if you prefer to work on command-line line and want to do batch processing.org/download download# The [[Database Server] ] is the right choice if you have multiple users or clients, if you don’t require HTTP services, and if you tend to communicate with BaseX from our homepageon a technical level.# The following distributions are available:[[Web Application|HTTP Server]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]], complex web applications can be built, and the embedded [[DBA]] application allows you to work with BaseX in the browser. BaseX can also be embedded as a library in your own applications.
* the '''Core Package''' is a JAR file, which contains the database system, the query processor and the GUI frontend. It is runs completely without additional libraries.* the '''ZIP Archive''' and the '''Windows Installer''' contain libraries for web applications and advanced features, [[Start Scripts]], and some additional optional files.* the '''WAR Archive''' can be embedded in existing Java web servers.==Concurrent Operations==
Some additional distributions are available from If you want to perform parallel (concurrent) read and write operations on your databases, you must use the download pageclient/server architecture or run BaseX as a web application. You can safely open a database in different JVMs (Java virtual machines) for read-only access,most of which contain only and you will not encounter any problems when reading from and writing to different databases. Update operations from different JVMs to the core package and, optionally, scripts for starting BaseXsame database will be rejected or may even lead to corrupt databases.
BaseX is very light-weight. It For example, if you only read data, you can be easily run and used several clients (standalone, GUI, database clients) in various ways:parallel. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time.
* as standalone application, using More details on concurrency can be found on the [[#Standalone|StandaloneTransaction Management]] mode or the [[#Graphical User Interface|Graphical User Interface]],* as [[#Client/Server|Client/Server]] application, or* as [[#HTTP Server|Web Application]], called from a web serverpage.
It can also be embedded as a library in your own application.=Startup=
===Requirements===First, [https://basex.org/download get a fresh copy of BaseX] from our homepage.
BaseX is platform-independent and runs on any system that provides an implementation of the [httphttps://www.java.com Java Runtime Environment (JRE)]:
* Since <b>Version 9</b> of BaseX, Java 8 is required.
* Since <b>Version 8</b>, works with Java 7 is required.
* Older versions are based on Java 6.
BaseX has been tested on several numerous platforms, including Windows (2000, XP, Vista, 7, 10, 11), Max Mac OS X (10.x , 11.x),Linux (SuSE xxx, Debian, Redhat, CentOS, Ubuntu) and OpenBSD (4up to 7.x).
===Concurrent Operations=== If you want to perform parallel (concurrent) read and write operations on your databases, you must use the client/server architecture or deploy BaseX as web application. You can safely open a database in different JVMs (Java virtual machines) for read-only access, and you will not encounter any problems when reading from and writing to different databases, but update operations from different JVMs to the same database will be rejected or may even lead to corrupt databases. For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) at the same time. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time. More details on concurrency are found in the [[Transaction Management]] article. =Standalone= The [[Standalone Mode]] can be used to execute XQuery expressions or run database commands on command line. It can also be used both for scripting and batch processing your XML data. It can be started as follows (get more information on all [[Command-Line Options#Standalone|Startup Options]]): * Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basex]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basex.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseX}}* On ''Windows'': Double click on the '''BaseX''' icon. It is important to remember that the standalone mode does ''not'' interact with the [[#Client/Server|Client/Server]] architecture. =Graphical User Interface= The [[GUI]] is the visual interface to the features of BaseX.It can be used to create new databases, perform queries or interactivelyexplore your XML data. It can be started as follows (get more information on all [[Command-Line Options#GUI|Startup Options]]): * Double click on the {{Code|BaseX.jar}} file.* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexgui]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexgui.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXGUI}}* On ''Windows'': Double click on the '''BaseX GUI''' icon.* For [[Maven]] users: type in {{Code|mvn exec:java}} in the main directory of the {{Code|basex}} project. Note that the GUI does ''not'' interact with the client/server architecture. =Client/Server= ==Server== The [[Database Server]] comes into play if BaseX is to be used bymore than one user (client). It handles concurrent [[Transaction_Management|read and write transactions]],provides [[User Management|user management]] and [[Logging|logs all user interactions]]. By default, the server listens to the port {{Code|1984}}.There distributions are several ways of starting and stopping the server(get more information on all [[Command-Line Options#Server|Startup Options]])available* Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexserver]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexserver.bat]]}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXServer}}. Again, the {{Code|stop}} keyword will ensure a graceful shutdown.* On ''Windows'': Double click on the '''BaseX Server''' icon, which will also start the [[#HTTP Server|HTTP Server]], or the '''BaseX Server (stop)''' icon. Pressing {{Code|Ctrl+c}} will close all connections and databases and shut down the server process. ==Client== The [[Database Server|BaseX Client]] interface can be used to sendcommands and queries to the server instance on command line. It can be started as follows(get more information on all [[Command-Line Options#Client|Startup Options]]): * Run one of the {{Code|[[Start_Scripts#Linux.2FMac:_basex|basexclient]]}} or {{Code|[[Start Scripts#Windows: basex.bat|basexclient.bat]]}} scripts.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}* On ''Windows'': Double click on the '''BaseX Client''' icon. The default {{Code|admin}} user can be used to connect to the server: <br/>* <b>Username:</b> {{Code|admin}}* <b>Password:</b> {{Code|admin}}The password should be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command after the first login.<br/> We provide additional clients in various [[Clients|programming languages]].
=HTTP Server=Core Package==
With The '''Core Package''' is a very compact JAR file. It contains the HTTP ServerBaseX database management system, BaseX can be used to build [[Web Application]]s.It provides access to the [[REST]]XQuery processor, [[RESTXQ]] and [[WebDAV]] services.An instance of the [http:client//jetty.codehaus.org/jetty/ Jetty Web Server] will be createdserver architecture,which by default listens to and the port {{Code|8984}}graphical user interface. Additionally, the BaseX Server willbe started, which is accessible on port {{Code|1984}}It runs without additional libraries.
It can be started as follows (get more information on all [[Command-Line Options#HTTP Server|Startup Options]]):==Full Distributions==
* Run one of In addition, the {{Code|[[Start_Scripts#Linux.2FMac:_basexhttp|basexhttp]]}} or {{Code|[[Start Scripts#Windows: basexhttp.bat|basexhttp.bat]]}} scripts. Call the script with the {{Code|stop}} keyword to gracefully shut down the server.* On ''Windows'ZIP Package': Double click on the ''and the 'BaseX Server''Windows Installer' or ''contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and BaseX'BaseX Server s browser-based database administration interface (stop)''' icon.* BaseX can also be deployed as [[Web Application#Servlet Container|web servletDBA]]).
In the first two casesAfter BaseX has been unzipped or installed, the command-line output following directories will look similar to the following lines (the JSP warning message [http://stackoverflow.com/questions/3521654/missing-jsp-support-in-jetty-or-confusing-log-message can be ignored])available:
<pre class="brush* {{Code|bin/}}:xml">Start scripts (Windows, Linux).* {{Code|data/}}: Database directory. See [main[Configuration]] INFO org.eclipse.jetty.server.Server - jetty-8.1for more details.18.v20150929* {{Code|etc/}}: Example data: XML sample, [main[Catalog Resolver|catalog and DTD files]] INFO org.eclipse* {{Code|lib/}}: Extra libraries (Jetty, Tagsoup, …).jetty.webapp.StandardDescriptorProcessor - NO JSP Support for * {{Code|lib/custom/}}: Directory, did not find orgin which additional JAR files can be placed (such as the Saxon library).apache.jasper.servlet.JspServlet* {{Code|repo/}}: [[mainRepository] INFO org] for external XQuery modules (the [http://www.eclipsexqueryfunctions.jetty.server.AbstractConnector - Started SelectChannelConnector@0.0.0com FunctX] library is included as example).0:8984HTTP Server was started (port* {{Code|src/}}: 8984)Directory for your XQuery scripts and other source data.<* {{Code|webapp/pre>}}: [[Web Application]] directory: home of the RESTXQ web application, REST scripts, and [[DBA]].
You can adjust If BaseX is started via the Jetty logging level by adding start scripts or the following properties Windows icons, all JAR files in the {{Code|lib}} directory and its descendant directories will be added to the start script:class path.
<pre class="brush:xml">-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -DIf you work with the ZIP distribution, and if you want to make BaseX globally available, you can add the {{classrefCode|bin}}directory to your PATH environment variable.LEVEL=DEBUG</pre>
After that, you can e. g. open your browser and navigate to the RESTXQ start page http://localhost:8984.==Web Archive==
==Database Administration==The '''WAR Archive''' can be embedded in existing Java web servers.
The [[DBA]] is a web-based database administration interface. It allows you to create and administrate databases, evaluate queries in realtime, view log files, manage users, etc.==Other Distributions==
It can be accessed via http://localhost:8984/dba/Various other distributions are available from the download page, most of which contain only the core package and, optionally, scripts for starting BaseX.
=Changelog=
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu