Difference between revisions of "Clients"

From BaseX Documentation
Jump to navigation Jump to search
Line 23: Line 23:
 
* [https://github.com/JohnLeM/BasexCPPAPI/ C++]: contributed by Jean-Marc Mercier
 
* [https://github.com/JohnLeM/BasexCPPAPI/ C++]: contributed by Jean-Marc Mercier
 
* [https://github.com/apb2006/basex-node node.js]: contributed by Andy Bunce
 
* [https://github.com/apb2006/basex-node node.js]: contributed by Andy Bunce
−
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/perl Perl]
+
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/perl Perl], contributed by the BaseX Team
 
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/php PHP]: updated by James Ball
 
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/php PHP]: updated by James Ball
 
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/python3 Python 3.x, 2.7.3]: contributed by Hiroaki Itoh
 
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/python3 Python 3.x, 2.7.3]: contributed by Hiroaki Itoh
 
* [https://github.com/lucalianas/pyBaseX Python], using BaseX REST services: contributed by Luca Lianas
 
* [https://github.com/lucalianas/pyBaseX Python], using BaseX REST services: contributed by Luca Lianas
−
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/ruby Ruby]
+
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/ruby Ruby], contributed by the BaseX Team
  
 
...more to come (your contributions are welcome!)
 
...more to come (your contributions are welcome!)
Line 33: Line 33:
 
     <td>'''BaseX 7.x''' (outdated)
 
     <td>'''BaseX 7.x''' (outdated)
 
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/as ActionScript]: contributed by Manfred Knobloch
 
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/as ActionScript]: contributed by Manfred Knobloch
−
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/c C]
+
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/c C], contributed by the BaseX Team
−
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/c%23 C#]
+
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/c%23 C#], contributed by the BaseX Team
 
* [https://github.com/programaths/go-basex Golang]: contributed by Christian Baune
 
* [https://github.com/programaths/go-basex Golang]: contributed by Christian Baune
 
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/haskell Haskell]: contributed by Leo W&ouml;rteler
 
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/haskell Haskell]: contributed by Leo W&ouml;rteler
Line 44: Line 44:
 
* [https://github.com/delving/basex-scala-client Scala]: contributed by Manuel Bernhardt
 
* [https://github.com/delving/basex-scala-client Scala]: contributed by Manuel Bernhardt
 
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/scala Scala] (simple implementation)
 
* [https://github.com/BaseXdb/basex/tree/7.9/basex-api/src/main/scala Scala] (simple implementation)
−
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/vb VB]
+
* [https://github.com/BaseXdb/basex/tree/master/basex-api/src/main/vb VB], contributed by the BaseX Team
 
     </td>
 
     </td>
 
   </tr>
 
   </tr>

Revision as of 23:07, 4 February 2015

This page is part of the Developer Section. It describes how to communicate with BaseX with other programming languages.

Template:Mark, we have switched from cram-md5 to digest authentication. If a language binding does not work anymore, it will need to be slightly updated. Please have a look at our Server Protocol for more information on the exchanged bytes. Your contributions are welcome!

You can use the following light-weight language bindings to connect to a running BaseX server instance, execute database commands, perform queries, or listen to events.

Most clients provide two modes:

  • Standard Mode: connecting to a server, sending commands
  • Query Mode: defining queries, binding variables, iterative evaluation

Currently, we offer bindings for the following programming languages:

BaseX 7.x, BaseX 8.x and later
  • Java: The default implementation
  • C++: contributed by Jean-Marc Mercier
  • node.js: contributed by Andy Bunce
  • Perl, contributed by the BaseX Team
  • PHP: updated by James Ball
  • Python 3.x, 2.7.3: contributed by Hiroaki Itoh
  • Python, using BaseX REST services: contributed by Luca Lianas
  • Ruby, contributed by the BaseX Team

...more to come (your contributions are welcome!)

BaseX 7.x (outdated)
  • ActionScript: contributed by Manfred Knobloch
  • C, contributed by the BaseX Team
  • C#, contributed by the BaseX Team
  • Golang: contributed by Christian Baune
  • Haskell: contributed by Leo Wörteler
  • Lisp: contributed by Andy Chambers
  • node.js: contributed by Hans Hübner (deviating from client API)
  • Python < 2.7: improved by Arjen van Elteren
  • Qt: contributed by Hendrik Strobelt
  • Rebol: contributed by Sabu Francis
  • Scala: contributed by Manuel Bernhardt
  • Scala (simple implementation)
  • VB, contributed by the BaseX Team

Many of the interfaces contain the following files:

  • BaseXClient contains the code for creating a session, sending and executing commands and receiving results. An inner Query class facilitates the binding of external variables and iterative query evaluation.
  • Example demonstrates how to send database commands.
  • QueryExample shows you how to evaluate queries in an iterative manner.
  • QueryBindExample shows you how to bind a variable to your query and evaluates the query in an iterative manner.
  • CreateExample shows how new databases can be created by using streams.
  • AddExample shows how documents can be added to a database by using streams.
  • EventExample demonstrates how to watch and unwatch Events.

Changelog

Version 8.0
  • Updated: cram-md5 replaced with digest authentication
Retrieved from "http://docs.basex.org/index.php?title=Clients&oldid=11342"