db_connect: Connect to SciDB server and get a ScidbConnection object.

In Paradigm4/ArrayOpR: Toolset for Object-Oriented SciDB Array Operations/Operands

Connect to SciDB server and get a ScidbConnection object.

Description

Connect to SciDB server and get a ScidbConnection object.

Usage

db_connect(
  username = NA,
  token = NA,
  host = "127.0.0.1",
  port = 8083,
  protocol = "https",
  auth_type = "scidb",
  ...,
  save_to_default_conn = TRUE,
  save_token = FALSE,
  db = NULL
)

Arguments

username	SciDB user name
token	SciDB user password or token
host	the host to connect to
port	Port
protocol	Protocol. "https" (preferred, secure) or "http"
auth_type	Authentication type
...	other optional params used in scidb::scidbconnect
save_to_default_conn	A boolean value that determines whether to save the connection object as the default in the arrayop package scope so that it can be retrieved anywhere using get_default_connection. In rare cases should we need to maintain multiple connection objects, we can set save_to_default_conn to FALSE.
save_token	Whether to save token/password. Default FALSE. Do not set to TRUE in production env.
db	A connection object returned by scidb::scidbconnect. If NULL (NULL), username, token, host, ... params must be provided. If set to a valid scidb connection object, then ignore explict params (e.g. username, token, etc.) and use the connection object directly

Value

A Scidbconnection object.

Paradigm4/ArrayOpR documentation built on Dec. 11, 2023, 5:59 a.m.