Merge branch '12-index-support' into dev

Author: greenrobot

objectbox/model/properties.py

@@ -64,8 +64,14 @@ class PropertyType(IntEnum):
 }
 
 
+class IndexType(IntEnum):
+    value = OBXPropertyFlags_INDEXED
+    hash = OBXPropertyFlags_INDEX_HASH
+    hash64 = OBXPropertyFlags_INDEX_HASH64
+
+
 class Property:
-    def __init__(self, py_type: type, id: int, uid: int, type: PropertyType = None):
+    def __init__(self, py_type: type, id: int, uid: int, type: PropertyType = None, index: bool = None, index_type: IndexType = None):
         self._id = id
         self._uid = uid
         self._name = ""  # set in Entity.fill_properties()
@@ -82,6 +88,18 @@ def __init__(self, py_type: type, id: int, uid: int, type: PropertyType = None):
         self._fb_slot = self._id - 1
         self._fb_v_offset = 4 + 2*self._fb_slot
 
+        if index_type:
+            if index == True or index == None:
+                self._index = True
+                self._index_type = index_type
+            elif index == False:
+                raise Exception(f"trying to set index type on property with id {self._id} while index is set to False")
+        else:
+            self._index = index if index != None else False
+            if index:
+                self._index_type = IndexType.value if self._py_type != str else IndexType.hash
+
+
     def __determine_ob_type(self) -> OBXPropertyType:
         ts = self._py_type
         if ts == str:

tests/model.py

@@ -1,4 +1,5 @@
 from objectbox.model import *
+from objectbox.model.properties import IndexType
 import numpy as np
 from datetime import datetime
 from typing import Generic, Dict, Any
@@ -7,15 +8,17 @@
 @Entity(id=1, uid=1)
 class TestEntity:
     id = Id(id=1, uid=1001)
-    str = Property(str, id=2, uid=1002)
+    # TODO Enable indexing dynamically, e.g. have a constructor to enable index(es).
+    #      E.g. indexString=False (defaults to false). Same for bytes.
+    str = Property(str, id=2, uid=1002, index=True)
     bool = Property(bool, id=3, uid=1003)
-    int64 = Property(int, type=PropertyType.long, id=4, uid=1004)
-    int32 = Property(int, type=PropertyType.int, id=5, uid=1005)
-    int16 = Property(int, type=PropertyType.short, id=6, uid=1006)
+    int64 = Property(int, type=PropertyType.long, id=4, uid=1004, index=True)
+    int32 = Property(int, type=PropertyType.int, id=5, uid=1005, index=True, index_type=IndexType.hash)
+    int16 = Property(int, type=PropertyType.short, id=6, uid=1006, index_type=IndexType.hash)
     int8 = Property(int, type=PropertyType.byte, id=7, uid=1007)
     float64 = Property(float, type=PropertyType.double, id=8, uid=1008)
     float32 = Property(float, type=PropertyType.float, id=9, uid=1009)
-    bytes = Property(bytes, id=10, uid=1010)
+    bytes = Property(bytes, id=10, uid=1010, index_type=IndexType.hash64)
     ints = Property(np.ndarray, type=PropertyType.intVector, id=11, uid=1011)
     longs = Property(np.ndarray, type=PropertyType.longVector, id=12, uid=1012)
     floats = Property(np.ndarray, type=PropertyType.floatVector, id=13, uid=1013)
@@ -32,6 +35,7 @@ class TestEntity:
     def __init__(self, string: str = ""):
         self.str = string
 
+
 @Entity(id=2, uid=2)
 class TestEntityDatetime:
     id = Id(id=1, uid=2001)

tests/test_index.py

@@ -0,0 +1,44 @@
+import objectbox
+from objectbox.model import *
+from objectbox.model.properties import IndexType
+import pytest
+from tests.model import TestEntity
+from tests.common import (
+    autocleanup,
+    load_empty_test_objectbox,
+)
+
+def test_index_basics():
+    ob = load_empty_test_objectbox()
+    box = objectbox.Box(ob, TestEntity)
+
+    # create
+    object = TestEntity()
+    box.put(object)
+
+    # string - default index type is hash
+    assert box._entity.properties[1]._index_type == IndexType.hash
+
+    # int64 - default index type is value
+    assert box._entity.properties[3]._index_type == IndexType.value
+
+    # int32 - index type overwritten to hash
+    assert box._entity.properties[4]._index_type == IndexType.hash
+
+    # int16 - specify index type w/o explicitly enabling index
+    assert box._entity.properties[5]._index_type == IndexType.hash
+
+    # bytes - index type overwritten to hash64
+    assert box._entity.properties[9]._index_type == IndexType.hash64
+
+
+def test_index_error():
+    @Entity(id=3, uid=3)
+    class TestEntityInvalidIndex:
+        id = Id(id=1, uid=3001)
+
+        # Cannot set index type when index is False
+        try:
+            str = Property(str, id=2, uid=3002, index=False, index_type=IndexType.hash)
+        except Exception:
+            assert pytest.raises(Exception, match='trying to set index type on property of id 2 while index is set to False')