run_query: Run a query or command against a Kusto database

View source: R/query.R

run_queryR Documentation

Run a query or command against a Kusto database

Description

Run a query or command against a Kusto database

Usage

run_query(database, qry_cmd, ..., .http_status_handler = "stop")

Arguments

database

A Kusto database endpoint object, as returned by kusto_database_endpoint.

qry_cmd

A string containing the query or command. In KQL, a database management command is a statement that starts with a "."

...

Named arguments to be used as parameters for a parameterized query. These are ignored for database management commands.

.http_status_handler

The function to use to handle HTTP status codes. The default "stop" will throw an R error via httr::stop_for_status if the status code is not less than 300; other possibilities are "warn", "message" and "pass". The last option will pass through the raw response object from the server unchanged, regardless of the status code. This is mostly useful for debugging purposes, or if you want to see what the Kusto REST API does.

Details

This function is the workhorse of the AzureKusto package. It communicates with the Kusto server and returns the query or command results, as data frames.

See Also

kusto_database_endpoint, ingest_local, ingest_url, ingest_blob, ingest_adls2

Examples

## Not run: 

endp <- kusto_database_endpoint(server="myclust.australiaeast.kusto.windows.net", database="db1")

# a command
run_query(endp, ".show table iris")

# a query
run_query(endp, "iris | count")


## End(Not run)

cloudyr/AzureKusto documentation built on Oct. 15, 2023, 5:42 p.m.