ObjectBox Go API

ObjectBox is a superfast database for objects. Using this Golang API, you can use ObjectBox as an embedded database in your Go application. A client/server mode will follow soon.

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: v0.7.1 (2018-11-30)

Some features

Queries
Secondary indexes based on object properties
Asynchronous puts
Automatic model migration (no schema upgrade scripts etc.)
(Coming soon: Powerful queries)
(Coming soon: Relations to other objects)

Installation

To get started with ObjectBox you can get the repository code as usual with go get and install the two prerequisites - pre-compiled library and a bindings generator.

go get github.com/objectbox/objectbox-go
go get github.com/google/flatbuffers/go
go install github.com/objectbox/objectbox-go/cmd/objectbox-gogen/

mkdir objectboxlib && cd objectboxlib
curl https://raw.githubusercontent.com/objectbox/objectbox-c/master/download.sh > download.sh
bash download.sh

See installation docs for more details and further instructions.

Additionally, you can run tests to validate your installation

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

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)
libobjectbox
ObjectBox code generator

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

This repository also come with a install.sh script that can be used for installation and upgrading:

~/go/src/github.com/objectbox/objectbox-go/install.sh

Docs

To get started, please have a look at the examples directory and ObjectBox Go docs.

Also, check the ObjectBox GoDocs - and the sources in this repo.

Documentation is still on-going work; expect more soon.

License

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

devhttps / objectbox-go