@spec attach(Req.Request.t(), keyword()) :: Req.Request.t()

Attaches to Req request.

request-options

Request Options

• :goth - Required. The goth server name.

• :project_id - Required. The GCP project id.

• :bigquery - Required. The query to execute. It can be a plain sql string or a {query, params} tuple, where query can contain ? placeholders and params is a list of corresponding values.

• :default_dataset_id - Optional. If set, the dataset to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.

If you want to set any of these options when attaching the plugin, pass them as the second argument.

examples

Examples

With plain query string:

iex> credentials = File.read!("credentials.json") |> Jason.decode!()
iex> source = {:service_account, credentials, []}
iex> {:ok, _} = Goth.start_link(name: MyGoth, source: source, http_client: &Req.request/1)
iex> project_id = System.fetch_env!("PROJECT_ID")
iex> query = """
...> SELECT title, SUM(views) AS views
...>   FROM `bigquery-public-data.wikipedia.table_bands`
...>  WHERE EXTRACT(YEAR FROM datehour) <= 2021
...>  GROUP BY title
...>  ORDER BY views DESC
...>  LIMIT 10
...> """
iex> req = Req.new() |> ReqBigQuery.attach(goth: MyGoth, project_id: project_id)
iex> Req.post!(req, bigquery: query).body
%ReqBigQuery.Result{
  columns: ["title", "views"],
  job_id: "job_JDDZKquJWkY7x0LlDcmZ4nMQqshb",
  num_rows: 10,
  rows: [
    ["The_Beatles", 13758950],
    ["Queen_(band)", 12019563],
    ["Pink_Floyd", 9522503],
    ["AC/DC", 8972364],
    ["Led_Zeppelin", 8294994],
    ["Linkin_Park", 8242802],
    ["The_Rolling_Stones", 7825952],
    ["Red_Hot_Chili_Peppers", 7302904],
    ["Fleetwood_Mac", 7199563],
    ["Twenty_One_Pilots", 6970692]
  ]
}

With parameterized query:

iex> credentials = File.read!("credentials.json") |> Jason.decode!()
iex> source = {:service_account, credentials, []}
iex> {:ok, _} = Goth.start_link(name: MyGoth, source: source, http_client: &Req.request/1)
iex> project_id = System.fetch_env!("PROJECT_ID")
iex> query = """
...> SELECT EXTRACT(YEAR FROM datehour) AS year, SUM(views) AS views
...>   FROM `bigquery-public-data.wikipedia.table_bands`
...>  WHERE EXTRACT(YEAR FROM datehour) <= 2021
...>    AND title = ?
...>  GROUP BY 1
...>  ORDER BY views DESC
...> """
iex> req = Req.new() |> ReqBigQuery.attach(goth: MyGoth, project_id: project_id)
iex> Req.post!(req, bigquery: {query, ["Linkin_Park"]}).body
%ReqBigQuery.Result{
  columns: ["year", "views"],
  job_id: "job_GXiJvALNsTAoAOJ39Eg3Mw94XMUQ",
  num_rows: 7,
  rows: [[2017, 2895889], [2016, 1173359], [2018, 1133770], [2020, 906538], [2015, 860899], [2019, 790747], [2021, 481600]]
}