Changes

Jump to navigation Jump to search
2,300 bytes added ,  16:29, 29 June 2023
no edit summary
{{Announce|The conventions for the client functions were revised:}} * 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 BaseX provides clients in several from other programming languages. With these  You can use the following light-weight language bindings,you will be able to connect to a running BaseX server instance, execute all databasecommands and perform queriesevaluate XQuery expressions. Most clients provide two modes: * [[Standard Mode]]: Description of connecting to a server, sending commands* [[Query Mode]]: defining queries, binding variables, iterative evaluation Please see the [[Server Protocol]] for more information on the available commands. Currently, we offer bindings for the usage of following programming languages: <table width='100%'> <tr> <td width='50%' valign='top'>'''BaseX 7.x, 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 standard modeBaseX Team and Martín Ferrari* [https://github. com/BaseXdb/basex/tree/main/basex-api/src/main/c C], contributed by the BaseX Team* [https://github.com/programaths/go-basex Golang]: contributed by Christian Baune* [Query Modehttps://github.com/zadean/basexerl/blob/main/src/bxe_client.erl Erlang]: contributed by Zachary Dean* [https://github.com/apb2006/basex-node node.js]: Description of contributed by Andy Bunce* [https://github.com/BaseXdb/basex/tree/main/basex-api/src/main/perl Perl], contributed by the usage of 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 query modeBaseX Team* [https://github.com/eptx/v-basex V], contributed by Erik Peterson
CurrentlyWith <b>Version 8.0</b>, we offer authentication has changed. Some language bindings have not been updated yet. The update is rather trivial, though ([[Server_Protocol#Authentication|see here]] for the following programming languages (bindings in other languages more details); patches are welcome!. </td> <td width='50%' valign='top'>'''BaseX 7.x''' (outdated):; Imperative:: * [https://github.com/BaseXdb/basex-api/tree/master7.9/basex-api/src/main/c Cas ActionScript]; Object oriented:contributed by Manfred Knobloch: * [https://github.com/BaseXdb/basex-api/tree/master7.9/basex-api/src/main/c%23 C#haskell Haskell], : contributed by Leo W&ouml;rteler* [https://github.com/BaseXdb/basex-api/tree/master/src/main/vb VB], [https://github7.com/BaseXdb9/basex-api/tree/master/src/main/java Javalisp Lisp], : contributed by Andy Chambers* [https://github.com/BaseXdbhanshuebner/simple-basex-api/tree/master/src/main/scala Scalanode.js]: contributed by Hans Hübner (deviating from client API); Scripting: * [https://github.com/BaseXdb/basex-api/tree/master/src/main/php PHP], [https://github7.com/BaseXdb9/basex-api/tree/master/src/main/python Pythonqt Qt], : contributed by Hendrik Strobelt* [https://github.com/BaseXdb/basex-api/tree/master/src/main/perl Perl], [https://github7.com/BaseXdb9/basex-api/tree/master/src/main/ruby Rubyrebol Rebol]: contributed by Sabu Francis: * [https://github.com/BaseXdbdelving/basex-api/tree/master/src/main/rebol Rebolscala-client Scala] (thanks to Sabu Francis); Functional:contributed by Manuel Bernhardt: * [https://github.com/BaseXdb/basex-api/tree/master7.9/basex-api/src/main/lisp Lispscala Scala] (thanks to Andy Chamberssimple implementation): * [https://github.com/BaseXdb/basex-api/tree/mastermain/basex-api/src/main/haskell Haskellvb VB] (thanks to Leo W&ouml;rteler) , contributed by the BaseX Team </td> </tr></table>
Most Many 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 An inner class called <code>queryQuery</code> which offers class facilitates the evaluation binding of queries in an external variables and iterative mannerquery evaluation.
* <code>Example</code> demonstrates how to send database commands.
* <code>QueryExample</code> shows you how to evaluate queries in an iterative manner.
* <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:=Changelog= * <code>EventExample</code> demonstrates how to use the event feature;Version 10.0 Please check out [https* Updated://github.com/BaseXdb/basex-api/blob/master/src/main/readme.txt readme.txt]for more background information on the client/server communicationThe {{Code|replace}} and {{Code|store}} functions have been renamed to {{Code|put}} and {{Code|putBinary}}.
[[Category:Developer]][[Category:Server]];Version 8.0[[Category* Updated:API]]cram-md5 replaced with digest authentication.
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Navigation menu