Uses of Class
io.objectbox.BoxStoreBuilder

Packages that use BoxStoreBuilder

Package	Description
io.objectbox	ObjectBox is an an easy to use, object-oriented lightweight database and a full alternative to SQLite.
io.objectbox.sync	ObjectBox Sync allows to automatically synchronize local data with a sync destination (e.g.

Uses of BoxStoreBuilder in io.objectbox

Methods in io.objectbox that return BoxStoreBuilder

Modifier and Type	Method	Description
BoxStoreBuilder	BoxStoreBuilder.androidContext(Object context)	Use on Android to pass a Context for loading the native library and, if not an inMemory(String) database, for creating the base directory for database files in the files directory of the app.
BoxStoreBuilder	BoxStoreBuilder.androidReLinker(Object reLinkerInstance)	Pass a custom ReLinkerInstance, for example ReLinker.log(logger) to use for loading the native library on Android devices.
BoxStoreBuilder	BoxStoreBuilder.baseDirectory(File baseDirectory)	In combination with name(String), this lets you specify the location of where the DB files should be stored.
static BoxStoreBuilder	InternalAccess.clone(BoxStoreBuilder original, String namePostfix)
(package private) BoxStoreBuilder	BoxStoreBuilder.createClone(String namePostfix)
static BoxStoreBuilder	BoxStoreBuilder.createDebugWithoutModel()	Not for application use, for DebugCursor.
BoxStoreBuilder	BoxStoreBuilder.debugFlags(int debugFlags)	Debug flags typically enable additional logging, see DebugFlags for valid values.
BoxStoreBuilder	BoxStoreBuilder.debugRelations()	Enables some debug logging for relations.
BoxStoreBuilder	BoxStoreBuilder.debugTransactions()	Deprecated. Use debugFlags instead.
BoxStoreBuilder	BoxStoreBuilder.directory(File directory)	The directory where all database files should be placed in.
BoxStoreBuilder	BoxStoreBuilder.failedReadTxAttemptCallback(TxCallback<?> failedReadTxAttemptCallback)	Define a callback for failed read transactions during retires (see also queryAttempts(int)).
BoxStoreBuilder	BoxStoreBuilder.fileMode(int mode)	Specify unix-style file permissions for database files.
BoxStoreBuilder	BoxStoreBuilder.initialDbFile(Factory<InputStream> initialDbFileFactory)	Let's you specify a provider for a DB file to be used during initial start of the app (no DB file exists yet).
BoxStoreBuilder	BoxStoreBuilder.initialDbFile(File initialDbFile)	Let's you specify an DB file to be used during initial start of the app (no DB file exists yet).
BoxStoreBuilder	BoxStoreBuilder.inMemory(String identifier)	Switches to an in-memory database using the given name as its identifier.
BoxStoreBuilder	BoxStoreBuilder.maxDataSizeInKByte(long maxDataSizeInKByte)	Sets the maximum size the data stored in the database can grow to.
BoxStoreBuilder	BoxStoreBuilder.maxReaders(int maxReaders)	Sets the maximum number of concurrent readers.
BoxStoreBuilder	BoxStoreBuilder.maxSizeInKByte(long maxSizeInKByte)	Sets the maximum size the database file can grow to.
(package private) BoxStoreBuilder	BoxStoreBuilder.modelUpdate(ModelUpdate modelUpdate)
BoxStoreBuilder	BoxStoreBuilder.name(String name)	Name of the database, which will be used as a directory for database files.
BoxStoreBuilder	BoxStoreBuilder.noReaderThreadLocals()	Disables the usage of thread locals for "readers" related to read transactions.
BoxStoreBuilder	BoxStoreBuilder.queryAttempts(int queryAttempts)	For massive concurrent setups (app is using a lot of threads), you can enable automatic retries for queries.
BoxStoreBuilder	BoxStoreBuilder.readOnly()	Open the store in read-only mode: no schema update, no write transactions are allowed (would throw).
BoxStoreBuilder	BoxStoreBuilder.usePreviousCommit()	Ignores the latest data snapshot (committed transaction state) and uses the previous snapshot instead.
BoxStoreBuilder	BoxStoreBuilder.validateOnOpen(short validateOnOpenModePages)	When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
BoxStoreBuilder	BoxStoreBuilder.validateOnOpenKv()	When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
BoxStoreBuilder	BoxStoreBuilder.validateOnOpenKv(short mode)	When a database is opened, ObjectBox can perform additional consistency checks on its database structure.
BoxStoreBuilder	BoxStoreBuilder.validateOnOpenPageLimit(long limit)	To fine-tune validateOnOpen(short), you can specify a limit on how much data is looked at.

Methods in io.objectbox with parameters of type BoxStoreBuilder

Modifier and Type	Method	Description
static BoxStoreBuilder	InternalAccess.clone(BoxStoreBuilder original, String namePostfix)

Constructors in io.objectbox with parameters of type BoxStoreBuilder

Modifier	Constructor	Description
(package private)	BoxStore(BoxStoreBuilder builder)

Uses of BoxStoreBuilder in io.objectbox.sync

Methods in io.objectbox.sync with parameters of type BoxStoreBuilder

Modifier and Type	Method	Description
static SyncHybridBuilder	Sync.hybrid(BoxStoreBuilder storeBuilder, String url, SyncCredentials authenticatorCredentials)	Starts building a SyncHybrid, a client/server hybrid typically used for embedded cluster setups.

Constructors in io.objectbox.sync with parameters of type BoxStoreBuilder

Modifier	Constructor	Description
(package private)	SyncHybridBuilder(BoxStoreBuilder storeBuilder, String url, SyncCredentials authenticatorCredentials)	Internal API; use Sync.hybrid(BoxStoreBuilder, String, SyncCredentials) instead.