QueryApi: Query operations

In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

Query operations

Description

tiledbcloud.Query

Format

An R6Class generator object

Methods

FinalizeQuery send a query to run against a specified array/URI registered to a group/project

• @param namespace character

• @param array character

• @param type character

• @param content.type character

• @param query Query

• @param x.payer character

• @param open.at integer

• @returnType Query
  

• status code : 200 | query completed and results are returned in query object

• return type : Query

• response headers :

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

• status code : 204 | query completed successfully with no return

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

GetEstResultSizes send a query to run against a specified array/URI registered to a group/project

• @param namespace character

• @param array character

• @param type character

• @param content.type character

• @param query Query

• @param x.payer character

• @param open.at integer

• @returnType Query
  

• status code : 200 | query est result size computed and results are returned in query object

• return type : Query

• response headers :

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

• status code : 204 | query completed successfully with no return

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

GetFile send a query to run against a specified array/URI registered to a group/project, returns file bytes

• @param namespace character

• @param array character

• @param content.type character

• @param x.payer character

• status code : 200 | query completed and result bytes are returned

• return type : data.frame

• response headers :

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

• status code : 0 | error response

• return type : Error

• response headers :

SubmitQuery send a query to run against a specified array/URI registered to a group/project

• @param namespace character

• @param array character

• @param type character

• @param content.type character

• @param query Query

• @param x.payer character

• @param open.at integer

• @returnType Query
  

• status code : 200 | query completed and results are returned in query object

• return type : Query

• response headers :

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

• status code : 204 | query completed successfully with no return

• response headers :

• status code : 0 | error response

• return type : Error

• response headers :

SubmitQueryJson send a query to run against a specified array/URI registered to a group/project, returns JSON results

• @param namespace character

• @param array character

• @param content.type character

• @param query.json QueryJson

• @param x.payer character

• status code : 200 | query completed and results are returned in JSON format

• return type : object

• response headers :

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

• status code : 0 | error response

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• QueryApi$new()

• QueryApi$FinalizeQuery()

• QueryApi$FinalizeQueryWithHttpInfo()

• QueryApi$GetEstResultSizes()

• QueryApi$GetEstResultSizesWithHttpInfo()

• QueryApi$GetFile()

• QueryApi$GetFileWithHttpInfo()

• QueryApi$SubmitQuery()

• QueryApi$SubmitQueryWithHttpInfo()

• QueryApi$SubmitQueryJson()

• QueryApi$SubmitQueryJsonWithHttpInfo()

• QueryApi$clone()

---

Method new()

Usage

QueryApi$new(apiClient)

---

Method FinalizeQuery()

Usage

QueryApi$FinalizeQuery(
  namespace,
  array,
  type,
  content.type,
  query,
  x.payer = NULL,
  open.at = NULL,
  ...
)

---

Method FinalizeQueryWithHttpInfo()

Usage

QueryApi$FinalizeQueryWithHttpInfo(
  namespace,
  array,
  type,
  content.type,
  query,
  x.payer = NULL,
  open.at = NULL,
  ...
)

---

Method GetEstResultSizes()

Usage

QueryApi$GetEstResultSizes(
  namespace,
  array,
  type,
  content.type,
  query,
  x.payer = NULL,
  open.at = NULL,
  ...
)

---

Method GetEstResultSizesWithHttpInfo()

Usage

QueryApi$GetEstResultSizesWithHttpInfo(
  namespace,
  array,
  type,
  content.type,
  query,
  x.payer = NULL,
  open.at = NULL,
  ...
)

---

Method GetFile()

Usage

QueryApi$GetFile(namespace, array, content.type, x.payer = NULL, ...)

---

Method GetFileWithHttpInfo()

Usage

QueryApi$GetFileWithHttpInfo(
  namespace,
  array,
  content.type,
  x.payer = NULL,
  ...
)

---

Method SubmitQuery()

Usage

QueryApi$SubmitQuery(
  namespace,
  array,
  type,
  content.type,
  query,
  x.payer = NULL,
  open.at = NULL,
  ...
)

---

Method SubmitQueryWithHttpInfo()

Usage

QueryApi$SubmitQueryWithHttpInfo(
  namespace,
  array,
  type,
  content.type,
  query,
  x.payer = NULL,
  open.at = NULL,
  ...
)

---

Method SubmitQueryJson()

Usage

QueryApi$SubmitQueryJson(
  namespace,
  array,
  content.type,
  query.json,
  x.payer = NULL,
  ...
)

---

Method SubmitQueryJsonWithHttpInfo()

Usage

QueryApi$SubmitQueryJsonWithHttpInfo(
  namespace,
  array,
  content.type,
  query.json,
  x.payer = NULL,
  ...
)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

QueryApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  FinalizeQuery  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.type <- 'type_example' # character | type of query
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.query <- Query$new() # Query | query to run
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request
var.open.at <- 56 # integer | open_at for array in unix epoch

api.instance <- QueryApi$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$FinalizeQuery(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at)


####################  GetEstResultSizes  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.type <- 'type_example' # character | type of query
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.query <- Query$new() # Query | query to run
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request
var.open.at <- 56 # integer | open_at for array in unix epoch

api.instance <- QueryApi$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$GetEstResultSizes(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at)


####################  GetFile  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request

api.instance <- QueryApi$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$GetFile(var.namespace, var.array, var.content.type, x.payer=var.x.payer)


####################  SubmitQuery  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.type <- 'type_example' # character | type of query
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.query <- Query$new() # Query | query to run
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request
var.open.at <- 56 # integer | open_at for array in unix epoch

api.instance <- QueryApi$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$SubmitQuery(var.namespace, var.array, var.type, var.content.type, var.query, x.payer=var.x.payer, open.at=var.open.at)


####################  SubmitQueryJson  ####################

library(tiledbcloud)
var.namespace <- 'namespace_example' # character | namespace array is in (an organization name or user's username)
var.array <- 'array_example' # character | name/uri of array that is url-encoded
var.content.type <- 'application/json' # character | Content Type of input and return mime
var.query.json <- QueryJson$new() # QueryJson | query to run
var.x.payer <- 'x.payer_example' # character | Name of organization or user who should be charged for this request

api.instance <- QueryApi$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$SubmitQueryJson(var.namespace, var.array, var.content.type, var.query.json, x.payer=var.x.payer)



## End(Not run)

TileDB-Inc/TileDB-Cloud-R documentation built on July 18, 2024, 3:33 p.m.