rscontract_ide: Mirrors the RStudio IDE connection contract arguments

In edgararuiz/rscontract: Generic implementation of the 'RStudio' connections contract

Description

Creates an object that contains all of the necessary information to create a connection contract. This function if meant as a lower level integration with the connections pane.

Usage

rscontract_ide(
  connectionObject = NULL,
  type = "",
  host = "",
  icon = NULL,
  displayName = "",
  connectCode = "",
  disconnect = function() { },
  previewObject = function() { },
  listObjectTypes = default_types(),
  listObjects = function() { },
  listColumns = function() { },
  actions = NULL
)

Arguments

connectionObject	The connection object. Default to NULL.
type	Type of the connection.
host	Name of the host
icon	Path to the connection's icon. Defaults to NULL.
displayName	The connection's name.
connectCode	The text of the connection code.
disconnect	Function to use to disconnect. Default to function().
previewObject	Function to run when the preview table icon is clicked on. Default to function().
listObjectTypes	Function that provides the structure of the connection. The default function will work properly, it is going to be rare when it needs to be changed.
listObjects	Function to run to get the catalogs, schema, tables or views based what has been expanded on. Default to function().
listColumns	Function to run that pull the field information. Default to function().
actions	Additional buttons to add to the connection pane. Defaults to NULL.

Value

An 'rs_contract_ide' class object

Examples

str(rscontract_ide())

edgararuiz/rscontract documentation built on Dec. 19, 2020, 9:28 a.m.