Difference between revisions of "Clients"

From BaseX Documentation
Jump to navigation Jump to search
Line 5: Line 5:
 
   
 
   
 
Please see following links for more information:  
 
Please see following links for more information:  
* [[Languages]]: List of offered programming languages.
 
 
* [[Standard Mode]]: Description of the usage of the standard mode.  
 
* [[Standard Mode]]: Description of the usage of the standard mode.  
 
* [[Query Mode]]: Description of the usage of the query mode.
 
* [[Query Mode]]: Description of the usage of the query mode.
 +
 +
Currently, we offer [[Language Bindings|bindings]] for the following languages:
 +
; Object oriented:
 +
: [https://github.com/BaseXdb/basex-api/tree/master/etc/c%23 C#], [https://github.com/BaseXdb/basex-api/tree/master/etc/vb VB], [https://github.com/BaseXdb/basex-api/tree/master/etc/java Java] 
 +
; Scripting
 +
: [https://github.com/BaseXdb/basex-api/tree/master/etc/php PHP], [https://github.com/BaseXdb/basex-api/tree/master/etc/python Python], [https://github.com/BaseXdb/basex-api/tree/master/etc/perl Perl], [https://github.com/BaseXdb/basex-api/tree/master/etc/ruby Ruby], [https://github.com/BaseXdb/basex-api/tree/master/etc/rebol Rebol] (thanks to Sabu Francis)
 +
; Functional:
 +
: [https://github.com/BaseXdb/basex-api/tree/master/etc/lisp Lisp] (thanks to Andy Chambers), [https://github.com/BaseXdb/basex-api/tree/master/etc/haskell Haskell] (thanks to Leo Wörteler)
 +
 +
For most interfaces, you will find 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>Example</code> demonstrates how to send database commands.
 +
# <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.
 +
 +
Please check out [https://github.com/BaseXdb/basex-api/blob/master/etc/readme.txt readme.txt]
 +
for common information on all interfaces. &ndash;
 +
We will be glad to receive your own bindings.
 +
 
[[Category:Developer]]
 
[[Category:Developer]]
 
[[Category:Server]]
 
[[Category:Server]]
 
[[Category:Bindings]]
 
[[Category:Bindings]]

Revision as of 12:38, 31 March 2011

BaseX provides bindings in several programming languages. With these bindings, you will be able to create a client in different programming languages and connect to a running BaseX server instance. Using the client, you can execute all database commands and queries on the server and receive the corresponding results.

Please see following links for more information:

  • 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 languages:

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)

For most interfaces, you will find 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 common information on all interfaces. – We will be glad to receive your own bindings.