objectbox/properties: simplfied fundamental property names #29

Author: dan-obx

example/ollama/llamas.py

@@ -15,17 +15,15 @@
 
 
 from objectbox.model import *
-from objectbox.model.properties import *
-import numpy as np
 
 # Have fresh data for each start
 objectbox.Store.remove_db_files("objectbox")
 
 @Entity(id=1, uid=1)
 class DocumentEmbedding:
     id = Id(id=1, uid=1001)
-    document = Property(str, id=2, uid=1002)
-    embedding = Property(np.ndarray, type=PropertyType.floatVector, id=3, uid=1003, index=HnswIndex(
+    document = String(id=2, uid=1002)
+    embedding = Float32Vector(id=3, uid=1003, index=HnswIndex(
         id=3, uid=10001,
         dimensions=1024,
         distance_type=VectorDistanceType.COSINE

example/tasks/model.py

@@ -4,10 +4,10 @@
 @Entity(id=1, uid=1)
 class Task:
     id = Id(id=1, uid=1001)
-    text = Property(str, id=2, uid=1002)
+    text = String(id=2, uid=1002)
 
-    date_created = Property(int, type=PropertyType.date, id=3, uid=1003)
-    date_finished = Property(int, type=PropertyType.date, id=4, uid=1004)
+    date_created = Date(id=3, uid=1003)
+    date_finished = Date(id=4, uid=1004)
 
 
 def get_objectbox_model():

example/vectorsearch-cities/model.py

@@ -1,20 +1,15 @@
 from objectbox.model import *
-from objectbox.model.properties import *
-import objectbox
-import numpy as np
-
 
 @Entity(id=1, uid=1)
 class City:
     id = Id(id=1, uid=1001)
-    name = Property(str, id=2, uid=1002)
-    location = Property(np.ndarray, type=PropertyType.floatVector, id=3, uid=1003, index=HnswIndex(
+    name = String(id=2, uid=1002)
+    location = Float32Vector(id=3, uid=1003, index=HnswIndex(
         id=3, uid=10001,
         dimensions=2,
         distance_type=VectorDistanceType.EUCLIDEAN
     ))
 
-
 def get_objectbox_model():
     m = Model()
     m.entity(City, last_property_id=IdUid(3, 1003))

objectbox/model/__init__.py

@@ -20,8 +20,39 @@
 __all__ = [
     'Model',
     'Entity',
-    'Id',
     'IdUid',
     'Property',
-    'PropertyType'
+    'PropertyType',
+    'Id',
+    'IdUid',
+    'Bool',
+    'String',
+    'Int8',
+    'Int16',
+    'Int32',
+    'Int64',
+    'Float32',
+    'Float64',
+    'Date',
+    'DateNano',
+    'Flex',
+    'BoolVector',
+    'Int8Vector',
+    'Int16Vector',
+    'CharVector',
+    'Int32Vector',
+    'Int64Vector',
+    'Float32Vector',
+    'Float64Vector',
+    'Index',
+    'HnswIndex',
+    'VectorDistanceType',
+    'BoolList',
+    'Int8List',
+    'Int16List',
+    'CharList',
+    'Int32List',
+    'Int64List',
+    'Float32List',
+    'Float64List',
 ]

objectbox/model/properties.py

@@ -13,14 +13,14 @@
 # limitations under the License.
 
 from enum import IntEnum
+from datetime import datetime
 import flatbuffers.number_types
 import numpy as np
 from dataclasses import dataclass
 
 from objectbox.c import *
 from objectbox.condition import PropertyQueryCondition, PropertyQueryConditionOp
 
-
 class PropertyType(IntEnum):
     bool = OBXPropertyType_Bool
     byte = OBXPropertyType_Byte
@@ -183,26 +183,49 @@ def _set_flags(self):
             if isinstance(self._index, Index):  # Generic index
                 self._flags |= self._index.type
 
-    def equals(self, value, case_sensitive: bool = True) -> PropertyQueryCondition:
-        args = {'value': value, 'case_sensitive': case_sensitive}
+    def equals(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.EQ, args)
 
-    def not_equals(self, value, case_sensitive: bool = True) -> PropertyQueryCondition:
-        args = {'value': value, 'case_sensitive': case_sensitive}
+    def not_equals(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.NOT_EQ, args)
 
-    def contains(self, value: str, case_sensitive: bool = True) -> PropertyQueryCondition:
-        args = {'value': value, 'case_sensitive': case_sensitive}
-        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.CONTAINS, args)
+# ID property (primary key)
+class Id(Property):
+    def __init__(self, id : int = 0, uid : int = 0, py_type: type = int):
+        super(Id, self).__init__(py_type, id=id, uid=uid)
 
+# Bool property
+class Bool(Property):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Bool, self).__init__(bool, type=PropertyType.bool, id=id, uid=uid, **kwargs)
+
+# String property with starts/ends_with
+class String(Property):
+    def __init__(self, id: int = 0, uid : int = 0, **kwargs):
+        super(String, self).__init__(str, type=PropertyType.string, id=id, uid=uid, **kwargs)
+        
     def starts_with(self, value: str, case_sensitive: bool = True) -> PropertyQueryCondition:
         args = {'value': value, 'case_sensitive': case_sensitive}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.STARTS_WITH, args)
 
     def ends_with(self, value: str, case_sensitive: bool = True) -> PropertyQueryCondition:
         args = {'value': value, 'case_sensitive': case_sensitive}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.ENDS_WITH, args)
+    
+    def equals(self, value, case_sensitive: bool = True) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': case_sensitive}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.EQ, args)
 
+    def not_equals(self, value, case_sensitive: bool = True) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': case_sensitive}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.NOT_EQ, args)
+    
+    def contains(self, value: str, case_sensitive: bool = True) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': case_sensitive}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.CONTAINS, args)
+    
     def greater_than(self, value, case_sensitive: bool = True) -> PropertyQueryCondition:
         args = {'value': value, 'case_sensitive': case_sensitive}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.GT, args)
@@ -218,21 +241,154 @@ def less_than(self, value, case_sensitive: bool = True) -> PropertyQueryConditio
     def less_or_equal(self, value, case_sensitive: bool = True) -> PropertyQueryCondition:
         args = {'value': value, 'case_sensitive': case_sensitive}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.LTE, args)
+    
+
+# Numeric Properties
+class _NumericProperty(Property):
+    def __init__(self, py_type : Type, **kwargs):
+        super(_NumericProperty, self).__init__(py_type, **kwargs)
+    
+    def equals(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.EQ, args)
+
+    def not_equals(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.NOT_EQ, args)
+    
+    def greater_than(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.GT, args)
+
+    def greater_or_equal(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.GTE, args)
+
+    def less_than(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.LT, args)
+
+    def less_or_equal(self, value) -> PropertyQueryCondition:
+        args = {'value': value, 'case_sensitive': False}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.LTE, args)
 
     def between(self, a, b) -> PropertyQueryCondition:
         args = {'a': a, 'b': b}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.BETWEEN, args)
 
-    def nearest_neighbor(self, query_vector, element_count: int) -> PropertyQueryCondition:
-        args = {'query_vector': query_vector, 'element_count': element_count}
-        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.NEAREST_NEIGHBOR, args)
 
+# Signed Integer Numeric Properties
+class Int8(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Int8, self).__init__(int, type=PropertyType.byte, id=id, uid=uid, **kwargs)
+class Int16(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Int16, self).__init__(int, type=PropertyType.short, id=id, uid=uid, **kwargs)
+class Int32(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Int32, self).__init__(int, type=PropertyType.int, id=id, uid=uid, **kwargs)
+class Int64(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Int64, self).__init__(int, type=PropertyType.long, id=id, uid=uid, **kwargs)
+        
+# Floating-Point Numeric Properties
+class Float32(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Float32, self).__init__(float, type=PropertyType.float, id=id, uid=uid, **kwargs)
+
+class Float64(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Float64, self).__init__(float, type=PropertyType.double, id=id, uid=uid, **kwargs)
+
+# Date Properties
+class Date(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Date, self).__init__(int, type=PropertyType.date, id=id, uid=uid, **kwargs)
+
+class DateNano(_NumericProperty):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(DateNano, self).__init__(int, type=PropertyType.dateNano, id=id, uid=uid, **kwargs)
+
+# Flex Property
+class Flex(Property):
+    def __init__(self, id : int = 0, uid : int = 0, **kwargs):
+        super(Flex, self).__init__(Generic, type=PropertyType.flex, id=id, uid=uid, **kwargs)
     def contains_key_value(self, key: str, value: str, case_sensitive: bool = True) -> PropertyQueryCondition:
         args = {'key': key, 'value': value, 'case_sensitive': case_sensitive}
         return PropertyQueryCondition(self._id, PropertyQueryConditionOp.CONTAINS_KEY_VALUE, args)
 
 
-# ID property (primary key)
-class Id(Property):
-    def __init__(self, py_type: type = int, id: int = 0, uid: int = 0):
-        super(Id, self).__init__(py_type, id=id, uid=uid)
+
+class _VectorProperty(Property):
+    def __init__(self, py_type : Type, **kwargs):
+        super(_VectorProperty, self).__init__(py_type, **kwargs)
+    def nearest_neighbor(self, query_vector, element_count: int) -> PropertyQueryCondition:
+        args = {'query_vector': query_vector, 'element_count': element_count}
+        return PropertyQueryCondition(self._id, PropertyQueryConditionOp.NEAREST_NEIGHBOR, args)
+
+class BoolVector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(BoolVector, self).__init__(np.ndarray, type=PropertyType.boolVector, id=id, uid=uid, **kwargs)
+class Int8Vector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int8Vector, self).__init__(bytes, type=PropertyType.byteVector, id=id, uid=uid, **kwargs)
+
+class Int16Vector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int16Vector, self).__init__(np.ndarray, type=PropertyType.shortVector, id=id, uid=uid, **kwargs)
+
+class CharVector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(CharVector, self).__init__(np.ndarray, type=PropertyType.charVector, id=id, uid=uid, **kwargs)
+ 
+class Int32Vector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int32Vector, self).__init__(np.ndarray, type=PropertyType.intVector, id=id, uid=uid, **kwargs)
+
+class Int64Vector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int64Vector, self).__init__(np.ndarray, type=PropertyType.longVector, id=id, uid=uid, **kwargs)
+
+class Float32Vector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Float32Vector, self).__init__(np.ndarray, type=PropertyType.floatVector, id=id, uid=uid, **kwargs)
+
+class Float64Vector(_VectorProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Float64Vector, self).__init__(np.ndarray, type=PropertyType.doubleVector, id=id, uid=uid, **kwargs)
+
+class _ListProperty(Property):
+    def __init__(self, **kwargs):
+        super(_ListProperty, self).__init__(list, **kwargs)
+
+class BoolList(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(BoolList, self).__init__(type=PropertyType.boolVector, id=id, uid=uid, **kwargs)
+
+class Int8List(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int8List, self).__init__(type=PropertyType.byteVector, id=id, uid=uid, **kwargs)
+
+class Int16List(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int16List, self).__init__(type=PropertyType.shortVector, id=id, uid=uid, **kwargs)
+
+class Int32List(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int32List, self).__init__(type=PropertyType.intVector, id=id, uid=uid, **kwargs)
+
+class Int64List(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Int64List, self).__init__(type=PropertyType.longVector, id=id, uid=uid, **kwargs)
+
+class Float32List(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Float32List, self).__init__(type=PropertyType.floatVector, id=id, uid=uid, **kwargs)
+
+class Float64List(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(Float64List, self).__init__(type=PropertyType.doubleVector, id=id, uid=uid, **kwargs)
+
+class CharList(_ListProperty):
+    def __init__(self, id: int = 0, uid: int = 0, **kwargs):
+        super(CharList, self).__init__(type=PropertyType.charVector, id=id, uid=uid, **kwargs)