0.15.2

Author: greenrobot

CHANGELOG.md

@@ -1,6 +1,11 @@
 ObjectBox C and C++ API Changelog
 =================================
 
+0.15.2 (2022-02-15)
+-------------------
+* Add store cloning
+* Fix attaching to a reopened store
+
 0.15.1 (2022-01-25)
 -------------------
 * Fix non-unique indexes triggering unique constraint violations in corner cases (introduced in 0.15.0)

CMakeLists.txt

@@ -31,7 +31,7 @@ else ()
 
     function(defineObjectBoxLib VARIANT)
         # Configuration updated for each release
-        set(DL_VERSION 0.15.1)
+        set(DL_VERSION 0.15.2)
 
         # Platform detection and other setup
         set(DL_URL https://github.com/objectbox/objectbox-c/releases/download)

README.md

@@ -6,15 +6,15 @@ ObjectBox Data Persistence and Data Sync follows an offline-first approach and c
 
 This is the **ObjectBox runtime library** to run ObjectBox as an embedded database in your C or C++ application.
 
-Here's a C++ example that inserts a `Task` data object (a plain user defined `struct`) into the database: 
+Here's a C++ example that inserts a `Task` data object (a plain user defined `struct`) into the database:
 ```c++
 obx::Box<Task> box(store);
 box.put({.text = "Buy milk"}); 
 ```
 
-See [ObjectBox C and C++ docs](https://cpp.objectbox.io/) for API details.  
+See [ObjectBox C and C++ docs](https://cpp.objectbox.io/) for API details.
 
-**Latest version: 0.15.1** (2022-01-26).
+**Latest version: 0.15.2** (2022-02-15).
 See [changelog](CHANGELOG.md) for more details.
 
 Feature Highlights
@@ -36,7 +36,7 @@ Feature Highlights
 Some more technical details:
 
 * Zero-copy reads for highest possible performance; access tens of millions of objects on commodity hardware
-* Lightweight for smart devices; its binary size is only around 1 MB 
+* Lightweight for smart devices; its binary size is only around 1 MB
 * Direct support for [FlatBuffers](https://google.github.io/flatbuffers/) data objects (aka "flatbuffers table")
 * Flex type to represent any FlexBuffers
 * Secondary indexes based on object properties
@@ -50,10 +50,10 @@ In most cases you want to use the C and C++ APIs in combination with the **[Obje
 This way, you get a convenient C or C++ API which requires minimal code on your side to work with the database.
 
 The APIs come as single header file for C and C++:
- 
-  * C: [include/objectbox.h](include/objectbox.h)
-  * C++: [include/objectbox.hpp](include/objectbox.hpp) (depends on objectbox.h)
-  
+
+* C: [include/objectbox.h](include/objectbox.h)
+* C++: [include/objectbox.hpp](include/objectbox.hpp) (depends on objectbox.h)
+
 Compile your code against it and use the binary library (.so, .dylib, .dll depending on the platform) to link against.
 Head over to [ObjectBox C and C++ installation docs](https://cpp.objectbox.io/installation) for step-by-step instructions.
 
@@ -70,16 +70,16 @@ Examples
 Have a look at the following TaskList example apps, depending on your programming language and preference:
 
 * [C, cursor, no generated code](examples/c-cursor-no-gen) - plain C; using flatcc directly; without any generated code
-* [C, with generated code](examples/c-gen) - plain C, using code generated by `objectbox-generator` 
+* [C, with generated code](examples/c-gen) - plain C, using code generated by `objectbox-generator`
 * [C++, with generated code](examples/cpp-gen) - C++, using code generated by `objectbox-generator`
-  * also includes sync client application example 
+  * also includes sync client application example
 
 Documentation
 -------------
-* [C and C++ docs](https://cpp.objectbox.io/) - official ObjectBox C and C++ documentation 
-* [include/objectbox.h](include/objectbox.h) - C API header file contains docs as code comments 
-* [include/objectbox.hpp](include/objectbox.hpp) - C++ API header file contains docs as code comments 
-* [C and C++ API reference docs](https://objectbox.io/docfiles/c/current/) - online HTML docs (Doxygen) 
+* [C and C++ docs](https://cpp.objectbox.io/) - official ObjectBox C and C++ documentation
+* [include/objectbox.h](include/objectbox.h) - C API header file contains docs as code comments
+* [include/objectbox.hpp](include/objectbox.hpp) - C++ API header file contains docs as code comments
+* [C and C++ API reference docs](https://objectbox.io/docfiles/c/current/) - online HTML docs (Doxygen)
 
 Current state / Changelog
 -------------------------
@@ -89,7 +89,7 @@ The C API is a thin wrapper around a robust DB core, which is version 3.x and al
 Until then, API improvements may result in breaking changes. For example, functions may still be renamed.
 
 **[Changelog](CHANGELOG.md):** If you update from a previous version, please check the [changelog](CHANGELOG.md).
-Besides new features, there may be breaking changes requiring modifications to your code. 
+Besides new features, there may be breaking changes requiring modifications to your code.
 
 ### Supported platforms:
 * Linux 64-bit
@@ -110,12 +110,12 @@ For the C API, data consists of bytes representing FlatBuffers tables, which you
 Other languages/bindings
 ------------------------
 ObjectBox supports multiple platforms and languages.
-Besides C/C++, ObjectBox also offers: 
+Besides C/C++, ObjectBox also offers:
 
 * [ObjectBox Java / Kotlin](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
-* [ObjectBox Swift](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS (and macOS) 
-* [ObjectBox Dart/Flutter](https://github.com/objectbox/objectbox-dart): cross-platform for mobile and desktop apps 
-* [ObjectBox Go](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications 
+* [ObjectBox Swift](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS (and macOS)
+* [ObjectBox Dart/Flutter](https://github.com/objectbox/objectbox-dart): cross-platform for mobile and desktop apps
+* [ObjectBox Go](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications
 
 
 How can I help ObjectBox?
@@ -124,10 +124,10 @@ Let us know what you love, what you don’t, what do you want to see next?
 
 **We're looking forward to receiving your comments and requests:**
 
-- Add [GitHub issues](https://github.com/ObjectBox/objectbox-java/issues) 
+- Add [GitHub issues](https://github.com/ObjectBox/objectbox-java/issues)
 - Upvote issues you find important by hitting the 👍/+1 reaction button
 - Drop us a line via [@ObjectBox_io](https://twitter.com/ObjectBox_io/)
-- ⭐ us, if you like what you see 
+- ⭐ us, if you like what you see
 
 Thank you! 🙏
 
@@ -148,4 +148,3 @@ License
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
-

download.sh

@@ -44,7 +44,7 @@ tty -s || quiet=true
 
 # Note: optional arguments like "--quiet" shifts argument positions in the case block above
 
-version=${1:-0.15.1}
+version=${1:-0.15.2}
 os=${2:-$(uname)}
 arch=${3:-$(uname -m)}
 echo "Base config: OS ${os} and architecture ${arch}"

doxygen/Changelog.md

@@ -3,6 +3,11 @@
 ObjectBox C and C++ API Changelog
 =================================
 
+0.15.2 (2022-02-15)
+-------------------
+* Add store cloning
+* Fix attaching to a reopened store
+
 0.15.1 (2022-01-25)
 -------------------
 * Fix non-unique indexes triggering unique constraint violations in corner cases (introduced in 0.15.0)

doxygen/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "ObjectBox C and C++ API"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.15.1"
+PROJECT_NUMBER         = "0.15.2"
 
 # 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-sync.h

@@ -34,7 +34,7 @@
 #include "objectbox.h"
 
 #if defined(static_assert) || defined(__cplusplus)
-static_assert(OBX_VERSION_MAJOR == 0 && OBX_VERSION_MINOR == 15 && OBX_VERSION_PATCH == 1,
+static_assert(OBX_VERSION_MAJOR == 0 && OBX_VERSION_MINOR == 15 && OBX_VERSION_PATCH == 2,
               "Versions of objectbox.h and objectbox-sync.h files do not match, please update");
 #endif
 

include/objectbox-sync.hpp

@@ -19,7 +19,7 @@
 #include "objectbox-sync.h"
 #include "objectbox.hpp"
 
-static_assert(OBX_VERSION_MAJOR == 0 && OBX_VERSION_MINOR == 15 && OBX_VERSION_PATCH == 1,
+static_assert(OBX_VERSION_MAJOR == 0 && OBX_VERSION_MINOR == 15 && OBX_VERSION_PATCH == 2,
               "Versions of objectbox.h and objectbox-sync.hpp files do not match, please update");
 
 static_assert(sizeof(obx_id) == sizeof(OBX_id_array::ids[0]),

include/objectbox.h

@@ -51,7 +51,7 @@ extern "C" {
 /// obx_version() or obx_version_is_at_least().
 #define OBX_VERSION_MAJOR 0
 #define OBX_VERSION_MINOR 15
-#define OBX_VERSION_PATCH 1  // values >= 100 are reserved for dev releases leading to the next minor/major increase
+#define OBX_VERSION_PATCH 2  // values >= 100 are reserved for dev releases leading to the next minor/major increase
 
 //----------------------------------------------
 // Common types
@@ -693,9 +693,11 @@ OBX_C_API OBX_store* obx_store_open(OBX_store_options* opt);
 OBX_C_API bool obx_store_is_open(const char* path);
 
 /// Attach to a previously opened store matching the path of the DB directory, which was used for opening the store.
-/// The returned store is a new instance (e.g. different pointer value) with its own lifetime and must also be closed.
+/// The returned store is a new instance (e.g. different pointer value) with its own lifetime and must also be closed
+/// via obx_store_close().
 /// The actual underlying store is only closed when the last store OBX_store instance is closed.
 /// @returns nullptr if no open store was found (i.e. not opened before or already closed)
+/// @see obx_store_clone() for "attaching" to a available store instance.
 OBX_C_API OBX_store* obx_store_attach(const char* path);
 
 /// Combines the functionality of obx_store_attach() and obx_store_open() in a thread-safe way.
@@ -706,6 +708,16 @@ OBX_C_API OBX_store* obx_store_attach(const char* path);
 ///        store (true) or a new store was created (false).
 OBX_C_API OBX_store* obx_store_attach_or_open(OBX_store_options* opt, bool check_matching_options, bool* out_attached);
 
+/// Clone a previously opened store; while a store instance is usable from multiple threads, situations may exist
+/// in which cloning a store simplifies the overall lifecycle.
+/// E.g. when a store is used for multiple threads and it may only be fully released once the last thread completes.
+/// The returned store is a new instance (e.g. different pointer value) with its own lifetime and must also be closed
+/// via obx_store_close().
+/// The actual underlying store is only closed when the last store OBX_store instance is closed.
+/// @returns nullptr if the store could not be cloned
+/// @see obx_store_attach() for "cloning" using the store's path.
+OBX_C_API OBX_store* obx_store_clone(OBX_store* store);
+
 /// For stores created outside of this C API, e.g. via C++ or Java, this is how you can use it via C too.
 /// Like this, it is OK to use the same store instance (same database) from multiple languages in parallel.
 /// Note: the store's life time will still be managed outside of the C API;

include/objectbox.hpp

@@ -25,7 +25,7 @@
 #include <optional>
 #endif
 
-static_assert(OBX_VERSION_MAJOR == 0 && OBX_VERSION_MINOR == 15 && OBX_VERSION_PATCH == 1,
+static_assert(OBX_VERSION_MAJOR == 0 && OBX_VERSION_MINOR == 15 && OBX_VERSION_PATCH == 2,
               "Versions of objectbox.h and objectbox.hpp files do not match, please update");
 
 static_assert(sizeof(obx_id) == sizeof(OBX_id_array::ids[0]),