EN | RU

objectbox_flutter_libs_aurora

Original Readme

Description

The Aurora implementation of objectbox_flutter_libs.

WARNING: Objectbox only available as pre-compiled binary library without any warranties. Please consider security risks of using 3rd party pre-compiled libraries.

Quickstart: Basic Usage Example

// Annotate your Dart class
@Entity()
class Person {
  @Id()
  int id;
  String firstName;
  String lastName;
  Person({this.id = 0, required this.firstName, required this.lastName});
}

// Open the store
final store = await openStore(directory: 'person-db');
final box = store.box();

// Create an object
var person = Person(firstName: 'Joe', lastName: 'Green');
final id = box.put(person); // Create

person = box.get(id)!;      // Read

person.lastName = 'Black';
box.put(person);            // Update

box.remove(person.id);      // Delete

final query = box
    .query(Person_.firstName.equals('Joe') & Person_.lastName.startsWith('B'))
    .build();
final List people = query.find();
query.close();

Features

• Super fast: up to 10x faster than SQLite.
• ACID-compliant: ensures transactional safety.
• Cross-platform: supports Android, iOS, macOS, Linux, Windows, and Aurora OS.
• Scalable: handles millions of objects efficiently.
• On-device vector search for AI/ML applications.
• Built-in object relations and convenient query API.
• Schema migration with minimal effort.
• NoSQL model: store pure Dart objects, not tables/rows.
• Secure, offline-first architecture for reliable local data access.

Contents

• Installation and build
• Compatibility
• Terms of use and participation in development

Installation and build

dependencies:
  objectbox: 4.3.0
  objectbox_flutter_libs: 4.3.0
  objectbox_flutter_libs_aurora:
    git:
      url: https://developer.auroraos.ru/git/flutter/flutter-community-plugins/objectbox_flutter_libs_aurora.git

Compatibility

The application has been working correctly since the 5.0.0 version of the Aurora OS.

Terms of Use and Participation

The source code of the project is provided under the license, that allows it to be used in third-party applications.

To participate in the development of the project, please read the contributor agreement. If you plan to contribute your own source code to the project, you will need to accept the CLA agreement.

For information about contributors see AUTHORS.

Code of conduct is a current set of rules of the Open Mobile Platform which informs you how we expect the members of the community will interact while contributing and communicating.