• Stars
    star
    1,082
  • Rank 42,777 (Top 0.9 %)
  • Language
    Go
  • License
    Apache License 2.0
  • Created almost 6 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Embedded Go Database, the fast alternative to SQLite, gorm, etc.

Getting Started โ€ข Documentation โ€ข Example Apps โ€ข Issues

Go Report Godocs Latest Release Follow @ObjectBox_io

ObjectBox Go Database - simple but powerful; frugal but fast

The Golang database is easy to use via an intuitive native Golang API and persists objects superfast and sustainably.
Go and check out the performance benchmarks vs SQLite (GORM) & Storm.

ObjectBox persists your native Go structs using a simple CRUD API:

id, err := box.Put(&Person{ FirstName: "Joe", LastName:  "Green" })

Want details? Read the docs or check out the API reference.

Latest release: v1.7.0 (2023-06-23)

Table of Contents:

High-performance Go database

๐Ÿ 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

Getting started: Go!

To install ObjectBox, execute the following command in your project directory. You can have a look at installation docs for more details and further instructions.

bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-go/main/install.sh)

To install ObjectBox Sync variant of the library, pass --sync argument to the command above:

bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-go/main/install.sh) --sync

You can run tests to validate your installation

go test github.com/objectbox/objectbox-go/...

With the dependencies installed, you can start adding entities to your project:

//go:generate go run github.com/objectbox/objectbox-go/cmd/objectbox-gogen
โ€‹
type Task struct {
	Id   uint64
	Text string
}

And run code generation in your project dir

go generate ./...

This generates a few files in the same folder as the entity - remember to add those to version control (e. g. git).

Once code generation finished successfully, you can start using ObjectBox:

obx := objectbox.NewBuilder().Model(ObjectBoxModel()).Build()
box := BoxForTask(obx) // Generated function to provide a Box for Task objects
id, _ := box.Put(&Task{ Text: "Buy milk" })

See the Getting started section of our docs for a more thorough intro.

Also, please have a look at the examples directory and for the API reference see ObjectBox GoDocs - and the sources in this repo.

Already using ObjectBox Database?

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

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
  • โญ us, if you like what you see

Thank you! ๐Ÿ™

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

Upgrading to a newer version

When you want to update, please re-run the entire installation process to ensure all components are updated:

  • ObjectBox itself (objectbox/objectbox-go)
  • Dependencies (flatbuffers)
  • ObjectBox library (libobjectbox.so|dylib; objectbox.dll)
  • ObjectBox code generator

This is important as diverging versions of any component might result in errors.

The install.sh script can also be used for upgrading:

bash <(curl -s https://raw.githubusercontent.com/objectbox/objectbox-go/main/install.sh)

Afterwards, don't forget to re-run the code generation on your project

go generate ./...

Other languages/bindings

ObjectBox supports multiple platforms and languages:

License

Copyright 2018-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.

More Repositories

1

objectbox-java

Android Database - first and fast, lightweight on-device vector database
Java
4,365
star
2

objectbox-dart

Flutter database for super-fast Dart object persistence
Dart
991
star
3

objectbox-swift

Swift database - fast, simple and lightweight (iOS, macOS)
Swift
438
star
4

objectbox-examples

Examples for ObjectBox Android/Java, the super-fast database
Java
396
star
5

objectbox-c

C and C++ database for objects and structs
C
176
star
6

objectbox-performance

Performance Benchmarking App for ObjectBox, SQLite(via Room and greenDAO), Realm
Java
130
star
7

objectbox-python

Superfast on-device object & vector database for Python
Python
113
star
8

objectbox-generator

ObjectBox Generator based on FlatBuffers schema files (fbs) for C and C++ (more languages in the future)
Go
35
star
9

objectbox-dart-performance

Flutter App benchmarking the performance of ObjectBox against others (e.g. sqflite, Hive).
Dart
11
star
10

objectbox-azure-sphere

Azure Sphere client connecting to ObjectBox
C
7
star
11

objectbox-go-performance

Open Source Performance Benchmarks for ObjectBox Go, GORM, and others
Go
6
star
12

objectbox-swift-performance

Open Source Performance Benchmarks for ObjectBox Swift
Swift
6
star
13

objectbox-swift-generator

Code generator and model.json builder for the ObjectBox database library. This is currently a quick fork off of Sourcery.
Swift
5
star
14

objectbox-ts-demo

Time Series example project for ObjectBox TS
C++
4
star
15

flatbuffers-benchmark

Testing the FlatBuffers performance of different programming languages
Dart
2
star
16

objectbox-swift-spec-staging

Staging repository for pre-releases. In general, you'd want the official repository at https://github.com/objectbox/objectbox-swift/
Ruby
2
star
17

objectbox-swift-integration-test

Roff
2
star
18

cla

2
star
19

objectbox-java-generator

The ObjectBox Gradle Plugin makes using ObjectBox easy in a JVM or Android project written in Java or Kotlin
Kotlin
2
star
20

.github

1
star
21

objectbox-go-gitbook

1
star
22

objectbox-docs

Official Documentation for ObjectBox, the object and vector database
Shell
1
star