SqlApi: Sql operations

In eddelbuettel/tldbclr: TileDB Cloud Platform R Client Package

Sql operations

Description

tiledbcloud.Sql

Format

An R6Class generator object

Methods

RunSQL Run a sql query

• @param namespace character

• @param sql SQLParameters

• @param accept.encoding character

• status code : 200 | JSON results in array of objects form, if the query returns results

• return type : array[object]

• response headers :

  X-TILEDB-CLOUD-TASK-ID	Task ID for just completed query

• status code : 204 | SQL executed successfully

• response headers :

  X-TILEDB-CLOUD-TASK-ID	Task ID for just completed query

• status code : 0 | error response

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• SqlApi$new()

• SqlApi$RunSQL()

• SqlApi$RunSQLWithHttpInfo()

• SqlApi$clone()

---

Method new()

Usage

SqlApi$new(apiClient)

---

Method RunSQL()

Usage

SqlApi$RunSQL(namespace, sql, accept.encoding = NULL, ...)

---

Method RunSQLWithHttpInfo()

Usage

SqlApi$RunSQLWithHttpInfo(namespace, sql, accept.encoding = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

SqlApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  RunSQL  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace to run task under is in (an organization name or user's username)
var.sql <- SQLParameters$new() # SQLParameters | sql being submitted
var.accept.encoding <- 'accept.encoding_example' # character | Encoding to use

api.instance <- SqlApi$new()

#Configure API key authorization: ApiKeyAuth
api.instance$apiClient$apiKeys['X-TILEDB-REST-API-KEY'] <- 'TODO_YOUR_API_KEY';

#Configure HTTP basic authorization: BasicAuth
# provide your username in the user-serial format
api.instance$apiClient$username <- '<user-serial>'; 
# provide your api key generated using the developer portal
api.instance$apiClient$password <- '<api_key>';

result <- api.instance$RunSQL(var.namespace, var.sql, accept.encoding=var.accept.encoding)



## End(Not run)

eddelbuettel/tldbclr documentation built on Sept. 25, 2022, 12:46 p.m.