Changes

Jump to navigation Jump to search
767 bytes added ,  11:16, 6 June 2013
no edit summary
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 by integrating the BaseX APIcode. Most examples are taken from our [https://github.com/BaseXdb/basex-examples/tree/master/src/main/java/org/basex/examples basex-examples] repository, in which you will find some more use cases. Our current XQJ API is based on Charles Foster’s [http://xqj.net/basex/ XQJ implementation], which fully utilized the client/server architecture of BaseX.Note that the older {{Code|XML:DB}} API can only be used in embedded mode.
<div style="float:left; width:48%;">
* [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.
 
* [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.
 
* [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.
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/BindContext.java BindContext.java]<br/>demonstrates how a value can be bound as context item.* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/BindVariables.java BindVariables.java]<br/>demonstrates how a value can be bound to a variable.
* [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.
 
* [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.
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/WikiExample.java WikiExample.java]<br/>creates a database from an url (wiki instance), runs a query against it and drops the database.
==Server Examples==
* [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.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerAndLocal.java ServerAndLocal.java]<br/>processes server results locally.
 
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]<br/>runs concurrent queries.
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerQueries.java ServerQueries.java]<br/>shows how iterative queries can be performed.* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/UserExample.java UserExample.java]<br/>manages database users.
</div><div style="float:left; width:4%;">&nbsp;
* [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.
 
* [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.
* [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.
* [https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTAll.java RESTAll.java]<br/>runs all examples at one go.
* [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.==XQJ API==
* Our current XQJ API is based on Charles Foster’s [http://xqj.net/basex/ XQJ implementation] (closed-source). It communicates with the BaseX server.The basex-examples repository contains [https://github.com/BaseXdb/basex-examples/blobtree/master/src/main/java/org/basex/examples/rest/RESTDelete.java RESTDelete.javaxqj various examples]<br/>presents the HTTP DELETE methodon how to use XQJ.
==XML:DB API (deprecated)==
 
Note that the XML:DB API does not talk to the server and can thus only be used in embedded mode.
* [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.
 
* [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.
 
* [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.
 
</div>
[[Category:Developer]]
__NOTOC__
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu