Difference between revisions of "Java Examples"
Jump to navigation
Jump to search
Line 5: | Line 5: | ||
==Local Examples== | ==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. | :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] |
: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] |
: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] |
: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] |
: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. | :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] |
:processes server results locally. | :processes server results locally. | ||
− | ;[ | + | ;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/server/ServerConcurrency.java ServerConcurrency.java] |
:runs concurrent queries. | :runs concurrent queries. | ||
− | ;[ | + | ;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/UserExample.java UserExample.java] |
:manages database users. | :manages database users. | ||
==[[REST API]] Examples== | ==[[REST API]] Examples== | ||
− | ;[ | + | ;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/rest/RESTGet.java RESTGet.java] |
: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] |
: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/RESPut.java RESTPut.java] |
: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] |
:presents the HTTP DELETE method. | :presents the HTTP DELETE method. | ||
==XML:DB API Examples== | ==XML:DB API Examples== | ||
− | ;[ | + | ;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xmldb/XMLDBCreate.java XMLDBCreate.java] |
: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] |
: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] |
:inserts a document into a database using XML:DB. | :inserts a document into a database using XML:DB. | ||
==XQJ API Example== | ==XQJ API Example== | ||
− | ;[ | + | ;[https://github.com/BaseXdb/basex-examples/blob/master/src/main/java/org/basex/examples/xqj/XQJQuery.java XQJQuery.java] |
:runs a query using XQJ. | :runs a query using XQJ. | ||
[[Category:Developer]] | [[Category:Developer]] |
Revision as of 06:52, 7 February 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.
Note that we recommend everyone to use our own APIs, as they offer better performance and are better supported by our core team. The use of the XML:DB
and XQJ
APIs is discouraged: as these APIs do not utilize the client/server architecture of BaseX, their use may lead to conflicting database access operations.
Contents
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 Examples
- 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 Examples
- 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.
XQJ API Example
- XQJQuery.java
- runs a query using XQJ.