This is the ObjectBox documentation for our Go API. We strive to provide you with the easiest and fastest solution to store and retrieve data.

Your feedback on ObjectBox and this documentation is very welcome. Use the "Was this page helpful?" smiley at the end of each page or send us your comments to contact[at]objectbox.io - thank you! :)

Changelog

v1.1.0 (2019-12-16)

• add Box Insert and Update methods with stricter semantics than Put

• add AsyncBox with Put, Insert, Update, Remove

• add Query order and parameter alias support - see Queries docs for more info

• Code generator improvements

  • handle type-checker errors more gracefully (don't fail on failures in unneeded imports)

  • add clean command-line option to remove all generated files

  • time.Time will automatically use a built in converter to Unix timestamp (milliseconds)

  • improve model.json file diff-level compatibility with other language bindings

  • embedded struct and to-one relations cycle detection

  • support changing property type and resetting its stored value

  • nil check for embedded pointer structs in the generated code

  • minor bug fixes when the generated code wouldn't compile in some edge cases

• update to the latest ObjectBox-C library v0.8.1

• deprecate box.PutAsync() in favor of box.async().Put() i.e. using AsyncBox

• mark byte properties as unsigned

• fix getters on objects with missing relations and non-existent IDs in GetMany

• better windows installation experience using a PowerShell script

• make golint happier :)

v1.0.0 (2019-07-16)

This is quite a big release, bringing some new features and cleaning up the API.

• explicit transaction support via ObjectBox::RunInReadTx and ObjectBox::RunInWriteTx

• Go Modules support

• add objectbox namespace to tags to align with reflect.StructTag.Get unofficial spec

• optional lazy loading on to-many relations - lazy annotation

• box additions:

  • GetMany , RemoveMany, RemoveIds, ContainsIds, RemoveIds

  • to-many relation auxiliary methods: RelationIds , RelationPut, RelationRemove, RelationReplace

• switch default/recommended go:generate entity generator command from objectbox-gogen to //go:generate go run github.com/objectbox/objectbox-go/cmd/objectbox-gogen

• quite a few internal changes, renames and other refactorings (e.g. renamed PutAll to PutMany, removed Cursor, aligned model JSON with other bindings, ...)

v0.9.0 (2019-04-24)

• Fixed macOS build and 32-bit query support.

• Minor refactoring/linter issues

v0.9.0-rc (2019-02-22)

As we queued up quite a few changes, we're doing a release candidate first for you to test:

• Improved relations support

• Embedded structs

• Custom value-converter to store unsupported types & structs that can't be inlined/prefixed

• Recognize and handle type aliases and named types used as entity fields

• New Box methods: CountMax(), IsEmpty(), Contains() and PutAsyncWithTimeout()

• Query support AND & OR (combine conditions)

• New Query methods: Limit, Offset​

• New Query methods: Set*Params (type-based) - to run a cached query with custom parameters

• Query LT|GT|Between support for unsigned numbers

• Support numeric string ID in the entity

• Support for[]string as a field type

• Optional pass/return-by-value for slice-of-structs in the generated code

• Change strings to use hash-based instead of value-based indexes by default

• A new option to AlwaysAwaitAsync that can be enabled during initialization

v0.8.0 (2018-12-06)

• New Query API​

• Box and Query do not require manual closing anymore

• Support for renaming entities and their properties using UIDs

v0.7.1 (2018-11-30)

• Fixed wrong mapping for Go types (u)int and (u)int8. Luckily we noticed this very early: if you used those types in previous versions, please delete old database files.

• Transactions are now safely aborted in case of panics

v0.7.0 (2018-11-29)

• Changed file name of generated code, e.g. file endings for model is now ".obx.go"

• Foundation for all query conditions (final query API will come with the next version)

• Put(object) now assigns the new id to the object itself

v0.6.0 (2018-11-28)

Initial public release