Difference between revisions of "Clients"

From BaseX Documentation
Jump to navigation Jump to search
Line 1: Line 1:
BaseX provides bindings in several programming languages. With these bindings, you will be able
+
BaseX provides clients in several programming languages. With these light-weight bindings,
to create a client in different programming languages and connect to a running BaseX server instance.
+
you will be able to connect to a running BaseX server instance, execute all database
Using the client, you can execute all database commands and queries on the server and receive the
+
commands and perform queries.
corresponding results:
 
 
   
 
   
 
* [[Standard Mode]]: Description of the usage of the standard mode.  
 
* [[Standard Mode]]: Description of the usage of the standard mode.  
Line 17: Line 16:
 
: [https://github.com/BaseXdb/basex-api/tree/master/src/main/haskell Haskell] (thanks to Leo Wörteler)  
 
: [https://github.com/BaseXdb/basex-api/tree/master/src/main/haskell Haskell] (thanks to Leo Wörteler)  
 
   
 
   
For most interfaces, you will find four files:
+
Most of the interfaces contain at least the following four files:
 
# <code>BaseXClient</code> contains the actual code for creating a session, sending and executing commands and receiving results. Furthermore there is an inner class called <code>query</code> which offers the evaluation of queries in an iterative manner.  
 
# <code>BaseXClient</code> contains the actual code for creating a session, sending and executing commands and receiving results. Furthermore there is an inner class called <code>query</code> which offers the evaluation of queries in an iterative manner.  
 
# <code>Example</code> demonstrates how to send database commands.
 
# <code>Example</code> demonstrates how to send database commands.

Revision as of 11:26, 25 June 2011

BaseX provides clients in several programming languages. With these light-weight bindings, you will be able to connect to a running BaseX server instance, execute all database commands and perform queries.

  • Standard Mode: Description of the usage of the standard mode.
  • Query Mode: Description of the usage of the query mode.

Currently, we offer bindings for the following programming languages (bindings in other languages are welcome!):

Object oriented
C#, VB, Java
Scripting
PHP, Python, Perl, Ruby
Rebol (thanks to Sabu Francis)
Functional
Lisp (thanks to Andy Chambers)
Haskell (thanks to Leo Wörteler)

Most of the interfaces contain at least the following four files:

  1. BaseXClient contains the actual code for creating a session, sending and executing commands and receiving results. Furthermore there is an inner class called query which offers the evaluation of queries in an iterative manner.
  2. Example demonstrates how to send database commands.
  3. QueryExample shows you how to evaluate queries in an iterative manner.
  4. QueryBindExample shows you how to bind a variable to your query and evaluates the query in an iterative manner.

Please check out readme.txt for more background information on the client/server communication.