rscontract_ide: Mirrors the RStudio IDE connection contract arguments

Description Usage Arguments Value Examples

View source: R/rscontract_ide.R

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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

1

rscontract documentation built on Feb. 11, 2020, 1:06 a.m.