0.8.1

Author: greenrobot

CHANGELOG.md

@@ -1,3 +1,11 @@
+0.8.1 (2019-12-12)
+------------------
+* Bug fix for obx_box_rel_get_ids(), which did return wrong IDs in some cases (please update!)
+* Several refinements on property queries, for example:
+  * Maintain floating point point semantics on aggregates, e.g. infinity + 1 == infinity (no overflow)
+  * Allow aggregates on Date type properties
+  * Return negative counts if results were obtained using a short cut (API change to int64_t*)
+
 0.8.0 (2019-12-05)
 ------------------
 * Property queries compute sums and averages more precisely (improved algorithms and wider types)

CMakeLists.txt

@@ -1,5 +1,7 @@
 cmake_minimum_required(VERSION 3.0)
 
+project(ObjectBoxCRoot)
+
 IF(NOT IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/lib")
     message( FATAL_ERROR "Directory lib does not exist; please run ./download.sh first" )
 ENDIF()

README.md

@@ -4,7 +4,7 @@ ObjectBox C API
 Using this C API, you can us ObjectBox as an embedded database in your C/C++ application.
 In this embedded mode, it runs within your application process.
 
-**Latest version: 0.8.0** (2019-12-05). See [changelog](CHANGELOG.md) for more details. 
+**Latest version: 0.8.1** (2019-12-12). See [changelog](CHANGELOG.md) for more details. 
 
 Some features
 -------------

download.sh

@@ -39,7 +39,7 @@ tty -s || quiet=true
 
 # Note: optional arguments like "--quiet" shifts argument positions in the case block above
 
-version=${1:-0.7.2}
+version=${1:-0.8.1}
 repoType=${2:-testing}
 os=${3:-$(uname)}
 arch=${4:-$(uname -m)}

doxygen/Changelog.md

@@ -3,6 +3,22 @@
 ObjectBox C API Changelog
 =========================
 
+0.8.1 (2019-12-12)
+------------------
+* Bug fix for obx_box_rel_get_ids(), which did return wrong IDs in some cases (please update!)
+* Several refinements on property queries, for example:
+  * Maintain floating point point semantics on aggregates, e.g. infinity + 1 == infinity (no overflow)
+  * Allow aggregates on Date type properties
+  * Return negative counts if results were obtained using a short cut (API change to int64_t*)
+
+0.8.0 (2019-12-05)
+------------------
+* Property queries compute sums and averages more precisely (improved algorithms and wider types)
+* Property queries now consider unsigned types
+* Added an additional out parameter for count obx_query_prop_*() 
+* Added put alternatives to "put" with cursor: obx_cursor_insert() and obx_cursor_update()
+* Added obx_query_clone() to allow clones to run in parallel on separate threads
+
 0.7.2 (2019-10-30)
 ------------------
 * new obx_store_wrap() (use with Java version 2.4.1) 

doxygen/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ObjectBox C API"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.8.0"
+PROJECT_NUMBER         = "0.8.1"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

include/objectbox.h

@@ -42,7 +42,7 @@ extern "C" {
 /// obx_version() or obx_version_is_at_least().
 #define OBX_VERSION_MAJOR 0
 #define OBX_VERSION_MINOR 8
-#define OBX_VERSION_PATCH 0  // values >= 100 are reserved for dev releases leading to the next minor/major increase
+#define OBX_VERSION_PATCH 1  // values >= 100 are reserved for dev releases leading to the next minor/major increase
 
 /// Returns the version of the library as ints. Pointers may be null.
 void obx_version(int* major, int* minor, int* patch);
@@ -83,7 +83,7 @@ bool obx_supports_bytes_array(void);
 #define OBX_ERROR_ILLEGAL_STATE 10001
 #define OBX_ERROR_ILLEGAL_ARGUMENT 10002
 #define OBX_ERROR_ALLOCATION 10003
-#define OBX_ERROR_OVERFLOW 10004
+#define OBX_ERROR_NUMERIC_OVERFLOW 10004
 #define OBX_ERROR_NO_ERROR_INFO 10097
 #define OBX_ERROR_GENERAL 10098
 #define OBX_ERROR_UNKNOWN 10099
@@ -968,107 +968,123 @@ OBX_query_prop* obx_query_prop(OBX_query* query, obx_schema_id property_id);
 
 obx_err obx_query_prop_close(OBX_query_prop* query);
 
-/// Configures the property query to work only on distinct values
+/// Configures the property query to work only on distinct values.
 /// @note not all methods support distinct, those that don't will return an error
 obx_err obx_query_prop_distinct(OBX_query_prop* query, bool distinct);
 
-/// Configures the property query to work only on distinct values
+/// Configures the property query to work only on distinct values.
+/// This version is reserved for string properties and defines the case sensitivity for distinctness.
 /// @note not all methods support distinct, those that don't will return an error
+obx_err obx_query_prop_distinct_case(OBX_query_prop* query, bool distinct, bool case_sensitive);
+
+/// Deprecated; use obx_query_prop_distinct_case() instead
 obx_err obx_query_prop_distinct_string(OBX_query_prop* query, bool distinct, bool case_sensitive);
 
 /// Count the number of non-NULL values of the given property across all objects matching the query
 obx_err obx_query_prop_count(OBX_query_prop* query, uint64_t* out_count);
 
-/// Calculate an average value for the given numeric property across all objects matching the query
+/// Calculate an average value for the given numeric property across all objects matching the query.
 /// @param query the query to run
 /// @param out_average the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result
-obx_err obx_query_prop_avg(OBX_query_prop* query, double* out_average, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+///                  E.g. a floating point NaN value will trigger the short cut as the average will be a NaN no matter
+///                  what values will follow.
+obx_err obx_query_prop_avg(OBX_query_prop* query, double* out_average, int64_t* out_count);
 
-/// Calculate an average value for the given numeric property across all objects matching the query
+/// Calculate an average value for the given numeric property across all objects matching the query.
 /// @param query the query to run
 /// @param out_average the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result
-/// @returns OBX_ERROR_OVERFLOW if the result does not fit into an int64_t
-obx_err obx_query_prop_avg_int(OBX_query_prop* query, int64_t* out_average, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+/// @returns OBX_ERROR_NUMERIC_OVERFLOW if the result does not fit into an int64_t
+obx_err obx_query_prop_avg_int(OBX_query_prop* query, int64_t* out_average, int64_t* out_count);
 
-/// Find the minimum value of the given floating-point property across all objects matching the query
+/// Find the minimum value of the given floating-point property across all objects matching the query.
 /// @param query the query to run
 /// @param out_minimum the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result; in case an index is used,
-///     either 0 or 1 is returned, not the actual count of entities matching the query
-obx_err obx_query_prop_min(OBX_query_prop* query, double* out_minimum, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+///                  E.g. if an index is used, it will be set to 0 or -1, instead of the actual count of objects.
+obx_err obx_query_prop_min(OBX_query_prop* query, double* out_minimum, int64_t* out_count);
 
 /// Find the maximum value of the given floating-point property across all objects matching the query
 /// @param query the query to run
 /// @param out_maximum the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result; in case an index is used,
-///     either 0 or 1 is returned, not the actual count of entities matching the query
-obx_err obx_query_prop_max(OBX_query_prop* query, double* out_maximum, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+///                  E.g. if an index is used, it will be set to 0 or -1, instead of the actual count of objects.
+obx_err obx_query_prop_max(OBX_query_prop* query, double* out_maximum, int64_t* out_count);
 
-/// Calculate the sum of the given floating-point property across all objects matching the query
+/// Calculate the sum of the given floating-point property across all objects matching the query.
 /// @param query the query to run
 /// @param out_sum the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result
-obx_err obx_query_prop_sum(OBX_query_prop* query, double* out_sum, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+///                  E.g. a floating point NaN value will trigger the short cut as the average will be a NaN no matter
+///                  what values will follow.
+obx_err obx_query_prop_sum(OBX_query_prop* query, double* out_sum, int64_t* out_count);
 
-/// Find the minimum value of the given property across all objects matching the query
+/// Find the minimum value of the given property across all objects matching the query.
 /// @param query the query to run
 /// @param out_minimum the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result; in case an index is used,
-///     either 0 or 1 is returned, not the actual count of entities matching the query
-obx_err obx_query_prop_min_int(OBX_query_prop* query, int64_t* out_minimum, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+///                  E.g. if an index is used, it will be set to 0 or -1, instead of the actual count of objects.
+obx_err obx_query_prop_min_int(OBX_query_prop* query, int64_t* out_minimum, int64_t* out_count);
 
-/// Find the maximum value of the given property across all objects matching the query
+/// Find the maximum value of the given property across all objects matching the query.
 /// @param query the query to run
 /// @param out_maximum the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result; in case an index is used,
-///     either 0 or 1 is returned, not the actual count of entities matching the query
-obx_err obx_query_prop_max_int(OBX_query_prop* query, int64_t* out_maximum, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+///                  E.g. if an index is used, it will be set to 0 or -1, instead of the actual count of objects.
+obx_err obx_query_prop_max_int(OBX_query_prop* query, int64_t* out_maximum, int64_t* out_count);
 
-/// Calculate the sum of the given property across all objects matching the query
+/// Calculate the sum of the given property across all objects matching the query.
 /// @param query the query to run
 /// @param out_sum the result of the query
-/// @param out_count (optional: may be NULL) number of entities contributing to the result
-/// @returns OBX_ERROR_OVERFLOW if the result does not fit into an int64_t
-obx_err obx_query_prop_sum_int(OBX_query_prop* query, int64_t* out_sum, uint64_t* out_count);
+/// @param out_count (optional, may be NULL) number of objects contributing to the result (counted on the fly).
+///                  A negative count indicates that the computation used a short cut and thus the count is incomplete.
+/// @returns OBX_ERROR_NUMERIC_OVERFLOW if the result does not fit into an int64_t
+obx_err obx_query_prop_sum_int(OBX_query_prop* query, int64_t* out_sum, int64_t* out_count);
 
-/// Returns an array of strings stored as the given property across all objects matching the query
+/// Returns an array of strings stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified field are skipped
 OBX_string_array* obx_query_prop_string_find(OBX_query_prop* query, const char* value_if_null);
 
-/// Returns an array of ints stored as the given property across all objects matching the query
+/// Returns an array of ints stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified are skipped
 /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details
 OBX_int64_array* obx_query_prop_int64_find(OBX_query_prop* query, const int64_t* value_if_null);
 
-/// Returns an array of ints stored as the given property across all objects matching the query
+/// Returns an array of ints stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified are skipped
 /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details
 OBX_int32_array* obx_query_prop_int32_find(OBX_query_prop* query, const int32_t* value_if_null);
 
-/// Returns an array of ints stored as the given property across all objects matching the query
+/// Returns an array of ints stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified are skipped
 /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details
 OBX_int16_array* obx_query_prop_int16_find(OBX_query_prop* query, const int16_t* value_if_null);
 
-/// Returns an array of ints stored as the given property across all objects matching the query
+/// Returns an array of ints stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified are skipped
 /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details
 OBX_int8_array* obx_query_prop_int8_find(OBX_query_prop* query, const int8_t* value_if_null);
 
-/// Returns an array of doubles stored as the given property across all objects matching the query
+/// Returns an array of doubles stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified are skipped
 /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details
 OBX_double_array* obx_query_prop_double_find(OBX_query_prop* query, const double* value_if_null);
 
-/// Returns an array of int stored as the given property across all objects matching the query
+/// Returns an array of int stored as the given property across all objects matching the query.
 /// @param value_if_null value that should be used in place of NULL values on object fields;
 ///     if value_if_null=NULL is given, objects with NULL values of the specified are skipped
 /// @returns NULL if the operation failed, see functions like obx_last_error_code() to get error details