[docs] DpcTabularCondition

Author: jamesgpearce

src/@types/persisters/docs.js

@@ -486,6 +486,24 @@
    */
   /// DpcTabular.timesTableSuffix
 }
+
+/**
+ * The DpcTabularCondition type describes the SQL WHERE clause that will be used
+ * to filter the rows that are loaded and saved to in the Store Table.
+ *
+ * This provides a way to enact pagination or selective loading of data from the
+ * database into TinyBase so that only a fraction of the full data in the
+ * database is loaded into memory.
+ *
+ * This clause must include at least one `$tableName` placeholder for the table
+ * name. For example, if you only wanted to load and save records that have an
+ * 'active' flag set, this string would be something like `$tableName.active =
+ * 1`.
+ * @category Configuration
+ * @since v6.1.0
+ */
+/// DpcTabularCondition
+
 /**
  * The DpcTabularLoad type describes the configuration for loading Tables in a
  * database-oriented Persister that is operating in tabular mode.
@@ -498,7 +516,7 @@
  * |-|-|-|
  * |`tableId`|Id|The Id of the Store Table into which data from this database table should be loaded.|
  * |`rowIdColumnName?`|string|The optional name of the column in the database table that will be used as the Row Ids in the Store Table, defaulting to '_id'.|
- * |`condition?`|string|The optional SQL WHERE clause that will be used to filter the rows that are loaded into the Store Table. When set it must include the `$tableName` placeholder for the table name.|
+ * |`condition?`|string|The optional SQL WHERE clause that will be used to filter the rows that are loaded into the Store Table. When set it must include the `$tableName` placeholder for the table name, since v6.1.0.|
  *
  * As a shortcut, if you do not need to specify a custom `rowIdColumnName`, you
  * can simply provide the Id of the Store Table instead of the whole object.
@@ -613,7 +631,7 @@
  * |`rowIdColumnName?`|string|The optional name of the column in the database table that will be used to save the Row Ids from the Store Table, defaulting to '_id'.|
  * |`deleteEmptyColumns?`|boolean|Whether columns in the database table will be removed if they are empty in the Store Table, defaulting to false.|
  * |`deleteEmptyTable?`|boolean|Whether tables in the database will be removed if the Store Table is empty, defaulting to false.|
- * |`condition?`|string|The optional SQL WHERE clause that will be used to scope cleanup operations to the Store Table. When set it must include the `$tableName` placeholder for the table name. Defaults to `DpcTabularLoad.condition`.|
+ * |`condition?`|string|The optional SQL WHERE clause that will be used to scope cleanup operations to the Store Table. When set it must include the `$tableName` placeholder for the table name, since v6.1.0. Defaults to `DpcTabularLoad.condition`.|
  *
  * As a shortcut, if you do not need to specify a custom `rowIdColumnName`, or
  * enable the `deleteEmptyColumns` or `deleteEmptyTable` settings, you can