perf

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var EntityBinding = entity_EntityInfo{
	Entity: objectbox.Entity{
		Id: 1,
	},
	Uid: 1737161401460991620,
}
View Source 
var Entity_ = struct {
	ID      *objectbox.PropertyUint64
	Int32   *objectbox.PropertyInt32
	Int64   *objectbox.PropertyInt64
	String  *objectbox.PropertyString
	Float64 *objectbox.PropertyFloat64
}{
	ID: &objectbox.PropertyUint64{
		BaseProperty: &objectbox.BaseProperty{
			Id:     1,
			Entity: &EntityBinding.Entity,
		},
	},
	Int32: &objectbox.PropertyInt32{
		BaseProperty: &objectbox.BaseProperty{
			Id:     2,
			Entity: &EntityBinding.Entity,
		},
	},
	Int64: &objectbox.PropertyInt64{
		BaseProperty: &objectbox.BaseProperty{
			Id:     3,
			Entity: &EntityBinding.Entity,
		},
	},
	String: &objectbox.PropertyString{
		BaseProperty: &objectbox.BaseProperty{
			Id:     4,
			Entity: &EntityBinding.Entity,
		},
	},
	Float64: &objectbox.PropertyFloat64{
		BaseProperty: &objectbox.BaseProperty{
			Id:     5,
			Entity: &EntityBinding.Entity,
		},
	},
}

Entity_ contains type-based Property helpers to facilitate some common operations such as Queries.

Functions

func ObjectBoxModel 

func ObjectBoxModel() *objectbox.Model

ObjectBoxModel declares and builds the model from all the entities in the package. It is usually used when setting-up ObjectBox as an argument to the Builder.Model() function.

Types

type Entity 

type Entity struct {
	ID      uint64
	Int32   int32
	Int64   int64
	String  string
	Float64 float64
}

Entity model

type EntityAsyncBox added in v1.1.0 

type EntityAsyncBox struct {
	*objectbox.AsyncBox
}

EntityAsyncBox provides asynchronous operations on Entity objects.

Asynchronous operations are executed on a separate internal thread for better performance.

There are two main use cases:

1) "execute & forget:" you gain faster put/remove operations as you don't have to wait for the transaction to finish.

2) Many small transactions: if your write load is typically a lot of individual puts that happen in parallel, this will merge small transactions into bigger ones. This results in a significant gain in overall throughput.

In situations with (extremely) high async load, an async method may be throttled (~1ms) or delayed up to 1 second. In the unlikely event that the object could still not be enqueued (full queue), an error will be returned.

Note that async methods do not give you hard durability guarantees like the synchronous Box provides. There is a small time window in which the data may not have been committed durably yet.

func AsyncBoxForEntity added in v1.1.0 

func AsyncBoxForEntity(ob *objectbox.ObjectBox, timeoutMs uint64) *EntityAsyncBox

AsyncBoxForEntity creates a new async box with the given operation timeout in case an async queue is full. The returned struct must be freed explicitly using the Close() method. It's usually preferable to use EntityBox::Async() which takes care of resource management and doesn't require closing.

func (*EntityAsyncBox) Insert added in v1.1.0 

func (asyncBox *EntityAsyncBox) Insert(object *Entity) (id uint64, err error)

Insert a single object asynchronously. The ID property on the passed object will be assigned the new ID the entity would hold if the insert is ultimately successful. The newly assigned ID may not become valid if the insert fails. Fails silently if an object with the same ID already exists (this error is not returned).

func (*EntityAsyncBox) Put added in v1.1.0 

func (asyncBox *EntityAsyncBox) Put(object *Entity) (uint64, error)

Put inserts/updates a single object asynchronously. When inserting a new object, the ID property on the passed object will be assigned the new ID the entity would hold if the insert is ultimately successful. The newly assigned ID may not become valid if the insert fails.

func (*EntityAsyncBox) Remove added in v1.1.0 

func (asyncBox *EntityAsyncBox) Remove(object *Entity) error

Remove deletes a single object asynchronously.

func (*EntityAsyncBox) Update added in v1.1.0 

func (asyncBox *EntityAsyncBox) Update(object *Entity) error

Update a single object asynchronously. The object must already exists or the update fails silently (without an error returned).

type EntityBox 

type EntityBox struct {
	*objectbox.Box
}

Box provides CRUD access to Entity objects

func BoxForEntity 

func BoxForEntity(ob *objectbox.ObjectBox) *EntityBox

BoxForEntity opens a box of Entity objects

func (*EntityBox) Async added in v1.1.0 

func (box *EntityBox) Async() *EntityAsyncBox

Async provides access to the default Async Box for asynchronous operations. See EntityAsyncBox for more information.

func (*EntityBox) Get 

func (box *EntityBox) Get(id uint64) (*Entity, error)

Get reads a single object.

Returns nil (and no error) in case the object with the given ID doesn't exist.

func (*EntityBox) GetAll 

func (box *EntityBox) GetAll() ([]*Entity, error)

GetAll reads all stored objects

func (*EntityBox) GetMany added in v1.0.0 

func (box *EntityBox) GetMany(ids ...uint64) ([]*Entity, error)

GetMany reads multiple objects at once. If any of the objects doesn't exist, its position in the return slice is nil

func (*EntityBox) GetManyExisting added in v1.1.0 

func (box *EntityBox) GetManyExisting(ids ...uint64) ([]*Entity, error)

GetManyExisting reads multiple objects at once, skipping those that do not exist.

func (*EntityBox) Insert added in v1.1.0 

func (box *EntityBox) Insert(object *Entity) (uint64, error)

Insert synchronously inserts a single object. As opposed to Put, Insert will fail if given an ID that already exists. In case the ID is not specified, it would be assigned automatically (auto-increment). When inserting, the Entity.ID property on the passed object will be assigned the new ID as well.

func (*EntityBox) Put added in v0.7.0 

func (box *EntityBox) Put(object *Entity) (uint64, error)

Put synchronously inserts/updates a single object. In case the ID is not specified, it would be assigned automatically (auto-increment). When inserting, the Entity.ID property on the passed object will be assigned the new ID as well.

func (*EntityBox) PutAsync added in v0.7.0 

func (box *EntityBox) PutAsync(object *Entity) (uint64, error)

PutAsync asynchronously inserts/updates a single object. Deprecated: use box.Async().Put() instead

func (*EntityBox) PutMany added in v1.0.0 

func (box *EntityBox) PutMany(objects []*Entity) ([]uint64, error)

PutMany inserts multiple objects in single transaction. In case IDs are not set on the objects, they would be assigned automatically (auto-increment).

Returns: IDs of the put objects (in the same order). When inserting, the Entity.ID property on the objects in the slice will be assigned the new IDs as well.

Note: In case an error occurs during the transaction, some of the objects may already have the Entity.ID assigned even though the transaction has been rolled back and the objects are not stored under those IDs.

Note: The slice may be empty or even nil; in both cases, an empty IDs slice and no error is returned.

func (*EntityBox) Query added in v0.8.0 

func (box *EntityBox) Query(conditions ...objectbox.Condition) *EntityQuery

Creates a query with the given conditions. Use the fields of the Entity_ struct to create conditions. Keep the *EntityQuery if you intend to execute the query multiple times. Note: this function panics if you try to create illegal queries; e.g. use properties of an alien type. This is typically a programming error. Use QueryOrError instead if you want the explicit error check.

func (*EntityBox) QueryOrError added in v0.8.0 

func (box *EntityBox) QueryOrError(conditions ...objectbox.Condition) (*EntityQuery, error)

Creates a query with the given conditions. Use the fields of the Entity_ struct to create conditions. Keep the *EntityQuery if you intend to execute the query multiple times.

func (*EntityBox) Remove 

func (box *EntityBox) Remove(object *Entity) error

Remove deletes a single object

func (*EntityBox) RemoveMany added in v1.0.0 

func (box *EntityBox) RemoveMany(objects ...*Entity) (uint64, error)

RemoveMany deletes multiple objects at once. Returns the number of deleted object or error on failure. Note that this method will not fail if an object is not found (e.g. already removed). In case you need to strictly check whether all of the objects exist before removing them, you can execute multiple box.Contains() and box.Remove() inside a single write transaction.

func (*EntityBox) Update added in v1.1.0 

func (box *EntityBox) Update(object *Entity) error

Update synchronously updates a single object. As opposed to Put, Update will fail if an object with the same ID is not found in the database.

type EntityQuery added in v0.8.0 

type EntityQuery struct {
	*objectbox.Query
}

Query provides a way to search stored objects

For example, you can find all Entity which ID is either 42 or 47: 

box.Query(Entity_.ID.In(42, 47)).Find()

func (*EntityQuery) Find added in v0.8.0 

func (query *EntityQuery) Find() ([]*Entity, error)

Find returns all objects matching the query

func (*EntityQuery) Limit added in v0.9.0 

func (query *EntityQuery) Limit(limit uint64) *EntityQuery

Limit sets the number of elements to process by the query

func (*EntityQuery) Offset added in v0.9.0 

func (query *EntityQuery) Offset(offset uint64) *EntityQuery

Offset defines the index of the first object to process (how many objects to skip)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.