Difference between revisions of "Java Examples"

From BaseX Documentation
Jump to navigation Jump to search
Line 6: Line 6:
  
 
==Local Examples==
 
==Local Examples==
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/RunCommands.java RunCommands.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/RunCommands.java RunCommands.java]<br/>creates and drops database and index instances, prints a list of all existing databases.
:creates and drops database and index instances, prints a list of all existing databases.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/WikiExample.java WikiExample.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/WikiExample.java WikiExample.java]<br/>creates a database from an url (wiki instance), runs a query against it and drops the database.
:creates a database from an url (wiki instance), runs a query against it and drops the database.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/RunQueries.java RunQueries.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/RunQueries.java RunQueries.java]<br/>shows three variants of running queries.
:shows three variants of running queries.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/CreateCollection.java CreateCollection.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/CreateCollection.java CreateCollection.java]<br/>creates and manages a collection.
:creates and manages a collection.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/QueryCollection.java QueryCollection.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/QueryCollection.java QueryCollection.java]<br/>creates, runs queries against it and drops a collection.
:creates, runs queries against it and drops a collection.
 
  
 
==Server Examples==
 
==Server Examples==
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerCommands.java ServerCommands.java]
 
:launches server-side commands using a client session.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerAndLocal.java ServerAndLocal.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerCommands.java ServerCommands.java]<br/>launches server-side commands using a client session.
:processes server results locally.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerAndLocal.java ServerAndLocal.java]<br/>processes server results locally.
:runs concurrent queries.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/UserExample.java UserExample.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]<br/>runs concurrent queries.
:manages database users.
+
 
 +
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/UserExample.java UserExample.java]<br/>manages database users.
  
 
==[[REST API]]==
 
==[[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]<br/>presents the HTTP GET method.
:presents the HTTP GET method.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTPost.java RESTPost.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTPost.java RESTPost.java]<br/>presents the HTTP POST method.
:presents the HTTP POST method.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTPut.java RESTPut.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTPut.java RESTPut.java]<br/>presents the HTTP PUT method.
:presents the HTTP PUT method.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTDelete.java RESTDelete.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTDelete.java RESTDelete.java]<br/>presents the HTTP DELETE method.
:presents the HTTP DELETE method.
 
  
 
==XML:DB API (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]<br/>creates a collection using XML:DB.
:creates a collection using XML:DB.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBQuery.java XMLDBQuery.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBQuery.java XMLDBQuery.java]<br/>runs a query using XML:DB.
:runs a query using XML:DB.
 
  
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBInsert.java XMLDBInsert.java]
+
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBInsert.java XMLDBInsert.java]<br/>inserts a document into a database using XML:DB.
:inserts a document into a database using XML:DB.
 
  
 
[[Category:Developer]]
 
[[Category:Developer]]

Revision as of 12:43, 20 May 2013

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.

Server Examples

REST API

XML:DB API (deprecated)