Introduce new count API functions

tsloughter · Mar 23, 2017 · 44760d2 · 44760d2
1 parent 8008fd8
commit 44760d2
Showing 1 changed file with 31 additions and 3 deletions.
diff --git a/src/erlastic_search.erl b/src/erlastic_search.erl
@@ -44,6 +44,9 @@
         ,search/2
         ,search/3
         ,search/5
+        ,count/2
+        ,count/3
+        ,count/5
         ,search_limit/4
         ,search_scroll/4
         ,search_scroll/1
@@ -403,6 +406,27 @@ search(Index, Type, Query) ->
 search_limit(Index, Type, Query, Limit) when is_integer(Limit) ->
     search(#erls_params{}, Index, Type, Query, [{<<"size">>, integer_to_list(Limit)}]).
 
+%%--------------------------------------------------------------------
+%% @doc
+%% Uses the count API to execute a query and get the number of matches
+%% for that query. See `search/*' for more details regarding to
+%% query types and the different input parameters.
+%% @end
+%%--------------------------------------------------------------------
+-spec count(binary() | list(), erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}.
+count(Index, Query) ->
+    search_helper(<<"_count">>, #erls_params{}, Index, <<>>, Query, []).
+
+-spec count(binary() | list() | #erls_params{}, binary() | list(), erlastic_json() | binary()) -> {ok, erlastic_success_result()} | {error, any()}.
+count(Params, Index, Query) when is_record(Params, erls_params) ->
+    search_helper(<<"_count">>, Params, Index, <<>>, Query, []);
+count(Index, Type, Query) ->
+    search_helper(<<"_count">>, #erls_params{}, Index, Type, Query, []).
+
+-spec count(#erls_params{}, list() | binary(), list() | binary(), erlastic_json() | binary(), list()) -> {ok, erlastic_success_result()} | {error, any()}.
+count(Params, Index, Type, Query, Opts) ->
+    search_helper(<<"_count">>, Params, Index, Type, Query, Opts).
+
 %%--------------------------------------------------------------------
 %% @doc
 %% search_scroll/4 -- Takes the index, type name and search query
@@ -421,10 +445,8 @@ search_scroll(Query) ->
      erls_resource:post(Params, filename:join([<<"_search">>, <<"scroll">>]), [], [], erls_json:encode(Query), Params#erls_params.http_client_options).
 
 -spec search(#erls_params{}, list() | binary(), list() | binary(), erlastic_json() | binary(), list()) -> {ok, erlastic_success_result()} | {error, any()}.
-search(Params, Index, Type, Query, Opts) when is_binary(Query) ->
-    erls_resource:get(Params, filename:join([commas(Index), Type, <<"_search">>]), [], [{<<"q">>, Query}]++Opts, Params#erls_params.http_client_options);
 search(Params, Index, Type, Query, Opts) ->
-    erls_resource:post(Params, filename:join([commas(Index), Type, <<"_search">>]), [], Opts, erls_json:encode(Query), Params#erls_params.http_client_options).
+    search_helper(<<"_search">>, Params, Index, Type, Query, Opts).
 
 -spec multi_search(#erls_params{}, list({HeaderInformation :: headers(), SearchRequest :: erlastic_json() | binary()})) -> {ok, ResultJson :: erlastic_success_result()} | {error, Reason :: any()}.
 multi_search(Params, HeaderJsonTuples) ->
@@ -580,6 +602,12 @@ percolate(Params, Index, Type, Doc) ->
 
 %%% Internal functions
 
+-spec search_helper(binary(), #erls_params{}, list() | binary(), list() | binary(), erlastic_json() | binary(), list()) -> {ok, erlastic_success_result()} | {error, any()}.
+search_helper(Endpoint, Params, Index, Type, Query, Opts) when is_binary(Query) ->
+    erls_resource:get(Params, filename:join([commas(Index), Type, Endpoint]), [], [{<<"q">>, Query}]++Opts, Params#erls_params.http_client_options);
+search_helper(Endpoint, Params, Index, Type, Query, Opts) ->
+    erls_resource:post(Params, filename:join([commas(Index), Type, Endpoint]), [], Opts, erls_json:encode(Query), Params#erls_params.http_client_options).
+
 -spec commas(list(binary()) | binary()) -> binary().
 commas(Bin) when is_binary(Bin) ->
     Bin;