Getting Started • Documentation • Example Apps • Issues

ObjectBox Java Database (Kotlin, Android)

ObjectBox is a superfast object-oriented Java database with strong relation support and easy-to-use native language APIs. ObjectBox is embedded into your Android, Linux, macOS, or Windows app.

Latest version: 3.2.0 (2022/06/20)

Your opinion matters to us! Please fill in this 2-minute Anonymous Feedback Form.

Demo code using ObjectBox:

// Kotlin
val playlist = Playlist("My Favorites")
playlist.songs.add(Song("Lalala"))
playlist.songs.add(Song("Lololo"))
box.put(playlist)

// Java
Playlist playlist = new Playlist("My Favorites");
playlist.songs.add(new Song("Lalala"));
playlist.songs.add(new Song("Lololo"));
box.put(playlist);

Want details? Read the docs

Why use ObjectBox

ObjectBox NoSQL Java database is built for storing data locally on mobile devices. It is optimized for high efficiency on restricted devices and uses minimal CPU and RAM. Being fully ACID-compliant, ObjectBox is faster than any alternative, outperforming SQLite and Realm across all CRUD (Create, Read, Update, Delete) operations. Check out our Performance Benchmarking App repository.

Additionally, our concise API is easy to learn and only requires a fraction of the code compared to SQLite. No more rows or columns, just plain objects with built-in relations.

Features

High performance on restricted devices, like IoT gateways, micro controllers, ECUs etc.
Resourceful with minimal CPU, power and Memory usage for maximum flexibility and sustainability
Relations: object links / relationships are built-in
Multiplatform: Linux, Windows, Android, iOS, macOS

Scalable: handling millions of objects resource-efficiently with ease
Queries: filter data as needed, even across relations
Statically typed: compile time checks & optimizations
Automatic schema migrations: no update scripts needed

And much more than just data persistence
ObjectBox Sync: keeps data in sync between devices and servers
ObjectBox TS: time series extension for time based data

Enjoy

Gradle setup

For Android projects, add the ObjectBox Gradle plugin to your root build.gradle:

buildscript {
    ext.objectboxVersion = "3.2.0"
    repositories {        
        mavenCentral()    
    }
    dependencies {
        classpath("io.objectbox:objectbox-gradle-plugin:$objectboxVersion")
    }
}

And in your app's build.gradle apply the plugin:

// Using plugins syntax:
plugins {
    id("io.objectbox") // Add after other plugins.
}

// Or using the old apply syntax:
apply plugin: "io.objectbox" // Add after other plugins.

First steps

Create a data object class @Entity, for example "Playlist".

// Kotlin
@Entity data class Playlist( ... )

// Java
@Entity public class Playlist { ... }

Now build the project to let ObjectBox generate the class MyObjectBox for you.

Prepare the BoxStore object once for your app, e.g. in onCreate in your Application class:

boxStore = MyObjectBox.builder().androidContext(this).build();

Then get a Box class for the Playlist entity class:

Box<Playlist> box = boxStore.boxFor(Playlist.class);

The Box object gives you access to all major functions, like put, get, remove, and query.

For details please check the docs.

Already using ObjectBox?

We believe, ObjectBox is super easy to use. We are on a mission to make developers’ lives better, by building developer tools that are intuitive and fun to code with.

To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?

We're looking forward to receiving your comments and requests:

• Add GitHub issues
• Upvote issues you find important by hitting the /+1 reaction button
• Drop us a line via @ObjectBox_io or contact[at]objectbox.io
• us, if you like what you see

Thank you!

Keep in touch: For general news on ObjectBox, check our blog!

Other languages/bindings

ObjectBox supports multiple platforms and languages. Besides JVM based languages like Java and Kotlin, ObjectBox also offers:

• ObjectBox Swift Database: build fast mobile apps for iOS (and macOS)
• ObjectBox Dart/Flutter Database: cross-platform for mobile and desktop apps
• ObjectBox Go Database: great for data-driven tools and embedded server applications
• ObjectBox C and C++ Database: native speed with zero copy access to FlatBuffer objects

License

Copyright 2017-2022 ObjectBox Ltd. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.