Package io.objectbox

Class BoxStoreBuilder

    • Field Detail


        public static final int DEFAULT_MAX_DB_SIZE_KBYTE
        The default maximum size the DB can grow to, which can be overwritten using maxSizeInKByte.
        See Also:
        Constant Field Values
    • Constructor Detail

      • BoxStoreBuilder

        public BoxStoreBuilder​(byte[] model)
        Called internally from the generated class "MyObjectBox". Check MyObjectBox.builder() to get an instance.
    • Method Detail

      • createDebugWithoutModel

        public static BoxStoreBuilder createDebugWithoutModel()
        Not for application use, for DebugCursor.
      • baseDirectory

        public BoxStoreBuilder baseDirectory​( baseDirectory)
        In combination with name(String), this lets you specify the location of where the DB files should be stored. Cannot be used in combination with directory(File).
      • androidContext

        public BoxStoreBuilder androidContext​(java.lang.Object context)
        On Android, you can pass a Context to set the base directory using this method. This will conveniently configure the storage location to be in the files directory of your app.

        In more detail, this assigns the base directory (see baseDirectory) to context.getFilesDir() + "/objectbox/". Thus, when using the default name (also "objectbox" unless overwritten using name(String)), the default location of DB files will be "objectbox/objectbox/" inside the app files directory. If you specify a custom name, for example with name("foobar"), it would become "objectbox/foobar/".

        Alternatively, you can also use baseDirectory or directory(File) instead.

      • androidReLinker

        public BoxStoreBuilder androidReLinker​(java.lang.Object reLinkerInstance)
        Pass a custom ReLinkerInstance, for example ReLinker.log(logger) to use for loading the native library on Android devices. Note that setting androidContext(Object) is required for ReLinker to work.
      • fileMode

        public BoxStoreBuilder fileMode​(int mode)
        Specify unix-style file permissions for database files. E.g. for -rw-r---- (owner, group, other) pass the octal code 0640. Any newly generated directory additionally gets searchable (01) for groups with read or write permissions. It's not allowed to pass in an executable flag.
      • maxReaders

        public BoxStoreBuilder maxReaders​(int maxReaders)
        Sets the maximum number of concurrent readers. For most applications, the default is fine (about 126 readers).

        A "reader" is short for a thread involved in a read transaction. If the maximum is exceeded the store throws DbMaxReadersExceededException. In this case check that your code only uses a reasonable amount of threads.

        For highly concurrent setups (e.g. you are using ObjectBox on the server side) it may make sense to increase the number.

        Note: Each thread that performed a read transaction and is still alive holds on to a reader slot. These slots only get vacated when the thread ends. Thus, be mindful with the number of active threads. Alternatively, you can try the experimental noReaderThreadLocals() option flag.

      • noReaderThreadLocals

        public BoxStoreBuilder noReaderThreadLocals()
        Disables the usage of thread locals for "readers" related to read transactions. This can make sense if you are using a lot of threads that are kept alive.

        Note: This is still experimental, as it comes with subtle behavior changes at a low level and may affect corner cases with e.g. transactions, which may not be fully tested at the moment.

      • maxSizeInKByte

        public BoxStoreBuilder maxSizeInKByte​(long maxSizeInKByte)
        Sets the maximum size the database file can grow to. When applying a transaction (e.g. putting an object) would exceed it a DbFullException is thrown.

        By default, this is 1 GB, which should be sufficient for most applications. In general, a maximum size prevents the database from growing indefinitely when something goes wrong (for example data is put in an infinite loop).

        This value can be changed, so increased or also decreased, each time when opening a store.

      • maxDataSizeInKByte

        public BoxStoreBuilder maxDataSizeInKByte​(long maxDataSizeInKByte)
        This API is experimental and may change or be removed in future releases.

        Sets the maximum size the data stored in the database can grow to. When applying a transaction (e.g. putting an object) would exceed it a DbMaxDataSizeExceededException is thrown.

        Must be below maxSizeInKByte(long).

        Different from maxSizeInKByte(long) this only counts bytes stored in objects, excluding system and metadata. However, it is more involved than database size tracking, e.g. it stores an internal counter. Only use this if a stricter, more accurate limit is required.

        When the data limit is reached, data can be removed to get below the limit again (assuming the database size limit is not also reached).

      • readOnly

        public BoxStoreBuilder readOnly()
        Open the store in read-only mode: no schema update, no write transactions are allowed (would throw).
      • usePreviousCommit

        public BoxStoreBuilder usePreviousCommit()
        Ignores the latest data snapshot (committed transaction state) and uses the previous snapshot instead. When used with care (e.g. backup the DB files first), this option may also recover data removed by the latest transaction.

        To ensure no data is lost accidentally, it is recommended to use this in combination with readOnly() to examine and validate the database first.

      • validateOnOpen

        public BoxStoreBuilder validateOnOpen​(short validateOnOpenModePages)
        When a database is opened, ObjectBox can perform additional consistency checks on its database structure. Reliable file systems already guarantee consistency, so this is primarily meant to deal with unreliable OSes, file systems, or hardware.

        Note: ObjectBox builds upon ACID storage, which already has strong consistency mechanisms in place.

        See also validateOnOpenPageLimit(long) to fine-tune this check and validateOnOpenKv(short) for additional checks.

        validateOnOpenModePages - One of ValidateOnOpenModePages.
      • validateOnOpenKv

        public BoxStoreBuilder validateOnOpenKv​(short mode)
        When a database is opened, ObjectBox can perform additional consistency checks on its database structure. This enables validation checks on a key/value level.

        See also validateOnOpen(short) for additional consistency checks.

        mode - One of ValidateOnOpenModeKv.
      • debugRelations

        public BoxStoreBuilder debugRelations()
        Enables some debug logging for relations.
      • queryAttempts

        public BoxStoreBuilder queryAttempts​(int queryAttempts)
        For massive concurrent setups (app is using a lot of threads), you can enable automatic retries for queries. This can resolve situations in which resources are getting sparse (e.g. DbMaxReadersExceededException or other variations of DbException are thrown during query execution).
        queryAttempts - number of attempts a query find operation will be executed before failing. Recommended values are in the range of 2 to 5, e.g. a value of 3 as a starting point.
      • initialDbFile

        public BoxStoreBuilder initialDbFile​( initialDbFile)
        Let's you specify an DB file to be used during initial start of the app (no DB file exists yet).
      • initialDbFile

        public BoxStoreBuilder initialDbFile​(Factory<> 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). The provider will only be called if no DB file exists yet.
      • build

        public BoxStore build()
        Builds a BoxStore using any given configuration.