JarCastingNOTE: JasDB is currently in low maintenance mode and does not receive any further big updates
JasDB is an open Document based database that can be used to store unstructured data. The database can be used standalone and accessed through a java client library or the REST interface.
Also the database can be used in process of your Java application, ideal for embedded projects (including on Android) where a small lightweight database is needed.
Features
JasDB has the folowing features:
- Lightweight memory and cpu profile
- High throughput on a single machine
- Full query capabilities
- BTree index structure
- REST webservice
- Android support
- Java client API (both for remote and local embedded mode)
Documentation
For more information have a look at http://www.oberasoftware.com
Wiki for installation and API usage: https://github.com/oberasoftware/jasdb-open/wiki Javadoc: http://oberasoftware.github.io/jasdb/apidocs/
Note: The above documentation is for the current LTS version of JasDB, the current master Branch points to version 2.0 which will break compatibility on the API (not the data format)
Quick Installation
- Install JasDB by unzipping the download
- Start the database using start.bat or start.sh
- Open http://localhost:7050
For more details see here: https://github.com/oberasoftware/jasdb-open/wiki/Installing-and-configuring-JasDB
Running using Docker
We have a docker container available that allows you to very quickly get a running JasDB installation.
In order to run a standard docker container:
docker run -d -p 7050:7050 renarj/jasdb:1.1.2
We however recommend running the jasdb data directory in a seperate volume, for example take the following to attach to a host volume
docker run -v /Users/devuser/dev/docker/volumes/jasdb-data:/jasdb-data -p 7050:7050 renarj/jasdb:1.1.2
Java with Object mapping Example
In JasDB we have an object mapper available which allows you to do quick operations using your regular Java objects. All you have to do is add some annotations on top of your Java beans.
Example bean:
@JasDBEntity(bagName = "TEST_BAG")
public class TestEntity {
private String id;
private String firstName;
private String lastName;
@Id
@JasDBProperty
public String getId() { return id; }
public void setId(String id) { this.id = id; }
@JasDBProperty
public String getFirstName() { return firstName; }
public void setFirstName(String firstName) { this.firstName = firstName; }
@JasDBProperty
public String getLastName() { return lastName; }
public void setLastName(String lastName) { this.lastName = lastName; }
}
The following code can be used for persisting these beans:
DBSession session = new LocalDBSession(); //new RestDBSession();
EntityManager entityManager = session.getEntityManager();
TestEntity entity = new TestEntity(null, "Renze", "de Vries");
String id = entityManager.persist(entity).getInternalId();
The following can be used to query and retrieve the entities back from the database
DBSession session = new LocalDBSession(); //new RestDBSession();
EntityManager entityManager = session.getEntityManager();
TestEntity foundEntity = entityManager.findEntity(TestEntity.class, id);
//This will find all entities
List<TestEntity> allEntities = entityManager.findEntities(TestEntity.class, QueryBuilder.createBuilder());
//Get all people named Piet
QueryBuilder query = QueryBuilder.createBuilder().field("firstName").value("Piet");
List<TestEntity> peopleNamedPiet = entityManager.findEntities(TestEntity.class, query);
For more details on the entity mapping, please check this page on the wiki: https://github.com/oberasoftware/jasdb-open/wiki/Object-Entity-Mapping-API
Regular Java Client Example
Besides using the object mapper you can also use JasDB object model which allows more finer grained control over the data itself. Also the API offers more operations to create indexes and other database operations.
Example on how to insert and retrieve data:
//Open DB Session
DBSession session = new LocalDBSession();
EntityBag bag = session.createOrGetBag("MyBag");
//Insert some data
SimpleEntity entity = new SimpleEntity();
entity.addProperty("title", "Title of my content");
entity.addProperty("text", "Some big piece of text content");
bag.addEntity(entity);
//Retrieve entity by Id
SimpleEntity e = bag.getEntity("056f8058-e1f7-4f8e-a2f8-332e62c15961");
//Query the DB
QueryExecutor executor = bag.find(QueryBuilder.createBuilder().field("field").value(queryKey));
QueryResult result = executor.execute();
for(SimpleEntity entity : result) {
//access the properties if desired
entity.getProperty("field1");
}
For more information:
- WIKI: https://github.com/oberasoftware/jasdb-open/wiki/Java-Client-API
- JavaDoc API: http://oberasoftware.github.io/jasdb/apidocs/
License
This software adheres to the MIT X11 license: Copyright (c) 2014 Obera Software
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
There is an additional requirement to the above MIT X11 License: Redistribution of this software in source or binary forms shall be free of all charges or fees to the recipient of this software.