Changes

Jump to navigation Jump to search
186 bytes added ,  12:21, 20 March 2014
Updates links toi GitHub
The following code snippets work in ''embedded'' mode; they do not rely on an additional server instance:
* [https://github.com/BaseXdb/basex-examples/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-examples/blob/master/basex-examples/src/main/java/org/basex/examples/local/RunQueries.java RunQueries.java]<br/>shows three variants of running queries.* [https://github.com/BaseXdb/basex-examples/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-examples/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-examples/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-examples/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-examples/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.
==Server Examples==
The examples below take advantage of the client/server architecture:
* [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-examples/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-examples/blob/master/basex-examples/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java]<br/>runs concurrent queries.* [https://github.com/BaseXdb/basex-examples/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-examples/blob/master/basex-examples/src/main/java/org/basex/examples/server/ServerEventsGUI.java ServerEventsGUI.java]<br/>is a little GUI example for demonstrating database events.* [https://github.com/BaseXdb/basex-examples/blob/master/basex-examples/src/main/java/org/basex/examples/server/UserExample.java UserExample.java]<br/>manages database users.
==XQuery Module Examples==
BaseX provides [[Java Bindings]] for accessing external Java code via XQuery functions. The following examples show how this feature can be utilized:
* [https://github.com/BaseXdb/basex-examples/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-examples/blob/master/basex-examples/src/main/java/org/basex/examples/module/FruitsModule.java FruitsModule.java]<br/>is a simple demo module called by {{Code|FruitsExample}}.* [https://github.com/BaseXdb/basex-examples/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/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 ().
==[[Clients|Client API]]==
* [https://github.com/BaseXdb/basex-examples/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-examples/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-examples/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-examples/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-examples/blob/master/basex-examples/src/main/java/org/basex/examples/api/CreateExample.java CreateExample.java]<br/>shows how new databases can be created.* [https://github.com/BaseXdb/basex-examples/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-examples/blob/master/basex-examples/src/main/java/org/basex/examples/api/EventExample.java EventExample.java]<br/>demonstrates how to trigger and receive database events.* [https://github.com/BaseXdb/basex-examples/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 database.
==[[REST API]]==
* [https://github.com/BaseXdb/basex-examples/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-examples/blob/master/basex-examples/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/basex-examples/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/basex-examples/src/main/java/org/basex/examples/rest/RESTAll.java RESTAll.java]<br/>runs all examples at one go.
==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/basex-examples/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/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-examples/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>
[[Category:Developer]]
__NOTOC__
administrator, editor
28

edits

Navigation menu