Package io.objectbox.sync

Class SyncFlags

java.lang.Object

io.objectbox.sync.SyncFlags

public final class SyncFlags
extends Object

Flags to adjust sync behavior like additional logging.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ClientKeepDataOnSyncError	If the client gets in a state that does not allow any further synchronization, this flag instructs Sync to keep local data nevertheless.
static final int	DebugLogFilterVariables	Logs sync filter variables used for each client, e.g.
static final int	DebugLogIdMapping	Enable (rather extensive) logging on how IDs are mapped (local <-> global)
static final int	DebugLogTxLogs	Enables debug logging of TX log processing.
static final int	RemoveWithObjectData	When set, remove operations will include the full object data in the TX log (REMOVE_OBJECT command).
static final int	SkipInvalidTxOps	Skips invalid (put object) operations in the TX log instead of failing.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DebugLogIdMapping

public static final int DebugLogIdMapping

Enable (rather extensive) logging on how IDs are mapped (local <-> global)

See Also:

• Constant Field Values

ClientKeepDataOnSyncError

public static final int ClientKeepDataOnSyncError

If the client gets in a state that does not allow any further synchronization, this flag instructs Sync to keep local data nevertheless. While this preserves data, you need to resolve the situation manually. For example, you could backup the data and start with a fresh database. Note that the default behavior (this flag is not set) is to wipe existing data from all sync-enabled types and sync from scratch from the server. Client-only: setting this flag for Sync server has no effect.

See Also:

• Constant Field Values

DebugLogFilterVariables

public static final int DebugLogFilterVariables

Logs sync filter variables used for each client, e.g. values provided by JWT or the client's login message. Server-only: setting this flag for Sync client has no effect.

See Also:

• Constant Field Values

RemoveWithObjectData

public static final int RemoveWithObjectData

When set, remove operations will include the full object data in the TX log (REMOVE_OBJECT command). This allows sync filters to filter out remove operations based on the object content. Without this flag, remove operations only contain the object ID and cannot be filtered. Note: this increases the size of TX logs for remove operations.

See Also:

• Constant Field Values

DebugLogTxLogs

public static final int DebugLogTxLogs

Enables debug logging of TX log processing. For now, this only has an effect on SyncClients (Sync Server has extensive debug logs already).

See Also:

• Constant Field Values

SkipInvalidTxOps

public static final int SkipInvalidTxOps

Skips invalid (put object) operations in the TX log instead of failing.

See Also:

• Constant Field Values