Add maxDataSizeInKbyte to FlatStoreOptions, add TreeOptionFlags

Also reapply: "Update SyncFlags: rename to DebugLogIdMapping, add ClientKeepDataOnSyncError"

Author: greenrobot

objectbox-java/src/main/java/io/objectbox/BoxStoreBuilder.java

@@ -482,7 +482,7 @@ byte[] buildFlatStoreOptions(String canonicalPath) {
 
         // ...then build options.
         FlatStoreOptions.addDirectoryPath(fbb, directoryPathOffset);
-        FlatStoreOptions.addMaxDbSizeInKByte(fbb, maxSizeInKByte);
+        FlatStoreOptions.addMaxDbSizeInKbyte(fbb, maxSizeInKByte);
         FlatStoreOptions.addFileMode(fbb, fileMode);
         FlatStoreOptions.addMaxReaders(fbb, maxReaders);
         if (validateOnOpenMode != 0) {

objectbox-java/src/main/java/io/objectbox/model/FlatStoreOptions.java

@@ -57,7 +57,7 @@ public final class FlatStoreOptions extends Table {
    * e.g. caused by programming error.
    * If your app runs into errors like "db full", you may consider to raise the limit.
    */
-  public long maxDbSizeInKByte() { int o = __offset(8); return o != 0 ? bb.getLong(o + bb_pos) : 0L; }
+  public long maxDbSizeInKbyte() { int o = __offset(8); return o != 0 ? bb.getLong(o + bb_pos) : 0L; }
   /**
    * File permissions given in Unix style octal bit flags (e.g. 0644). Ignored on Windows.
    * Note: directories become searchable if the "read" or "write" permission is set (e.g. 0640 becomes 0750).
@@ -135,11 +135,19 @@ public final class FlatStoreOptions extends Table {
    *       corner cases with e.g. transactions, which may not be fully tested at the moment.
    */
   public boolean noReaderThreadLocals() { int o = __offset(30); return o != 0 ? 0!=bb.get(o + bb_pos) : false; }
+  /**
+   * Data size tracking is more involved than DB size tracking, e.g. it stores an internal counter.
+   * Thus only use it if a stricter, more accurate limit is required.
+   * It tracks the size of actual data bytes of objects (system and metadata is not considered).
+   * On the upside, reaching the data limit still allows data to be removed (assuming DB limit is not reached).
+   * Max data and DB sizes can be combined; data size must be below the DB size.
+   */
+  public long maxDataSizeInKbyte() { int o = __offset(32); return o != 0 ? bb.getLong(o + bb_pos) : 0L; }
 
   public static int createFlatStoreOptions(FlatBufferBuilder builder,
       int directoryPathOffset,
       int modelBytesOffset,
-      long maxDbSizeInKByte,
+      long maxDbSizeInKbyte,
       long fileMode,
       long maxReaders,
       int validateOnOpen,
@@ -150,10 +158,12 @@ public static int createFlatStoreOptions(FlatBufferBuilder builder,
       boolean usePreviousCommitOnValidationFailure,
       boolean readOnly,
       long debugFlags,
-      boolean noReaderThreadLocals) {
-    builder.startTable(14);
+      boolean noReaderThreadLocals,
+      long maxDataSizeInKbyte) {
+    builder.startTable(15);
+    FlatStoreOptions.addMaxDataSizeInKbyte(builder, maxDataSizeInKbyte);
     FlatStoreOptions.addValidateOnOpenPageLimit(builder, validateOnOpenPageLimit);
-    FlatStoreOptions.addMaxDbSizeInKByte(builder, maxDbSizeInKByte);
+    FlatStoreOptions.addMaxDbSizeInKbyte(builder, maxDbSizeInKbyte);
     FlatStoreOptions.addDebugFlags(builder, debugFlags);
     FlatStoreOptions.addMaxReaders(builder, maxReaders);
     FlatStoreOptions.addFileMode(builder, fileMode);
@@ -169,13 +179,13 @@ public static int createFlatStoreOptions(FlatBufferBuilder builder,
     return FlatStoreOptions.endFlatStoreOptions(builder);
   }
 
-  public static void startFlatStoreOptions(FlatBufferBuilder builder) { builder.startTable(14); }
+  public static void startFlatStoreOptions(FlatBufferBuilder builder) { builder.startTable(15); }
   public static void addDirectoryPath(FlatBufferBuilder builder, int directoryPathOffset) { builder.addOffset(0, directoryPathOffset, 0); }
   public static void addModelBytes(FlatBufferBuilder builder, int modelBytesOffset) { builder.addOffset(1, modelBytesOffset, 0); }
   public static int createModelBytesVector(FlatBufferBuilder builder, byte[] data) { return builder.createByteVector(data); }
   public static int createModelBytesVector(FlatBufferBuilder builder, ByteBuffer data) { return builder.createByteVector(data); }
   public static void startModelBytesVector(FlatBufferBuilder builder, int numElems) { builder.startVector(1, numElems, 1); }
-  public static void addMaxDbSizeInKByte(FlatBufferBuilder builder, long maxDbSizeInKByte) { builder.addLong(2, maxDbSizeInKByte, 0L); }
+  public static void addMaxDbSizeInKbyte(FlatBufferBuilder builder, long maxDbSizeInKbyte) { builder.addLong(2, maxDbSizeInKbyte, 0L); }
   public static void addFileMode(FlatBufferBuilder builder, long fileMode) { builder.addInt(3, (int) fileMode, (int) 0L); }
   public static void addMaxReaders(FlatBufferBuilder builder, long maxReaders) { builder.addInt(4, (int) maxReaders, (int) 0L); }
   public static void addValidateOnOpen(FlatBufferBuilder builder, int validateOnOpen) { builder.addShort(5, (short) validateOnOpen, (short) 0); }
@@ -187,6 +197,7 @@ public static int createFlatStoreOptions(FlatBufferBuilder builder,
   public static void addReadOnly(FlatBufferBuilder builder, boolean readOnly) { builder.addBoolean(11, readOnly, false); }
   public static void addDebugFlags(FlatBufferBuilder builder, long debugFlags) { builder.addInt(12, (int) debugFlags, (int) 0L); }
   public static void addNoReaderThreadLocals(FlatBufferBuilder builder, boolean noReaderThreadLocals) { builder.addBoolean(13, noReaderThreadLocals, false); }
+  public static void addMaxDataSizeInKbyte(FlatBufferBuilder builder, long maxDataSizeInKbyte) { builder.addLong(14, maxDataSizeInKbyte, 0L); }
   public static int endFlatStoreOptions(FlatBufferBuilder builder) {
     int o = builder.endTable();
     return o;

objectbox-java/src/main/java/io/objectbox/model/TreeOptionFlags.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2022 ObjectBox Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * 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.
+ */
+
+// automatically generated by the FlatBuffers compiler, do not modify
+
+package io.objectbox.model;
+
+/**
+ * Options flags for trees.
+ */
+@SuppressWarnings("unused")
+public final class TreeOptionFlags {
+  private TreeOptionFlags() { }
+  /**
+   * If true, debug logs are always disabled for this tree regardless of the store's debug flags.
+   */
+  public static final int DebugLogsDisable = 1;
+  /**
+   * If true, debug logs are always enabled for this tree regardless of the store's debug flags.
+   */
+  public static final int DebugLogsEnable = 2;
+  /**
+   * By default, a path such as "a/b/c" can address a branch and a leaf at the same time.
+   * E.g. under the common parent path "a/b", a branch "c" and a "c" leaf may exist.
+   * To disable this, set this flag to true.
+   * This will enable an additional check when inserting new leafs and new branches for the existence of the other.
+   */
+  public static final int EnforceUniquePath = 4;
+  /**
+   * In some scenarios, e.g. when using Sync, multiple node objects of the same type (e.g. branch or leaf) at the
+   * same path may exist temporarily. By enabling this flag, this is not considered an error situation. Instead, the
+   * first node is picked.
+   */
+  public static final int AllowNonUniqueNodes = 8;
+}
+