Changes

Jump to navigation Jump to search
3,860 bytes added ,  15:56, 17 January 2016
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/basex-examples/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%;">
==Local Examples==
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/query/RunCommands.java RunCommands.java]
:creates and drops database and index instances, prints a list of all existing databases.
The following code snippets work in ''embedded'' mode;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/WikiExample.java WikiExample.java]:creates a database from they do not rely on an url (wiki additional server instance), runs a query against it and drops the database.:
;* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/local/RunCommands.java RunCommands.java]<br/>creates and drops database and index instances, prints a list of all existing databases.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/querylocal/RunQueries.java RunQueries.java]:<br/>shows three variants of running queries.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/local/BindContext.java BindContext.java]<br/>demonstrates how a value can be bound as context item.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/local/BindVariables.java BindVariables.java]<br/>demonstrates how a value can be bound to a variable.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/local/CreateCollection.java CreateCollection.java]<br/>creates and manages a collection.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/local/QueryCollection.java QueryCollection.java]<br/>creates, runs queries against it and drops a collection.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/local/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/CreateCollection.java CreateCollection.java]:creates and manages a collection.==Server Examples==
;[https://github.com/BaseXdb/basex-The examplesbelow take advantage of the client/blob/master/src/main/java/org/basex/examples/query/QueryCollection.java QueryCollection.java]server architecture:creates, runs queries against it and drops a collection.
==Server Examples==;* [https://github.com/BaseXdb/basex-examples/blob/master/basex-examples/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/blob/master/basex-examples/src/main/java/org/basex/examples/server/ServerAndLocal.java ServerAndLocal.java]<br/>processes server results locally.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]<br/>runs concurrent queries.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/server/ServerQueries.java ServerQueries.java]<br/>shows how iterative queries can be performed.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/server/UserExample.java UserExample.java]<br/>manages database users.
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerAndLocal.java ServerAndLocal.java]:processes server results locally.==XQuery Module Examples==
;BaseX provides [https://github[Java Bindings]] for accessing external Java code via XQuery functions.com/BaseXdb/basex-The following examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]show how this feature can be utilized:runs concurrent queries.
;* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/module/FruitsExample.java FruitsExample.java]<br/>demonstrates how Java classes can be imported as XQuery modules.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/UserExamplemodule/FruitsModule.java UserExampleFruitsModule.java]<br/>is a simple demo module called by {{Code|FruitsExample}}.* [https:manages database users//github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/module/ModuleDemo.java ModuleDemo.java]<br/>is a simple XQuery demo module that demonstrates how XQuery items can be processed from Java. It is derived from the {{Code|QueryModule}} class.* [https://github.com/BaseXdb/basex/blob/master/basex-core/src/main/java/org/basex/query/QueryModule.java QueryModule.java]<br/>is located in the BaseX core. Java query modules can extend this class to get access to the current query context and enrich functions with properties ().
</div><div style="float:left; width:4%;">&nbsp;</div><div style=[[REST API]] Examples=="float:left; width:48%;">
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTGet.java RESTGet.java]:presents the HTTP GET method.==XQJ API==
;The implementation of the [http://xqj.net/basex/ BaseX XQJ API] (closed-source) has been written by Charles Foster. It uses the client/server architecture.The basex-examples repository contains [https://github.com/BaseXdb/basex-examples/blobtree/master/basex-examples/src/main/java/org/basex/examples/rest/RESTPost.java RESTPost.javaxqj various examples]:presents the HTTP POST methodon how to use XQJ.
;==[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTPut.java RESTPut.java[Clients|Client API]]:presents the HTTP PUT method.==
;* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/api/BaseXClient.java BaseXClient.java]<br/>provides an implementation of the [[Server Protocol]].* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/api/Example.java Example.java]<br/>demonstrates how commands can be executed on a server.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/api/QueryExample.java QueryExample.java]<br/>shows how queries can be executed in an iterative manner.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/api/QueryBindExample.java QueryBindExample.java]<br/>shows how external variables can be bound to XQuery expressions.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/restapi/RESTDeleteCreateExample.java RESTDeleteCreateExample.java]<br/>shows how new databases can be created.* [https:presents //github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/api/AddExample.java AddExample.java]<br/>shows how documents can be added to databases, and how existing documents can be replaced.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/api/BinaryExample.java BinaryExample.java]<br/>shows how binary resource can be added to and retrieved from the HTTP DELETE methoddatabase.
==XML:DB [[REST API Examples (deprecated)]]==
;* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/rest/RESTGet.java RESTGet.java]<br/>presents the HTTP GET method.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/xmldbrest/XMLDBCreateRESTPost.java XMLDBCreateRESTPost.java]<br/>presents the HTTP POST method.* [https:creates a collection using XML//github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/rest/RESTPut.java RESTPut.java]<br/>presents the HTTP PUT method.* [https:DB//github.com/BaseXdb/basex/blob/master/basex-examples/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/xmldb/XMLDBQuery.java XMLDBQuery.java]:runs a query using ==XML:DB.API (deprecated)==
;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBInsert.java XMLDBInsert.java]:inserts a document into a database using Note that the XML:DBAPI does not talk to the server and can thus only be used in embedded mode.
* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/xmldb/XMLDBCreate.java XMLDBCreate.java]<br/>creates a collection using XML:DB.* [Categoryhttps:Developer//github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/xmldb/XMLDBQuery.java XMLDBQuery.java]<br/>runs a query using XML:DB.* [https://github.com/BaseXdb/basex/blob/master/basex-examples/src/main/java/org/basex/examples/xmldb/XMLDBInsert.java XMLDBInsert.java]<br/>inserts a document into a database using XML:DB.</div>__NOTOC__
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu