odbc.resourcer (version 1.0.0)

ODBCResourceConnector: ODBC DBI resource connector

Description

ODBC DBI resource connector

ODBC DBI resource connector

Format

A R6 object of class ODBCResourceConnector

Super class

resourcer::DBIResourceConnector -> ODBCResourceConnector

Methods

Public methods

• ODBCResourceConnector$new()

• ODBCResourceConnector$isFor()

• ODBCResourceConnector$createDBIConnection()

• ODBCResourceConnector$getConnectionParameters()

• ODBCResourceConnector$clone()

Inherited methods

• resourcer::DBIResourceConnector$closeDBIConnection()
• resourcer::DBIResourceConnector$getTableName()
• resourcer::DBIResourceConnector$readDBTable()
• resourcer::DBIResourceConnector$readDBTibble()

---

Method new()

Creates a new ODBCResourceConnector instance.

Usage

ODBCResourceConnector$new()

Returns

A ODBCResourceConnector object.

---

Method isFor()

Check that the provided resource has a URL that locates a ODBC object: the URL scheme must start with "odbc".

Usage

ODBCResourceConnector$isFor(resource)

Arguments

resource

The resource object to validate.

Returns

A logical.

---

Method createDBIConnection()

Creates a DBI connection object from a resource.

Usage

ODBCResourceConnector$createDBIConnection(resource)

Arguments

resource

A valid resource object.

Returns

A DBI connection object.

---

Method getConnectionParameters()

Get the specific ODBC driver connection string.

Usage

ODBCResourceConnector$getConnectionParameters(resource)

Arguments

resource

A valid resource object.

Returns

The ODBC driver connection parameters list.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ODBCResourceConnector$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

Makes a ODBC DBI connection from a resource description.