connect: Connect to scidb and return a RevealConnection object.

View source: R/connect.R

connectR Documentation

Connect to scidb and return a RevealConnection object.

Description

Connect to scidb and return a RevealConnection object.

Usage

connect(
  pkg_schema,
  username = NULL,
  password = NULL,
  host = NULL,
  port = NULL,
  protocol = "https",
  result_size_limit = 2 * 1048,
  db = NULL
)

Arguments

username

username of user to log in as

password

password for the user. If null, will be requested interactively.

host

if NULL, attempt to set automatically from Apache config

port

if NULL, attempt to set automatically from Apache config

protocol

protocol type

db

A db connection from scidbconnect. If not NULL, use instead of username / password / host / port / protocol to connect to Scidb

results_size_limit

Maximum size of any single result from a scidb query over this connection. Query results larger than the specified size will error.

Value

a RevealConnection object


Paradigm4/revealcore documentation built on May 21, 2023, 9:57 a.m.