Package io.objectbox.annotation

package io.objectbox.annotation

Annotations to mark a class as an @Entity, to specify the @Id Property, to create an @Index or a @Transient Property.

For more details look at the documentation of individual classes and docs.objectbox.io/entity-annotations.

Related Packages

Package	Description
io.objectbox	ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
io.objectbox.annotation.apihint	Annotations to mark APIs as for example @Internal or @Experimental.

Class	Description
Backlink	Defines a backlink relation, which is based on another relation reversing the direction.
BaseEntity	Marks a class as an ObjectBox Entity super class.
ConflictStrategy	Used with Unique to specify the conflict resolution strategy.
Convert	Supplies a converter to store custom Property types as a supported Convert.dbType().
DatabaseType	Use with @Type to override how a property value is stored and interpreted in the database.
DefaultValue	Defines the Java code of the default value to use for a property, when getting an existing entity and the database value for the property is null.
Entity	Marks a class as an ObjectBox Entity.
ExternalPropertyType	A property type of an external system (e.g.
ExternalType	Sets the type of a property or the type of object IDs of a ToMany in an external system (like another database).
HnswFlags	Flags as a part of the HnswIndex configuration.
HnswIndex	Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
Id	Marks the ID property of an @Entity.
IdCompanion	Marks a property as a companion to an @Id property.
Index	Specifies that the property should be indexed.
IndexType	ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see IndexType.DEFAULT).
NameInDb	Allows to specify a simple name mapping for entities and properties.
Sync	Enables sync for an Entity class.
TargetIdProperty	Defines the property serving as the target ID of a ToOne.
Transient	Transient fields are not persisted in the database.
Type	Use on a property to override how its value is stored and interpreted in the database.
Uid	UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
Unique	Enforces that the value of a property is unique among all objects in a box before an object can be put.
Unsigned	Indicates that values of an integer property (e.g.
VectorDistanceType	The vector distance algorithm used by an HnswIndex (vector search).