Add query/4 that can receive a Req.Request (#6)

* Add `query/4` that can receive a `Req.Request`

* Remove query/3 and add query/4 defaults

Author: Philip Sampaio

lib/req_ch.ex

@@ -72,71 +72,84 @@ defmodule ReqCH do
   defguardp is_query_params(value) when is_list(value) or is_map(value)
 
   @doc """
-  Performs a query against ClickHouse API.
+  Performs a query against the ClickHouse API.
 
-  See docs from `new/1` for details about the options.
+  This version receives a `Req.Request.t()`, so it won't
+  create a new one from scratch.
+
+  By default, it will use the `http://localhost:8123` as `:base_url`.
+  You can change that either providing in your Req request, or in passing
+  down in the options.
+  See `new/1` for the options. Like that function, `query/4` accepts any
+  option that `Req.new/1` accepts.
 
   ## Examples
 
   Queries can be performed using both `Req.get/2` or `Req.post/2`, but GET
   is "read-only" and commands like `CREATE` or `INSERT` cannot be used with it.
   For that reason, by default we perform a `POST` request.
-  To change that, use `query/2` with a pre-configured `req`.
 
   A plain query:
 
-      iex> {:ok, response} = ReqCH.query("SELECT number FROM system.numbers LIMIT 3")
+      iex> req = ReqCH.new(database: "system")
+      iex> {:ok, response} = ReqCH.query(req, "SELECT number FROM numbers LIMIT 3")
       iex> response.body
       "0\\n1\\n2\\n"
 
-  Changing the format to `:explorer` will return a dataframe:
+  With a specific format:
 
-      iex> {:ok, response} = ReqCH.query("SELECT number FROM system.numbers LIMIT 3", [], format: :explorer)
+      iex> req = ReqCH.new(database: "system")
+      iex> {:ok, response} = ReqCH.query(req, "SELECT number FROM numbers LIMIT 3", [], [format: :explorer])
       iex> response.body
       #Explorer.DataFrame<
         Polars[3 x 1]
         number u64 [0, 1, 2]
       >
 
-  Using parameters is also possible:
+   Passing SQL params:
 
-      iex> opts = [format: :explorer, database: "system"]
-      iex> {:ok, response} = ReqCH.query("SELECT number FROM numbers WHERE number > {num:UInt8} LIMIT 3", [num: 5], opts)
-      #Explorer.DataFrame<
-        Polars[3 x 1]
-        number u64 [6, 7, 8]
-      >
+      iex> req = ReqCH.new(database: "system")
+      iex> {:ok, response} = ReqCH.query(req, "SELECT number FROM numbers WHERE number > {num:UInt8} LIMIT 3", [num: 5], [])
+      iex> response.body
+      "6\\n7\\n8\\n"
 
   This function can accept `Req` options, as well as mixing them with `ReqCH` options:
 
       iex> opts = [base_url: "http://example.org:8123", database: "system", auth: {:basic, "user:pass"}]
-      iex> {:ok, response} = ReqCH.query("SELECT number FROM numbers LIMIT 3", [], opts)
+      iex> {:ok, response} = ReqCH.query(ReqCH.new(), "SELECT number FROM numbers LIMIT 3", [], opts)
       iex> response.body
       "0\\n1\\n2\\n"
 
   """
-  @spec query(sql_query :: binary(), params :: Map.t() | Keyword.t(), opts :: Keyword.t()) ::
-          {:ok, Req.Response.t()} | {:error, binary()}
-  def query(sql_query, params \\ [], opts \\ [])
-
-  def query(sql_query, params, opts)
-      when is_binary(sql_query) and is_query_params(params) and is_list(opts) do
-    opts
-    |> new()
-    |> put_params(prepare_params(params))
+  @spec query(
+          Req.t(),
+          sql_query :: binary(),
+          sql_query_params :: Map.t() | Keyword.t(),
+          opts :: Keyword.t()
+        ) :: {:ok, Req.Response.t()} | {:error, binary()}
+  def query(req, sql_query, sql_query_params \\ [], opts \\ [])
+
+  def query(%Req.Request{} = req, sql_query, sql_query_params, opts)
+      when is_binary(sql_query) and is_query_params(sql_query_params) and is_list(opts) do
+    req
+    |> attach(opts)
+    |> put_params(prepare_params(sql_query_params))
     |> Req.post(body: sql_query)
   end
 
   @doc """
-  Same as `query/3`, but raises in case of error.
+  Same as `query/4`, but raises in case of error.
   """
-  @spec query!(sql_query :: binary(), params :: Map.t() | Keyword.t(), opts :: Keyword.t()) ::
-          Req.Response.t()
-  def query!(sql_query, params \\ [], opts \\ [])
-
-  def query!(sql_query, params, opts)
-      when is_binary(sql_query) and is_query_params(params) and is_list(opts) do
-    case query(sql_query, params, opts) do
+  @spec query!(
+          Req.t(),
+          sql_query :: binary(),
+          sql_query_params :: Map.t() | Keyword.t(),
+          opts :: Keyword.t()
+        ) :: Req.Response.t()
+  def query!(req, sql_query, sql_query_params \\ [], opts \\ [])
+
+  def query!(%Req.Request{} = req, sql_query, sql_query_params, opts) do
+    case query(req, sql_query, sql_query_params, opts) do
       {:ok, response} -> response
       {:error, exception} -> raise exception
     end

test/req_ch_test.exs

@@ -58,10 +58,12 @@ defmodule ReqCHTest do
     end
   end
 
-  describe "query/3" do
+  describe "query/4" do
     test "a plain query with defaults" do
+      req = ReqCH.new(database: "system")
+
       assert {:ok, %Req.Response{} = response} =
-               ReqCH.query("SELECT number FROM system.numbers LIMIT 3")
+               ReqCH.query(req, "SELECT number FROM numbers LIMIT 3", [], [])
 
       assert response.status == 200
 
@@ -72,22 +74,32 @@ defmodule ReqCHTest do
              """
     end
 
-    test "a plain query with database" do
+    test "a query with params and database in opts" do
+      req = ReqCH.new()
+
       assert {:ok, %Req.Response{} = response} =
-               ReqCH.query("SELECT number FROM numbers LIMIT 3", [], database: "system")
+               ReqCH.query(
+                 req,
+                 "SELECT number FROM numbers WHERE number > {num:UInt8} LIMIT 3",
+                 [num: 25],
+                 database: "system"
+               )
 
       assert response.status == 200
 
       assert response.body == """
-             0
-             1
-             2
+             26
+             27
+             28
              """
     end
 
     test "with format option as :explorer" do
+      req = ReqCH.new()
+
       assert {:ok, %Req.Response{} = response} =
                ReqCH.query(
+                 req,
                  "SELECT number, number - 2 as less_two from system.numbers LIMIT 10",
                  [],
                  format: :explorer
@@ -105,6 +117,7 @@ defmodule ReqCHTest do
     test "with format option as :explorer but different format in the query" do
       assert {:ok, %Req.Response{} = response} =
                ReqCH.query(
+                 ReqCH.new(),
                  "SELECT number, number - 2 as less_two from system.numbers LIMIT 10 FORMAT JSON",
                  format: :explorer
                )
@@ -141,6 +154,7 @@ defmodule ReqCHTest do
     test "with format :json" do
       assert {:ok, %Req.Response{} = response} =
                ReqCH.query(
+                 ReqCH.new(),
                  "SELECT number, number - 2 as less_two from system.numbers LIMIT 3",
                  [],
                  format: :json
@@ -170,6 +184,7 @@ defmodule ReqCHTest do
 
       assert_raise ArgumentError, error_message, fn ->
         ReqCH.query(
+          ReqCH.new(),
           "SELECT number from system.numbers LIMIT 10",
           [],
           format: :invalid_format
@@ -180,6 +195,7 @@ defmodule ReqCHTest do
     test "a query with params" do
       assert {:ok, %Req.Response{} = response} =
                ReqCH.query(
+                 ReqCH.new(),
                  "SELECT number FROM system.numbers WHERE number > {num:UInt8} LIMIT 7",
                  num: 5
                )
@@ -200,6 +216,7 @@ defmodule ReqCHTest do
     test "a query with unknown database" do
       assert {:ok, %Req.Response{} = response} =
                ReqCH.query(
+                 ReqCH.new(),
                  "SELECT number FROM sistema WHERE number > {num:UInt8} LIMIT 7",
                  num: 5
                )