This page is part of {{Announce|The conventions for the [[Developer Section]]. It describes how to use BaseX from otherprogramming languages.client functions were revised:}}
With * The {{Code|replace}} and {{Code|store}} functions have been renamed to {{Code|put}} and {{Code|putBinary}}.* The {{Code|RETRIEVE}} command has been replaced by {{Command|BINARY GET}}.* Existing client implementations are working without changes unless they haven’t been upgraded. This page is part of the [[Developer Section]]. It describes how to communicate with BaseXfrom other programming languages. You can use the following light-weight language bindings in different programming languages,you will be able to connect to a running BaseX server instance, execute databasecommands, perform queries or listen to eventsand evaluate XQuery expressions. Most clients offer the followingprovide two classesmodes:
* [[Standard Mode]]: connecting to a server, sending commands
* [[Query Mode]]: defining queries, binding variables, iterative evaluation
Please have a look at our see the [[Server Protocol]] for more information on the clients and the underlying protocolavailable commands.<br/>Bindings Currently, we offer bindings for other the following programming languages are easy to write; your contributions are welcome.:
Currently<table width='100%'> <tr> <td width='50%' valign='top'>'''BaseX 7.x, we offer bindings for BaseX 8.x and later'''* [https://github.com/BaseXdb/basex/tree/main/basex-examples/src/main/java/org/basex/examples/api Java]: The default implementation* [https://github.com/bsella/BaseX_CppClient C++]: contributed by Karim Salama (based on SDL2_net)* [https://github.com/JohnLeM/BasexCPPAPI/ C++]: contributed by Jean-Marc Mercier (based on libboost)* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/c%23 C#], contributed by the BaseX Team and Martín Ferrari* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/c C], contributed by the following programming languagesBaseX Team* [https://github.com/programaths/go-basex Golang]: contributed by Christian Baune* [https://github.com/zadean/basexerl/blob/main/src/bxe_client.erl Erlang]: contributed by Zachary Dean* [https://github.com/apb2006/basex-node node.js]: contributed by Andy Bunce* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/perl Perl], contributed by the BaseX Team* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/php PHP]: updated by James Ball* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/python Python]: contributed by Hiroaki Itoh* [https://github.com/lucalianas/pyBaseX Python], using BaseX REST services: contributed by Luca Lianas* [https://github.com/BenEngbers/RBaseX R]: contributed by Ben Engbers* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/raku Raku]: contributed by Wayland* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/ruby Ruby], contributed by the BaseX Team* [https://github.com/eptx/v-basex V], contributed by Erik Peterson
With <b>Version 8.0</b>, authentication has changed. Some language bindings have not been updated yet. The update is rather trivial, though ([[Server_Protocol#Authentication|see here]] for more details); Object oriented:patches are welcome. </td> <td width='50%' valign='top'>'''BaseX 7.x''' (outdated): * [https://github.com/BaseXdb/basex-api/tree/master/src/main/c%23 C#], [https://github7.com/BaseXdb9/basex-api/tree/master/src/main/vb VBas ActionScript], : contributed by Manfred Knobloch* [https://github.com/BaseXdb/basex-api/tree/master/src/main/scala Scala], [https://github7.com/BaseXdb9/basex-examples/tree/masterapi/src/main/java/org/basex/examples/api Javahaskell Haskell]: contributed by Leo Wörteler: * [https://github.com/delvingBaseXdb/basex-scala-client Scala]: contributed by Manuel Bernhardt: [https:/tree/github7.com/BaseXdb9/basex-api/tree/master/src/main/as ActionScriptlisp Lisp]: contributed by Manfred Knobloch; ScriptingAndy Chambers: * [https://github.com/BaseXdbhanshuebner/simple-basex-api/tree/master/src/main/perl Perlnode.js]: contributed by Hans Hübner (deviating from client API): * [https://github.com/BaseXdb/basex-api/tree/master/src/main/php PHP] ([[PHP Example|example]]): [https://github7.com/BaseXdb9/basex-api/tree/master/src/main/python3 Python 3.x, 2.7.3qt Qt]: contributed by Hiroaki ItohHendrik Strobelt: * [https://github.com/BaseXdb/basex-api/tree/master/src/main/python Python < 2.7]: improved by Arjen van Elteren: [https://github.com/BaseXdb9/basex-api/tree/master/src/main/rebol Rebol]: contributed by Sabu Francis: * [https://github.com/BaseXdbdelving/basex-api/tree/master/src/main/ruby Rubyscala-client Scala]; Functional:contributed by Manuel Bernhardt: * [https://github.com/BaseXdb/basex-api/tree/master/src/main/haskell Haskell]: contributed by Leo Wörteler: [https://github7.com/BaseXdb9/basex-api/tree/master/src/main/lisp Lispscala Scala]: contributed by Andy Chambers(simple implementation); Others:: * [https://github.com/apb2006BaseXdb/basex-node node.js]: contributed by Andy Bunce: [https:/tree/github.com/BaseXdbmain/basex-api/tree/master/src/main/qt Qtvb VB]: , contributed by Hendrik Strobeltthe BaseX Team: [https: </td> </github.com/BaseXdb/basex-api/treetr></master/src/main/c C]table>
Many of the interfaces contain the following files:
* <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>EventExample</code> demonstrates how to watch and unwatch [[Events]].
[[Category=Changelog= ;Version 10.0* Updated:Developer]]The {{Code|replace}} and {{Code|store}} functions have been renamed to {{Code|put}} and {{Code|putBinary}}.[[Category:Server]][[Category;Version 8.0* Updated:API]]cram-md5 replaced with digest authentication.