ObjectBox in Flutter

Abdul Raheem

29 November 2023

ObjectBox in Flutter is a super-fast database storing Dart objects locally.

Introduction

For storing Dart objects in your cross-platform projects, consider using the ObjectBox Flutter database.

The ObjectBox in the Flutter database was built for great speed and is perfect for mobile and IoT devices.

With minimum CPU, memory, and battery usage, ObjectBox makes your programme both efficient and sustainable.

Installation of ObjectBox in Flutter

The first thing we have to do after creating the app is to add these dependencies in the pubspec.yml file.

dependencies:

  objectbox: ^2.1.0
  objectbox_flutter_libs: any

dev_dependencies:

  build_runner: ^2.0.0
  objectbox_generator: any

dependencies:

objectbox: ^2.1.0

objectbox_flutter_libs: any

dev_dependencies:

build_runner: ^2.0.0

objectbox_generator: any

Note: Please add updated dependencies.

ObjectBox is an object-oriented non-relational (NoSQL) database. First, we need to tell the database which entities to store.

Create Entity and Store Class using ObjectBox in Flutter

You may also check our other database Hive DataBase.


import 'package:blog_project/objectbox.g.dart';
import 'package:path/path.dart' as p;
import 'package:path_provider/path_provider.dart';
import 'package:objectbox/objectbox.dart';

@Entity()
class UserData {
@Id()
int id = 0;

String? name;

@Property(type: PropertyType.date) // Store as int in milliseconds
DateTime? date;

@Transient() // Ignore this property, not stored in the database.
int? computedProperty;
}


class ObjectBox {
  late final Store store;

  ObjectBox._create(this.store) {
   
  }
  static Future&lt;ObjectBox&gt; create() async {
    final docsDir = await getApplicationDocumentsDirectory();
    
    final store = await openStore(directory: p.join(docsDir.path, "obx-example"));
    return ObjectBox._create(store);
  }
}

import 'package:blog_project/objectbox.g.dart';

import 'package:path/path.dart' as p;

import 'package:path_provider/path_provider.dart';

import 'package:objectbox/objectbox.dart';

@Entity()

class UserData {

@Id()

int id = 0;

String? name;

@Property(type: PropertyType.date) // Store as int in milliseconds

DateTime? date;

@Transient() // Ignore this property, not stored in the database.

int? computedProperty;

}

class ObjectBox {

late final Store store;

ObjectBox._create(this.store) {

}

static Future<ObjectBox> create() async {

final docsDir = await getApplicationDocumentsDirectory();

final store = await openStore(directory: p.join(docsDir.path, "obx-example"));

return ObjectBox._create(store);

}

Box operations

First, you have to open your box:

  final store = await openStore();
var userBox = store.box&lt;UserData&gt;();

1 2	final store = await openStore(); var userBox = store.box<UserData>();

Types of operations:

Put => insert one element inside the database
putMany => Insert a list of userData
get => Get one specific user by Key(ID)
getMany => Get multiple users by giving a list of Key (ID)
getAll => Get all the userData
remove => Remove one user by Key(ID)
removeMany => Remove many users by giving a list of Key(ID)
removeAll => Delete all the objects in a box.
count => Counts the number of objects in a box

final user = UserData(name: 'Webkul');
userBox.put(user);

final users = getNewUsers();
userBox.putMany(users);

final user = userBox.get(userId);

final users = userBox.getMany(userIds);

final users = userBox.getAll();

final user = UserData(name: 'Webkul');

userBox.put(user);

final users = getNewUsers();

userBox.putMany(users);

final user = userBox.get(userId);

final users = userBox.getMany(userIds);

final users = userBox.getAll();

Conclusion

In this article, we have explained How to add values in the objectBox database and get values in the database.

You may also check our Flutter app development services

For more understanding please can go through this Link

For more interesting blogs check here.

Thanks for reading this article.