Difference between revisions of "Java Examples"

From BaseX Documentation
Jump to navigation Jump to search
Line 34: Line 34:
 
:manages database users.
 
:manages database users.
  
==[[REST API]] Examples==
+
==[[REST API]]==
  
 
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTGet.java RESTGet.java]
 
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTGet.java RESTGet.java]
Line 48: Line 48:
 
:presents the HTTP DELETE method.
 
:presents the HTTP DELETE method.
  
==XML:DB API Examples (deprecated)==
+
==XML:DB API (deprecated)==
  
 
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBCreate.java XMLDBCreate.java]
 
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBCreate.java XMLDBCreate.java]

Revision as of 15:05, 2 September 2012

This page is part of the Developer Section. The following Java code snippets demonstrate how easy it is to run database commands, create collections, perform queries, etc. via the BaseX API. Most examples are taken from our basex-examples repository, in which you will find some more use cases.

Our current XQJ API is based on Charles Foster’s XQJ implementation, which fully utilized the client/server architecture of BaseX. Note that the older XML:DB API can only be used in embedded mode.

Local Examples

RunCommands.java
creates and drops database and index instances, prints a list of all existing databases.
WikiExample.java
creates a database from an url (wiki instance), runs a query against it and drops the database.
RunQueries.java
shows three variants of running queries.
CreateCollection.java
creates and manages a collection.
QueryCollection.java
creates, runs queries against it and drops a collection.

Server Examples

ServerCommands.java
launches server-side commands using a client session.
ServerAndLocal.java
processes server results locally.
ServerConcurrency.java
runs concurrent queries.
UserExample.java
manages database users.

REST API

RESTGet.java
presents the HTTP GET method.
RESTPost.java
presents the HTTP POST method.
RESTPut.java
presents the HTTP PUT method.
RESTDelete.java
presents the HTTP DELETE method.

XML:DB API (deprecated)

XMLDBCreate.java
creates a collection using XML:DB.
XMLDBQuery.java
runs a query using XML:DB.
XMLDBInsert.java
inserts a document into a database using XML:DB.