AzureKusto: DBI interface: connect to a Kusto cluster

In cloudyr/AzureKusto: Interface to 'Kusto'/'Azure Data Explorer'

DBI interface: connect to a Kusto cluster

Description

Functions to connect to a Kusto cluster.

Usage

AzureKusto()

## S4 method for signature 'AzureKustoDriver'
dbConnect(drv, ..., bigint = c("numeric", "integer64"))

## S4 method for signature 'AzureKustoDriver'
dbCanConnect(drv, ...)

## S4 method for signature 'AzureKustoDriver'
dbDisconnect(conn, ...)

Arguments

drv	An AzureKusto DBI driver object, instantiated with AzureKusto().
...	Authentication arguments supplied to kusto_database_endpoint.
bigint	How to treat Kusto long integer columns. By default, they will be converted to R numeric variables. If this is "integer64", they will be converted to integer64 variables using the bit64 package.
conn	For dbDisconnect, an AzureKustoConnection object obtained with dbConnect.

Details

Kusto is connectionless, so dbConnect simply wraps a database endpoint object, generated with kusto_database_endpoint(...). The endpoint itself can be accessed via the ⁠@endpoint⁠ slot. Similarly, dbDisconnect always returns TRUE.

dbCanConnect attempts to detect whether querying the database with the given information and credentials will be successful. The result may not be accurate; essentially all it does is check that its arguments are valid Kusto properties. Ultimately the best way to tell if querying will work is to try it.

Value

For dbConnect, an object of class AzureKustoConnection.

For dbCanConnect, TRUE if authenticating with the Kusto server succeeded with the given arguments, and FALSE otherwise.

For dbDisconnect, always TRUE, invisibly.

See Also

kusto-DBI, dbReadTable, dbWriteTable, dbGetQuery, dbSendStatement, kusto_database_endpoint

Examples

## Not run: 
db <- DBI::dbConnect(AzureKusto(),
    server="https://mycluster.westus.kusto.windows.net", database="database", tenantid="contoso")

DBI::dbDisconnect(db)

# no authentication credentials: returns FALSE
DBI::dbCanConnect(AzureKusto(),
    server="https://mycluster.westus.kusto.windows.net")


## End(Not run)

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