Getting StartedDocumentationExample AppsIssues

Build and test pub.dev package Follow @ObjectBox_io

Flutter database for Dart-native objects 💙

ObjectBox Flutter database is a great option for storing Dart objects in your cross-platform apps. Designed for high performance, the ObjectBox Flutter database is ideal or mobile and IoT devices. ObjectBox uses minimal CPU, memory and battery, making your app not only effective, but also sustainable. By storing data locally on device, ObjectBox helps you cut your cloud costs down and make an app that doesn't depend connection. Get started with our intuitive native Dart API in minutes, without the hassle of SQL. Plus: We built a data synchronization solution that allows you to keep data in sync across devices and servers, both online and offline.

Features

🏁 Super fast - 10X faster than SQLite - see the performance benchmarks.
🪂 ACID compliant - Atomic, Consistent, Isolated, Durable.
💻 Cross-platform - Android, iOS, macOS, Linux, Windows.
🌱 Scalable - grows with your app, handling millions of objects with ease.

🎯 NoSQL database - no rows or columns, only pure Dart objects.
🔗 Relations - object links / relationships are built-in.
💐 Queries - filter data as needed, even across relations.
📃 Schema migration - simply change your model, we handle the rest.

Oh, and there is one more thing...

😮 Data Sync - sync only when and where needed.

On this page


Sneak peek - persist Dart objects with ObjectBox

ObjectBox provides a store with boxes to put objects into:

// Annotate a Dart class to create a box
@Entity()
class Person {
  @Id() 
  int id;
  String name;

  Person({this.id = 0, required this.name});
}

final box = store.box<Person>();

// Put a new object into the box
var person = Person(name: "Joe Green");
final id = box.put(person);

// Get the object back from the box
person = box.get(id)!;

// Update the object
person.name = "Joe Black";
box.put(person);

// Query for objects
final query = box.query(Person_.name.equals("Joe Black"))
        .order(Person_.name).build();
final people = query.find();
query.close();

// Remove the object from the box
box.remove(person.id);

Getting Started

Read the ➡️ Getting Started guide.

It has resources and video tutorials on how to use ObjectBox in your Flutter or Dart app.

We also have some video tutorials, each featuring a different example app:

Flutter Database Performance Benchmarks

We tested across the four main database operations, CRUD (create, read, update, delete). Each test was run multiple times and executed manually outside of the measured time. Data preparation and evaluation were also done outside of the measured time.

Here are the benchmarks for ObjectBox vs sqflite vs Hive 👇

You can run these yourself using our objectbox-dart-performance Flutter benchmark app.

Do you 💙 ObjectBox?

We strive to bring joy to Flutter developers and appreciate any feedback --> Please fill in this 2-minute Anonymous Feedback Form.

We ❤️ you & are looking forward to your comments and ideas:

  • Add GitHub issues
  • Upvote issues you find important by hitting the 👍/+1 reaction button
  • Fill in the feedback form to help us improve our products
  • Drop us a line on Twitter via @ObjectBox_io
  • ⭐ us on GitHub, if you like what you see or give us a 👍 on pub.dev

Thank you! 🙏

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

FAQ

See the FAQ and Troubleshooting pages.

See also

License

Copyright 2019-2024 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.

Note that this license applies to the code in this repository only. See our website on details about all licenses for ObjectBox components.

Libraries

objectbox
ObjectBox for Dart is a standalone database storing Dart objects locally, with strong ACID semantics.
internal
This library serves as an entrypoint for generated code and objectbox tools. Don't import into your own code, use 'objectbox.dart' instead.