Changes

Jump to navigation Jump to search
4,923 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=
BaseX is very light-weight. It can be run and used in various many different ways:
* as standalone application, using the [[#Standalone|Standalone]] mode or the BaseX comes with a [[#Graphical User InterfaceGUI|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 [[Command-Line Client]] if you prefer to work on command-line line and want to do batch processing.#Client/Server|Client/The [[Database Server]] applicationis the right choice if you have multiple users or clients, if you don’t require HTTP services, orand if you tend to communicate with BaseX on a technical level.* as # The [[#Web Application|HTTP Server|Web Application]] provides [[REST]] and [[WebDAV]] services. With [[RESTXQ]], called from a complex web serverapplications can be built, and the embedded [[DBA]] application allows you to work with BaseX in the browser.
It BaseX can also be embedded as a library in your own applicationapplications.
First of all, [http://basex.org/download download] BaseX from our homepage.The following distributions are available: ==DistributionsConcurrent Operations== ===Core Package=== The '''Core Package''' is a small JAR file. It contains the database system, the XQuery processor and the graphical user interface. It does not require any additional libraries. ===Full Distributions=== The '''ZIP Package''' and the '''Windows Installer''' contain the BaseX core library and extra libraries for web applications and advanced features, [[Start Scripts]], and some additional optional files. After BaseX has been unzipped or installed, the following directories will be available: * {{Code|bin/}}: Start scripts (Windows, Linux).* {{Code|data/}}: Database directory. See [[Configuration]] for more details.* {{Code|etc/}}: Example data: XML sample, [[Catalog Resolver|catalog and DTD files]].* {{Code|lib/}}: Extra libraries (Jetty, Tagsoup, …), which will be added to the class path by the start scripts.* {{Code|lib/custom/}}: Directory for additional JAR files (such as the Saxon library).* {{Code|repo/}}: [[Repository]] (the [http://www.xqueryfunctions.com FunctX] library is included as example).* {{Code|src/}}: Directory for your XQuery scripts and other source data.* {{Code|webapp/}}: [[Web Application]] directory: RESTXQ web application, REST scripts, [[DBA]].
If you work with want to perform parallel (concurrent) read and write operations on your databases, you must use the ZIP distributionclient/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, and if you want will not encounter any problems when reading from and writing to different databases. Update operations from different JVMs to make BaseX globally available, you can add the {{Code|bin}} directory same database will be rejected or may even lead to your PATH environment variablecorrupt databases.
===Web Archive===For example, if you only read data, you can easily run several clients (standalone, GUI, database clients) in parallel. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same time.
The '''WAR Archive''' More details on concurrency can be embedded in existing Java web serversfound on the [[Transaction Management]] page.
===Other Distributions==Startup=
Various other distributions are available from the First, [https://basex.org/download page, most get a fresh copy of which contain only the core package and, optionally, scripts for starting BaseX] from our homepage.
==Requirements== 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==The following distributions are available:
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.==Core Package==
For exampleThe '''Core Package''' is a very compact JAR file. It contains the BaseX database management system, if you only read datathe XQuery processor, you can easily run several clients (standalonethe client/server architecture, GUI, database clients) at and the same timegraphical user interface. If you update your data, however, you shouldn’t use the GUI or a standalone instance at the same timeIt runs without additional libraries.
More details on concurrency are found in the [[Transaction Management]] article.==Full Distributions==
=Standalone=In addition, the '''ZIP Package''' and the '''Windows Installer''' contain extra libraries for RESTXQ web applications and other advanced features, [[Start Scripts]], and BaseX's browser-based database administration interface ([[DBA]]).
The [[Standalone Mode]] can be used to execute XQuery expressions After BaseX has been unzipped or run database commands on command line. It can also be used both for scripting and batch processing your XML data. It can installed, the following directories will be started as follows (get more information on all [[Command-Line Options#Standalone|Startup Options]])available:
* Run one of the {{Code|bin/}}: Start scripts (Windows, Linux).* {{Code|data/}}: Database directory. See [[Start_Scripts#LinuxConfiguration]] for more details.2FMac* {{Code|etc/}}:_basexExample data: XML sample, [[Catalog Resolver|basexcatalog and DTD files]].* {{Code|lib/}}: Extra libraries (Jetty, Tagsoup, …).* {{Code|lib/custom/}} or : Directory, in which additional JAR files can be placed (such as the Saxon library).* {{Code|repo/}}: [[Repository]] for external XQuery modules (the [Start Scripts#Windowshttp: basex//www.bat|basexxqueryfunctions.bat]com FunctX]library is included as example).* {{Code|src/}} : Directory for your XQuery scriptsand other source data.* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXwebapp/}}* On ''Windows'': Double click on [[Web Application]] directory: home of the '''BaseX''' iconRESTXQ web application, REST scripts, and [[DBA]].
It If BaseX is important to remember that started via the start scripts or the standalone mode does ''not'' interact with Windows icons, all JAR files in the [[#Client/Server{{Code|Client/Server]] architecturelib}} directory and its descendant directories will be added to the class path.
=Graphical User Interface=If you work with the ZIP distribution, and if you want to make BaseX globally available, you can add the {{Code|bin}} directory to your PATH environment variable.
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.==Web Archive==
It The '''WAR Archive''' can be started as follows (get more information on all [[Command-Line Options#GUI|Startup Options]]):embedded in existing Java web servers.
* 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.==Other Distributions==
Note that Various other distributions are available from 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]]download page,provides [[User Management|user management]] and [[Logging|logs all user interactions]]. By default, the server listens to the port {{Code|1984}}.There are several ways of starting and stopping the server(get more information on all [[Command-Line Options#Server|Startup Options]]): * Run one most 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= With the HTTP Server, BaseX can be used to build [[Web Application]]s.It provides access to contain only the [[REST]], [[RESTXQ]] core package and [[WebDAV]] services.An instance of the [http://jetty.codehaus.org/jetty/ Jetty Web Server] will be created,which by default listens to the port {{Code|8984}}. Additionally, the BaseX Server willbe startedoptionally, which is accessible on port {{Code|1984}}. It can be started as follows (get more information on all [[Command-Line Options#HTTP Server|Startup Options]]): * Run one of 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'': Double click on the '''for starting BaseX Server''' or '''BaseX Server (stop)''' icon.* BaseX can also be deployed as [[Web Application#Servlet Container|web servlet]]. In the first two cases, the command-line output 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]): <pre class="brush:xml">[main] INFO org.eclipse.jetty.server.Server - jetty-8.1.18.v20150929[main] INFO org.eclipse.jetty.webapp.StandardDescriptorProcessor - NO JSP Support for /, did not find org.apache.jasper.servlet.JspServlet[main] INFO org.eclipse.jetty.server.AbstractConnector - Started SelectChannelConnector@0.0.0.0:8984HTTP Server was started (port: 8984).</pre> You can adjust the Jetty logging level by adding the following properties to the start script: <pre class="brush:xml">-Dorg.eclipse.jetty.util.log.class=org.eclipse.jetty.util.log.StdErrLog -D{classref}.LEVEL=DEBUG</pre> After that, you can e. g. open your browser and navigate to the RESTXQ start page http://localhost:8984. ==Database Administration== 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. It can be accessed via http://localhost:8984/dba/.
=Changelog=
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu