All Classes and Interfaces
Class
Description
Defines a backlink relation, which is based on another relation reversing the direction.
Marks a class as an ObjectBox Entity super class.
APIs annotated with @Beta may change and may be even removed in a future release (but is somewhat less likely
compared to
Experimental).Used with
Unique to specify the conflict resolution strategy.Supplies a
converter to store custom Property types as a supported Convert.dbType().Use with
@Type to override how a property value is stored and interpreted in the database.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.
Marks a class as an ObjectBox Entity.
APIs annotated with @Experimental are likely to change and may be even removed in a future release.
Flags as a part of the
HnswIndex configuration.Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.
Marks the ID property of an
@Entity.Marks a property as a companion to an @Id property.
Specifies that the property should be indexed.
ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see
IndexType.DEFAULT).APIs annotated with @Internal must NOT be used.
Allows to specify a simple name mapping for entities and properties.
To use custom types in your entity, implement this to convert db values to entity values and back.
Enables sync for an
Entity class.Defines the property serving as the target ID of a ToOne.
Transient fields are not persisted in the database.
Use on a property to override how its value is stored and interpreted in the database.
UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
Enforces that the value of a property is unique among all objects in a box before an object can be put.
Indicates that values of an integer property (e.g.
The vector distance algorithm used by an
HnswIndex (vector search).