Add aae_fold function erase_keys (#201)

* Add aae_fold function erase_keys and related fixes.

* Fix link

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold.md

@@ -28,7 +28,10 @@ aliases:
 [tictacaae list-buckets]: ../tictac-aae-fold/list-buckets
 [tictacaae object-stats]: ../tictac-aae-fold/object-stats
 [tictacaae count-tombs]: ../tictac-aae-fold/count-tombs
+[tictacaae count-keys]: ../tictac-aae-fold/count-keys
 [tictacaae reap-tombs]: ../tictac-aae-fold/reap-tombs
+[tictacaae erase-keys]: ../tictac-aae-fold/erase-keys
+[tictacaae repair-keys-range]: ../tictac-aae-fold/repair-keys-range
 [filters]: ../tictac-aae-fold/filters
 [filter-by bucket]: ../tictac-aae-fold/filters#filter-by-bucket-name
 [filter-by key-range]: ../tictac-aae-fold/filters#filter-by-key-range
@@ -124,6 +127,7 @@ After experiencing a timeout, the current number of commands waiting to execute
 io:format("af4_pool has ~b workers\n", [length(MM)]),
 f().
 ```
+
 {{% note title="Warning: existing variables cleared" %}}
 `f()` will unbind any existing variables, which may not be your intention. If you remove `f()` then please remember that `MM` will remain bound to the first value. For re-use, you should change the variable name or restart the `riak attach` session.
 {{% /note %}}
@@ -181,6 +185,14 @@ Returns a list of all buckets.
 
 [Learn More >>][tictacaae list-buckets]
 
+## Count keys
+
+Function: `erase_keys` with `count`
+
+Counts the Riak keys that meet the filter parameters.
+
+[Learn More >>][tictacaae count-keys]
+
 ## Count tombstones
 
 Function: `reap_tombs` with `count`
@@ -197,6 +209,14 @@ Returns a count of Riak objects that meet the filter parameters.
 
 [Learn More >>][tictacaae object-stats]
 
+## Erase keys
+
+Function: `erase_keys` with `local`
+
+Deletes Riak keys that meet the filter parameters.
+
+[Learn More >>][tictacaae erase-keys]
+
 ## Reap tombstones
 
 Function: `reap_tombs` with `local`
@@ -205,15 +225,21 @@ Reaps the Riak tombstone objects that meet the filter parameters.
 
 [Learn More >>][tictacaae reap-tombs]
 
+## Repair keys
+
+Function: `repair_keys_range`
+
+Performs a read-repair on the keys that meet the filter parameters.
+
+[Learn More >>][tictacaae repair-keys-range]
+
 ## Other functions not covered
 
-`aae_fold` has various other functions that can be called, but are mostly for internal use by Riak. These functions should not be used without a good understanding of the source code, but are provided here for reference:
+`aae_fold` has various other functions that can be called, but are mostly for internal use by Riak. These functions should not be used without a good understanding of the source code, but are listed here for reference:
 
-- `erase_keys`
 - `fetch_clocks_nval`
 - `fetch_clocks_range`
 - `merge_branch_nval`
 - `merge_root_nval`
 - `merge_tree_range`
-- `repair_keys_range`
 - `repl_keys_range`

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold/count-keys.md

@@ -0,0 +1,136 @@
+---
+title_supertext: "Using > TicTac AAE Fold:"
+title: "Count Keys"
+description: ""
+project: "riak_kv"
+project_version: 3.2.0
+menu:
+  riak_kv-3.2.0:
+    name: "Count Keys"
+    identifier: "cluster_operations_tictac_aae_fold_count_keys"
+    weight: 105
+    parent: "cluster_operations_tictac_aae_fold"
+toc: true
+since: 2.9.4
+version_history:
+  in: "2.9.4+"
+aliases:
+---
+[code riak_kv_vnode]: https://github.com/basho/riak_kv/blob/develop-3.0/src/riak_kv_vnode.erl
+[riak attach]: ../../../admin/riak-cli/#attach
+[config reference]: ../../../configuring/reference/#tictac-active-anti-entropy
+[config tictacaae]: ../../../configuring/active-anti-entropy/tictac-aae
+[tictacaae folds-overview]: ../
+[tictacaae system]: ../../tictac-active-anti-entropy
+[tictacaae client]: ../../tictac-aae-fold#the-riak-client
+[tictacaae find-keys]: ../../tictac-aae-fold/find-keys
+[tictacaae find-tombs]: ../../tictac-aae-fold/find-tombs
+[tictacaae list-buckets]: ../../tictac-aae-fold/list-buckets
+[tictacaae object-stats]: ../../tictac-aae-fold/object-stats
+[tictacaae reap-tombs]: ../../tictac-aae-fold/reap-tombs
+[tictacaae count-tombs]: ../../tictac-aae-fold/count-tombs
+[filters]: ../../tictac-aae-fold/filters
+[filter-by bucket]: ../../tictac-aae-fold/filters#filter-by-bucket-name
+[filter-by key-range]: ../../tictac-aae-fold/filters#filter-by-key-range
+[filter-by segment]: ../../tictac-aae-fold/filters#filter-by-segment
+[filter-by modified]: ../../tictac-aae-fold/filters#filter-by-date-modified
+[filter-by sibling-count]: ../../tictac-aae-fold/find-keys/#the-sibling-count-filter
+[filter-by object-size]: ../../tictac-aae-fold/find-keys/#the-object-size-filter
+
+Counts keys that meet the filter parameters.
+
+See the [TicTac AAE `aae_folds`][tictacaae folds-overview] documentation for configuration, tuning and troubleshootings help.
+
+This function allows you to count how many keys would be deleted in a single pass based on the supplied filters. It does not actually delete the keys. Manual dev ops intervention using this function is required.
+
+Use the `erase_keys` function to count the keys that would be deleted.
+
+If you need to find keys with more specific properties, you can also use the [Object Statistics function][tictacaae object-stats].
+
+## The `erase_keys` function
+
+Run this using [`riak attach`][riak attach].
+
+This function has three available operational methods that are selected via the `method` value. The `count` method for counting keys is detailed below. The general format for the function is:
+
+```riakattach
+riak_client:aae_fold({
+    erase_keys,
+    bucket_filter,
+    key_range_filter,
+    segment_filter
+    modified_filter,
+    method
+    }, Client).
+```
+
+Please see the list of [available filters](#available-filters) below.
+
+{{% note title="Other `method`s" %}}
+There are two other `method`s, `local` and `job`:
+
+- `local` is used to delete the keys (see [Erase Keys](../../tictac-aae-fold/erase-keys) for more information).
+- `job` is used internally by TicTac AAE. Do not use it unless you know what you are doing.
+{{% /note %}}
+
+{{% note %}}
+How to get the value for `Client` is detailed in [The Riak Client](../../tictac-aae-fold#the-riak-client).
+{{% /note %}}
+
+## The `count` method
+
+Returns a count of keys that meet the filter parameters. Does NOT delete the keys.
+
+```riakattach
+riak_client:aae_fold({
+    erase_keys,
+    bucket_filter,
+    key_range_filter,
+    segment_filter
+    modified_filter,
+    count
+    }, Client).
+```
+
+Please see the list of [available filters](#available-filters) below.
+
+For example, the following snippet will count all keys that would be deleted with the filters:
+
+- in the bucket "dogs" of bucket type "animals"
+- whose keys are between "A" and "N"
+- which were modified in January 2022
+
+```riakattach
+riak_client:aae_fold({
+    erase_keys,
+    {<<"animals">>,<<"dogs">>},
+    {<<"A">>,<<"N">>},
+    all,
+    {date,{{2022,1,1},{0,0,0}},{{2022,2,1},{0,0,0}}},
+    count
+    }, Client).
+```
+
+## The response for the `count` method
+
+The response will look something like this:
+
+```erlang
+{ok,5}
+```
+
+This indicates that 5 keys were found meeting the filter parameters.
+
+## Available filters
+
+These filters are detailed in the [Filters][filters] documentation and can be used to limit the keys considered for counting.
+
+These filters will reduce the number of keys to be searched:
+
+- [`bucket_filter`][filter-by bucket]
+- [`key_range_filter`][filter-by key-range]
+- [`segment_filter`][filter-by segment]
+
+These filters will reduce the number of keys considered for counting:
+
+- [`modified_filter`][filter-by modified]

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold/count-tombs.md

@@ -8,7 +8,7 @@ menu:
   riak_kv-3.2.0:
     name: "Count Tombs"
     identifier: "cluster_operations_tictac_aae_fold_count_tombs"
-    weight: 105
+    weight: 106
     parent: "cluster_operations_tictac_aae_fold"
 toc: true
 since: 2.9.4

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold/erase-keys.md

@@ -0,0 +1,133 @@
+---
+title_supertext: "Using > TicTac AAE Fold:"
+title: "Erase Keys"
+description: ""
+project: "riak_kv"
+project_version: 3.2.0
+menu:
+  riak_kv-3.2.0:
+    name: "Erase Keys"
+    identifier: "cluster_operations_tictac_aae_fold_erase_keys"
+    weight: 108
+    parent: "cluster_operations_tictac_aae_fold"
+toc: true
+since: 
+version_history:
+  in: "2.9.4+"
+aliases:
+---
+[code riak_kv_vnode]: https://github.com/basho/riak_kv/blob/develop-3.0/src/riak_kv_vnode.erl
+[riak attach]: ../../../admin/riak-cli/#attach
+[config reference]: ../../../configuring/reference/#tictac-active-anti-entropy
+[config tictacaae]: ../../../configuring/active-anti-entropy/tictac-aae
+[tictacaae folds-overview]: ../
+[tictacaae system]: ../../tictac-active-anti-entropy
+[tictacaae client]: ../../tictac-aae-fold#the-riak-client
+[tictacaae find-keys]: ../../tictac-aae-fold/find-keys
+[tictacaae find-tombs]: ../../tictac-aae-fold/find-tombs
+[tictacaae list-buckets]: ../../tictac-aae-fold/list-buckets
+[tictacaae object-stats]: ../../tictac-aae-fold/object-stats
+[tictacaae reap-tombs]: ../../tictac-aae-fold/reap-tombs
+[filters]: ../../tictac-aae-fold/filters
+[filter-by bucket]: ../../tictac-aae-fold/filters#filter-by-bucket-name
+[filter-by key-range]: ../../tictac-aae-fold/filters#filter-by-key-range
+[filter-by segment]: ../../tictac-aae-fold/filters#filter-by-segment
+[filter-by modified]: ../../tictac-aae-fold/filters#filter-by-date-modified
+[filter-by sibling-count]: ../../tictac-aae-fold/find-keys/#the-sibling-count-filter
+[filter-by object-size]: ../../tictac-aae-fold/find-keys/#the-object-size-filter
+
+Erases keys that meet the filter parameters.
+
+See the [TicTac AAE `aae_folds`][tictacaae folds-overview] documentation for configuration, tuning and troubleshootings help.
+
+This function allows you to delete many keys in a single pass based on the supplied filters. The Riak keys will be converted to Riak tombstones after which the normal Riak reaping functions take over. Manual dev ops intervention using this function is required.
+
+Use the `erase_keys` function to delete these keys.
+
+## The `erase_keys` function
+
+Run this using [`riak attach`][riak attach].
+
+This function has three available operational methods that are selected via the `method` value. The `local` method for deleting keys is detailed below. The general format for the function is:
+
+```riakattach
+riak_client:aae_fold({
+    erase_keys,
+    bucket_filter,
+    key_range_filter,
+    segment_filter
+    modified_filter,
+    method
+    }, Client).
+```
+
+Please see the list of [available filters](#available-filters) below.
+
+{{% note title="Other `method`s" %}}
+There are two other `method`s, `count` and `job`:
+
+- `count` is used to count the keys that would have been deleted (see [Count Objects](../../tictac-aae-fold/count-keys) for more information).
+- `job` is used internally by TicTac AAE. Do not use it unless you know what you are doing.
+{{% /note %}}
+
+{{% note %}}
+How to get the value for `Client` is detailed in [The Riak Client](../../tictac-aae-fold#the-riak-client).
+{{% /note %}}
+
+## The `local` method
+
+Deletes keys that meet the filter parameters so that they can then be reaped. Returns the number of keys deleted by calling this function.
+
+```riakattach
+riak_client:aae_fold({
+    erase_keys,
+    bucket_filter,
+    key_range_filter,
+    segment_filter
+    modified_filter,
+    local
+    }, Client).
+```
+
+Please see the list of [available filters](#available-filters) below.
+
+For example, the following snippet will delete keys with the filters:
+
+- in the bucket "dogs" of bucket type "animals"
+- whose keys are between "A" and "N"
+- which were modified in January 2022
+
+```riakattach
+riak_client:aae_fold({
+    erase_keys,
+    {<<"animals">>,<<"dogs">>},
+    {<<"A">>,<<"N">>},
+    all,
+    {date,{{2022,1,1},{0,0,0}},{{2022,2,1},{0,0,0}}},
+    local
+    }, Client).
+```
+
+## The response for the `local` method
+
+The response will look something like this:
+
+```erlang
+{ok,5}
+```
+
+This indicates that 5 keys were found meeting the filter parameters and were deleted by Riak. Remember that a deleted Riak key is really converted to a Riak tombstone object, and will be actually removed from the backend at a later point based on your `delete_mode` setting.
+
+## Available filters
+
+These filters are detailed in the [Filters][filters] documentation and can be used to limit the keys considered for deleting.
+
+These filters will reduce the keys to be searched:
+
+- [`bucket_filter`][filter-by bucket]
+- [`key_range_filter`][filter-by key-range]
+- [`segment_filter`][filter-by segment]
+
+These filters will reduce the number of keys considered for deleting:
+
+- [`modified_filter`][filter-by modified]

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold/object-stats.md

@@ -8,7 +8,7 @@ menu:
   riak_kv-3.2.0:
     name: "Object Statistics"
     identifier: "cluster_operations_tictac_aae_fold_object_stats"
-    weight: 105
+    weight: 107
     parent: "cluster_operations_tictac_aae_fold"
 toc: true
 since: 2.9.4

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold/reap-tombs.md

@@ -8,7 +8,7 @@ menu:
   riak_kv-3.2.0:
     name: "Reap Tombs"
     identifier: "cluster_operations_tictac_aae_fold_reap_tombs"
-    weight: 107
+    weight: 109
     parent: "cluster_operations_tictac_aae_fold"
 toc: true
 since: 2.9.4

content/riak/kv/3.2.0/using/cluster-operations/tictac-aae-fold/repair-keys-range.md

@@ -8,7 +8,7 @@ menu:
   riak_kv-3.2.0:
     name: "Repair Keys"
     identifier: "cluster_operations_tictac_aae_fold_repair_keys_range"
-    weight: 108
+    weight: 110
     parent: "cluster_operations_tictac_aae_fold"
 toc: true
 since: 3.0.8

docker/run.local.sh

@@ -0,0 +1,11 @@
+if [[ ! -d "output" ]]
+then
+    echo "Run this from the root of the repo. i.e. './docker/run.local.sh'"
+    exit
+fi
+
+# empty output folder
+sudo rm -r ./output/*
+
+# generate new content
+docker compose -f ./docker/docker-compose.localhost-preview.yaml up