BinaryQuery.httpapi: Execute a query that outputs data in Apache Arrow format or...

In Paradigm4/SciDBR: An R Interface to SciDB

Execute a query that outputs data in Apache Arrow format or SciDB binary format. The data is returned as an R data frame. This function takes the same arguments as BinaryQuery but with extra optional arguments.

Description

Execute a query that outputs data in Apache Arrow format or SciDB binary format. The data is returned as an R data frame. This function takes the same arguments as BinaryQuery but with extra optional arguments.

Usage

## S3 method for class 'httpapi'
BinaryQuery(
  db,
  query_or_scidb,
  arrow = FALSE,
  use_aio = NULL,
  buffer_size = NULL,
  only_attributes = NULL,
  schema = NULL,
  page_size = NULL,
  npages = NULL,
  ...
)

Arguments

db	scidb connection object from scidbconnect
query_or_scidb	a SciDB query expression or scidb object
arrow	(logical; default: FALSE) if TRUE, output data in Apache Arrow format. This automatically sets use_aio to 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.
buffer_size	(optional integer) Initial parse buffer size in bytes, adaptively resized as needed. Larger buffers can be faster but consume more memory. Default size is determined by the connection implementation.
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.
schema	(optional string) the SciDB schema that the query is expected to produce; if not supplied, use the actual schema returned by the query. In the HTTP API, there is no longer any advantage to supplying the schema ahead of time; this argument is only accepted for backward compatibility.
page_size	(optional integer) maximum number of values to return per page of output. Normally this function reads all pages before returning, so this is treated similarly to buffer_size. NOTE: Due to SDB-7836, SciDB does not support paging for binary or Arrow data formats, so this argument is currently ignored.
npages	(optional integer) maximum number of pages to return. NOTE: Due to SDB-7836, SciDB does not support paging for binary or Arrow data formats, so this argument is currently ignored.
...	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

See Also

BinaryQuery()

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