Merge pull request #175 from martinsumner/rdb/quviq-i15-regex-doc

Update docs to clarify that regex cannot be run on integers
This commit is contained in:
Martin Sumner 2018-09-19 18:31:39 +01:00 committed by GitHub
commit f4a7a729ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -574,7 +574,11 @@ book_returnfolder(Pid, RunnerType) ->
%% expression of type `re:mp()' (that will be run against each index %% expression of type `re:mp()' (that will be run against each index
%% term value, and only those that match will be accumulated) or %% term value, and only those that match will be accumulated) or
%% `undefined', which means no regular expression filtering of index %% `undefined', which means no regular expression filtering of index
%% values. %% values. NOTE: Regular Expressions can ONLY be run on indexes that
%% have binary or string values, NOT integer values. In the Riak sense
%% of secondary indexes, there are two types of indexes `_bin' indexes
%% and `_int' indexes. Term regex may only be run against the `_bin'
%% type.
-spec book_indexfold(pid(), -spec book_indexfold(pid(),
Constraint:: {Bucket, Key} | Bucket, Constraint:: {Bucket, Key} | Bucket,
FoldAccT :: {FoldFun, Acc}, FoldAccT :: {FoldFun, Acc},