Allow adding entity flags for Sync

Author: Shubham

objectbox/__init__.py

@@ -16,7 +16,7 @@
 
 from objectbox.store import Store
 from objectbox.box import Box
-from objectbox.model.entity import Entity
+from objectbox.model.entity import Entity, SyncEntity
 from objectbox.model.properties import Id, String, Index, Bool, Int8, Int16, Int32, Int64, Float32, Float64, Bytes, BoolVector, Int8Vector, Int16Vector, Int32Vector, Int64Vector, Float32Vector, Float64Vector, CharVector, BoolList, Int8List, Int16List, Int32List, Int64List, Float32List, Float64List, CharList, Date, DateNano, Flex, HnswIndex, VectorDistanceType, HnswFlags
 from objectbox.model.model import Model
 from objectbox.c import version_core, DebugFlags
@@ -74,7 +74,8 @@
     'PropertyQueryCondition',
     'HnswFlags',
     'Query',
-    'QueryBuilder'
+    'QueryBuilder',
+    'SyncEntity'
 ]
 
 # Python binding version

objectbox/c.py

@@ -414,6 +414,11 @@ class DbErrorCode(IntEnum):
     OBX_ERROR_TREE_OTHER = 10699
 
 
+class OBXEntityFlags(IntEnum):
+    SYNC_ENABLED = 2
+    SHARED_GLOBAL_IDS = 4
+
+
 def check_obx_err(code: obx_err, func, args) -> obx_err:
     """ Raises an exception if obx_err is not successful. """
     if code != DbErrorCode.OBX_SUCCESS:
@@ -535,6 +540,9 @@ def c_array_pointer(py_list: Union[List[Any], np.ndarray], c_type):
 obx_model_entity = c_fn_rc('obx_model_entity', [
     OBX_model_p, ctypes.c_char_p, obx_schema_id, obx_uid])
 
+# obx_err obx_model_entity_flags(OBX_model* model, uint32_t flags);
+obx_model_entity_flags = c_fn_rc('obx_model_entity_flags', [OBX_model_p, ctypes.c_uint32])
+
 # obx_err (OBX_model* model, const char* name, OBXPropertyType type, obx_schema_id property_id, obx_uid property_uid);
 obx_model_property = c_fn_rc('obx_model_property',
                              [OBX_model_p, ctypes.c_char_p, OBXPropertyType, obx_schema_id, obx_uid])

objectbox/model/entity.py

@@ -38,6 +38,7 @@ def __init__(self, user_type, uid: int = 0):
         self._id_property = None
         self._fill_properties()
         self._tl = threading.local()
+        self._flags = 0
 
     @property
     def _id(self) -> int:
@@ -320,3 +321,9 @@ def wrapper(class_) -> Callable[[Type], _Entity]:
         return entity_type
 
     return wrapper
+
+
+def SyncEntity(cls):
+    entity: _Entity = obx_models_by_name["default"][-1]  # get the last added entity
+    entity._flags |= OBXEntityFlags.SYNC_ENABLED
+    return cls

objectbox/model/model.py

@@ -102,6 +102,7 @@ def _create_property(self, prop: Property):
 
     def _create_entity(self, entity: _Entity):
         obx_model_entity(self._c_model, c_str(entity._name), entity._id, entity._uid)
+        obx_model_entity_flags(self._c_model, entity._flags)
         for prop in entity._properties:
             self._create_property(prop)
         obx_model_entity_last_property_id(self._c_model, entity._last_property_iduid.id, entity._last_property_iduid.uid)