Difference between revisions of "Clients"

From BaseX Documentation
Jump to navigation Jump to search
Line 16: 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)  
 
   
 
   
Most of the interfaces contain at least the following four files:
+
Most of the interfaces contain at least the following six 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.
 
# <code>QueryExample</code> shows you how to evaluate queries in an iterative manner.
 
# <code>QueryExample</code> shows you how to evaluate queries in an iterative manner.
 
# <code>QueryBindExample</code> shows you how to bind a variable to your query and evaluates the query in an iterative manner.
 
# <code>QueryBindExample</code> shows you how to bind a variable to your query and evaluates the query in an iterative manner.
 
If the interface supports additional features the following files are available:
 
 
# <code>CreateExample</code> shows how new databases can be created by using streams.
 
# <code>CreateExample</code> shows how new databases can be created by using streams.
 
# <code>AddExample</code> shows how documents can be added to a database by using streams.
 
# <code>AddExample</code> shows how documents can be added to a database by using streams.
 +
 +
The interfaces Java and C# also support the event feature:
 
# <code>EventExample</code> demonstrates how to use the event feature.
 
# <code>EventExample</code> demonstrates how to use the event feature.
 
   
 
   

Revision as of 12:30, 26 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 six 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.
  5. CreateExample shows how new databases can be created by using streams.
  6. AddExample shows how documents can be added to a database by using streams.

The interfaces Java and C# also support the event feature:

  1. EventExample demonstrates how to use the event feature.

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