Skip to content

Commit d26562f

Browse files
authored
Do not mention querying and bypassing ReqCH.query
1 parent 0872cba commit d26562f

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

lib/req_ch.ex

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,13 @@ defmodule ReqCH do
3939
4040
## Examples
4141
42-
After setting a default database, one can make a request directly:
42+
After setting a default database, one can make queries using `query/4` and
43+
`query!/4`:
4344
4445
iex> req = ReqCH.new(database: "system")
45-
iex> Req.post!(req, body: "SELECT number + 1 FROM numbers LIMIT 3").body
46+
iex> ReqCH.query!(req, "SELECT number + 1 FROM numbers LIMIT 3").body
4647
"1\\n2\\n3\\n"
4748
48-
Although, if you want to pass any parameter, you would need to manually
49-
encode them. For this reason, prefer to use `query/4` for doing queries.
50-
5149
In case the server needs authentication, it's possible to use `Req` options for that.
5250
5351
iex> req = ReqCH.new(base_url: "http://example.org:8123", auth: {:basic, "user:pass"})

0 commit comments

Comments
 (0)