Clients

From BaseX Documentation

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

With the following light-weight bindings in different programming languages, you will be able to connect to a running BaseX server instance, execute database commands, perform queries or listen to events. Most clients offer the following two classes:

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

Bindings for other languages are easy to write, and welcome! Please have a look at our Server Protocol for more information (note that the protocol has changed with Version 7.0 of BaseX).

Currently, we offer bindings for the following programming languages:

Object oriented

Java, C#, VB, Scala

ActionScript (contributed by Manfred Knobloch)

Scripting

PHP, Perl, Ruby

Python (improved by Arjen van Elteren)

Rebol (contributed by Sabu Francis)

Functional

Lisp (contributed by Andy Chambers)

Haskell (contributed by Leo Wörteler)

Others

node.js (contributed by Andy Bunce)

Qt (contributed by Hendrik Strobelt)

C

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.