| Type: | Package |
| Title: | Open Database Connectivity Resource Resolver |
| Version: | 1.0.0 |
| Description: | A database resource that is accessible through the Open Database Connectivity ('ODBC') API. This package uses the Resource model, with URL "resolver" and "client", to dynamically discover and make accessible tables stored in a 'MS SQL Server' database. For more details see Marcon (2021) <doi:10.1371/journal.pcbi.1008880>. |
| License: | LGPL-2.1 | LGPL-3 [expanded from: LGPL (≥ 2.1)] |
| Depends: | R6, httr, resourcer, odbc, DBI |
| Suggests: | testthat, knitr, rmarkdown |
| BugReports: | https://github.com/obiba/odbc.resourcer/issues |
| RoxygenNote: | 7.3.3 |
| VignetteBuilder: | knitr |
| Encoding: | UTF-8 |
| NeedsCompilation: | no |
| Packaged: | 2025-11-02 19:42:58 UTC; yannick |
| Author: | Yannick Marcon 
[aut, cre],
OBiBa group [cph] |
| Maintainer: | Yannick Marcon <yannick.marcon@obiba.org> |
| Repository: | CRAN |
| Date/Publication: | 2025-11-05 20:20:02 UTC |
MS SQL DBI resource connector
Description
MS SQL DBI resource connector
MS SQL DBI resource connector
Format
A R6 object of class MSSQLResourceConnector
Details
Makes a ODBC DBI connection to a MS SQL server from a resource description.
Super classes
resourcer::DBIResourceConnector -> odbc.resourcer::ODBCResourceConnector -> MSSQLResourceConnector
Methods
Public methods
Inherited methods
Method new()
Creates a new MSSQLResourceConnector instance.
Usage
MSSQLResourceConnector$new()
Returns
A MSSQLResourceConnector object.
Method isFor()
Check that the provided resource has a URL that locates a MS SQL object: the URL scheme must be "odbc+mssql".
Usage
MSSQLResourceConnector$isFor(resource)
Arguments
resourceThe resource object to validate.
Returns
A logical.
Method getConnectionParameters()
Get the MS SQL ODBC driver connection string.
Usage
MSSQLResourceConnector$getConnectionParameters(resource)
Arguments
resourceA valid resource object.
Returns
The MS SQL ODBC driver connection parameters list.
Method clone()
The objects of this class are cloneable with this method.
Usage
MSSQLResourceConnector$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
## Not run:
# Create a resource
res <- resourcer::newResource(
url = "odbc+mssql://localhost:1433/EpidemiologyDB/PatientData",
identity = "sa", secret = "YourStrong@Password123")
# Create a resource client
client <- resourcer::newResourceClient(res)
# Coerce resource to a data frame
df <- client$asDataFrame()
# Disconnect the client
client$close()
## End(Not run)
ODBC DBI resource connector
Description
ODBC DBI resource connector
ODBC DBI resource connector
Format
A R6 object of class ODBCResourceConnector
Details
Makes a ODBC DBI connection from a resource description.
Super class
resourcer::DBIResourceConnector -> ODBCResourceConnector
Methods
Public methods
Inherited methods
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
resourceThe resource object to validate.
Returns
A logical.
Method createDBIConnection()
Creates a DBI connection object from a resource.
Usage
ODBCResourceConnector$createDBIConnection(resource)
Arguments
resourceA valid resource object.
Returns
A DBI connection object.
Method getConnectionParameters()
Get the specific ODBC driver connection string.
Usage
ODBCResourceConnector$getConnectionParameters(resource)
Arguments
resourceA 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
deepWhether to make a deep clone.