TextQuery.httpapi: Execute a query that outputs data in a text format. The data...

View source: R/httpapi.R

TextQuery.httpapiR Documentation

Execute a query that outputs data in a text format. The data is returned as an R data frame.

Description

Execute a query that outputs data in a text format. The data is returned as an R data frame.

Usage

TextQuery.httpapi(
  db,
  query_or_scidb,
  format = NULL,
  use_aio = NULL,
  only_attributes = NULL,
  ...
)

Arguments

db

scidb connection object from scidbconnect

query_or_scidb

a SciDB query expression or scidb object

format

(default: "csv+:l") a SciDB format string for a text format. This string must be an accepted option for the save() operator (if use_aio is omitted or FALSE) or the aio_save() operator (if use_aio is TRUE).

use_aio

(logical; default: FALSE) if TRUE, use the aio_save() operator to construct the output. The accelerated_io_tools library must be loaded in SciDB. NOTE: Due to SDB-7925, this parameter is currently ignored.

only_attributes

(logical; default:FALSE) By default, the first N columns of the output are coordinates for the N dimensions of the query's schema. If only_attributes is TRUE, these columns are not included.

...

extra arguments are ignored (allows some query functions to take optional arguments without causing errors in other query functions)

Value

the query result as an R data frame, or NULL if the query did not produce a result


Paradigm4/SciDBR documentation built on Nov. 9, 2023, 4:58 a.m.