Difference between revisions of "Main Page"

From BaseX Documentation
Jump to navigation Jump to search
 
(355 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<div class="subcolumns">
+
<div style="float:left;">
<div class="c50l">
+
[[Image:BaseX-Screenshot.png|thumb|240px|BaseX, Graphical User Interface]]
=Getting Started Guide=
 
==Quick Start==
 
*[[BaseX Database Server]]: Starting a BaseX Database Server
 
*[[BaseX GUI]]: Starting the graphical user interface to work on local databases
 
*[[BaseX Standalone Console]] Starting the BaseX console to work on local databases
 
  
==Good to know==
+
'''NOTE:''' This is the documentation for '''[[BaseX 10]]'''. The documentation for BaseX 11 beta is currently located at https://help.basex.org.
*[[Database & Collection]]: Basic knowledge about the terms database and collection in BaseX
 
*[[Commands]]: Commands for managing BaseX and the databases
 
**[[Settings]]: Overview of all settable options
 
  
=Advanced Users Guide=
+
[https://basex.org/ BaseX] is a light-weight, high-performance and scalable XML Database and an XQuery 3.1 Processor with full support for the W3C Update and Full-Text extensions. It allows you to store, query and process large corpora of textual (XML, HTML, JSON, CSV, others) and binary data. The GUI provides an XQuery editor for writing complex applications and provides various visualizations to interactively explore data. RESTXQ enables Web Application development in XQuery. BaseX is platform-independent BSD-licensed (find more on [https://en.wikipedia.org/wiki/BaseX Wikipedia]).
 
 
==BaseX Database Server==
 
 
 
*[[Introduction]]: Introduction into the BaseX Database Server
 
*[[User management]]: User management in the client/server environment
 
*[[Transactionmanagement]]: Description of the transactionmanagement
 
*[[Logging]]: Description of the server logs
 
 
 
==BaseX GUI==
 
*[[GUI Introduction|Introduction]]: Overall information for the BaseX GUI
 
*[[Views]]: Description of the different visualizations
 
*[[Options and Settings]]: Description of the available options in the GUI
 
 
 
=Tutorials=
 
 
 
==BaseX intern==
 
*[[BaseX & Collections]]: Work with Collections in BaseX
 
*[[Backup & Restore in BaseX]]: Create a backup and restore it within BaseX
 
 
 
==BaseX from extern==
 
*[[BaseX & oXygen XML Editor]]; Use BaseX within the oXygen XML Editor
 
*[[BaseX & DOM in PHP]]: Connect to a BaseX Database Server with PHP
 
*[[BaseX & REST]]: Connect to a BaseX Database Server with REST
 
  
 +
If you have questions, or if you want to get into direct contact with the developer team and users of BaseX, please write to our [https://basex.org/open-source/ mailing lists]. Many questions are being discussed at [https://stackoverflow.com/questions/tagged/basex StackOverflow]; confirmed bugs and feature requests are discussed on [https://github.com/basexdb/basex/issues GitHub].
 
</div>
 
</div>
<div class="c50r">
 
=XQuery=
 
  
==Extensions==
+
<div style="float:left; width:48%;">
* [[Full Text]]: full text features of XQuery
+
=[[Getting Started]]=
* [[Update]]: update mechanism of XQuery
 
* [[Java Bindings]]: calling of Java methods from XQuery
 
  
==Functions==
+
The getting started section gives you a quick introduction to BaseX. We suggest that you start with the [[Graphical User Interface]] as this is the easiest way to access your XML data, and to get an idea of how XQuery and BaseX works.
* [[Database]]: Database-related functions
 
* [[Utility]]: Testing and profiling functions
 
* [[Math]]: functions for mathematical operations
 
* [[File]]: functions for file handling, inspired by [http://expath.org/spec/file EXPath]
 
  
==Indexes==
+
=[[XQuery|XQuery Portal]]=
*[[Overview]]: All indexes and their functionality
 
  
==Query Processor==
+
More information on using the wide range of XQuery functions and performing XPath and XQuery requests with BaseX can be found in our XQuery Portal.
*[[Analysis & Optimization]]: Queries will be analyzed and optimized on the fly.
+
</div><div style="float:left; width:4%;">&nbsp;
*[[Execution Plan]]: Execution plans of the queries.
+
</div><div style="float:left; width:48%;">
  
=Developer's Guide=
+
=[[Developing|Developer Section]]=
  
==Requirements==
+
The developer section provides useful information for developers. Here you can find information on our supported client APIs and HTTP services, and we present different ways how you can integrate BaseX into your project.
*[[Subversion Repository]]: Checkout the projects
 
*[[Integrate]]: Integrate BaseX into your IDE
 
  
==Examples==
+
=[[Advanced User's Guide]]=
*[[Coding examples]]: Examples for developing with the BaseX code base in Java
 
 
 
==JavaDoc==
 
 
 
see the Javadocs [http://www.inf.uni-konstanz.de/dbis/basex/javadoc/ here...]
 
 
 
==Client Interfaces==
 
*[[Language bindings]]: Communicate with the BaseX server using the different language bindings
 
*[[REST Interface]]: Communicate with the BaseX server using the REST interface
 
  
 +
Information for advanced users can be found in our advanced user's guide, which contains details on the BaseX storage, the Client/Server architecture, and some querying features.
 
</div>
 
</div>
</div>
 
=FAQ=
 
 
see the FAQ [[FAQ|here...]]
 
 
__NOTOC__
 
__NOTOC__

Latest revision as of 10:16, 1 March 2024

BaseX, Graphical User Interface

NOTE: This is the documentation for BaseX 10. The documentation for BaseX 11 beta is currently located at https://help.basex.org.

BaseX is a light-weight, high-performance and scalable XML Database and an XQuery 3.1 Processor with full support for the W3C Update and Full-Text extensions. It allows you to store, query and process large corpora of textual (XML, HTML, JSON, CSV, others) and binary data. The GUI provides an XQuery editor for writing complex applications and provides various visualizations to interactively explore data. RESTXQ enables Web Application development in XQuery. BaseX is platform-independent BSD-licensed (find more on Wikipedia).

If you have questions, or if you want to get into direct contact with the developer team and users of BaseX, please write to our mailing lists. Many questions are being discussed at StackOverflow; confirmed bugs and feature requests are discussed on GitHub.

Getting Started[edit]

The getting started section gives you a quick introduction to BaseX. We suggest that you start with the Graphical User Interface as this is the easiest way to access your XML data, and to get an idea of how XQuery and BaseX works.

XQuery Portal[edit]

More information on using the wide range of XQuery functions and performing XPath and XQuery requests with BaseX can be found in our XQuery Portal.

 

Developer Section[edit]

The developer section provides useful information for developers. Here you can find information on our supported client APIs and HTTP services, and we present different ways how you can integrate BaseX into your project.

Advanced User's Guide[edit]

Information for advanced users can be found in our advanced user's guide, which contains details on the BaseX storage, the Client/Server architecture, and some querying features.