Package: rocker 0.3.1

rocker: Database Interface Class

'R6' class interface for handling relational database connections using 'DBI' package as backend. The class allows handling of connections to e.g. PostgreSQL, MariaDB and SQLite. The purpose is having an intuitive object allowing straightforward handling of SQL databases.

Authors:Nikolaus Pawlowski [aut, cre, cph]

rocker_0.3.1.tar.gz
rocker_0.3.1.zip(r-4.5)rocker_0.3.1.zip(r-4.4)rocker_0.3.1.zip(r-4.3)
rocker_0.3.1.tgz(r-4.4-any)rocker_0.3.1.tgz(r-4.3-any)
rocker_0.3.1.tar.gz(r-4.5-noble)rocker_0.3.1.tar.gz(r-4.4-noble)
rocker_0.3.1.tgz(r-4.4-emscripten)rocker_0.3.1.tgz(r-4.3-emscripten)
rocker.pdf |rocker.html✨
rocker/json (API)
NEWS

# Install 'rocker' in R:
install.packages('rocker', repos = c('https://nikolaus77.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/nikolaus77/rocker/issues

On CRAN:

databasedbimariadbmysqlpostgrespostgresqlr6sqlsqlite

5.24 score 5 stars 7 scripts 184 downloads 40 exports 3 dependencies

Last updated 2 years agofrom:0655c90cf0. Checks:OK: 5 NOTE: 2. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 07 2024
R-4.5-winNOTENov 07 2024
R-4.5-linuxNOTENov 07 2024
R-4.4-winOKNov 07 2024
R-4.4-macOKNov 07 2024
R-4.3-winOKNov 07 2024
R-4.3-macOKNov 07 2024

Exports:appendTablebegincanConnectclearResultcolumnInfocommitconnectcreateTabledisconnectexecuteexistsTablefetchgetInfoCongetInfoDrvgetInfoResgetQuerygetRowCountgetRowsAffectedgetStatementhasCompletedisValidConisValidDrvisValidReslistFieldslistObjectslistTablesnewDBreadTableremoveTablerockerrollbacksendQuerysendStatementsetupDriversetupMariaDBsetupPostgreSQLsetupSQLiteunloadDrivervalidateConwriteTable

Dependencies:DBIR6sodium

Database transactions with R6 rocker class

Nikolaus Pawlowski

Rendered fromTransactions.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-11
Started: 2021-12-02

DBI package objects and functions in R6 rocker class

Nikolaus Pawlowski

Rendered fromDBI_objects_and_functions.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-11
Started: 2021-12-02

Initiation of SQL database connections in R6 rocker class

Nikolaus Pawlowski

Rendered fromDatabase_connections.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-29
Started: 2021-12-02

Installation and set up of R6 rocker object

Nikolaus Pawlowski

Rendered fromInstallation_and_Object.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-29
Started: 2021-12-29

Protected password (credentials) storage inside of R6 rocker class

Nikolaus Pawlowski

Rendered fromPassword_storage.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-11
Started: 2021-12-02

Usage of relational databases (SQLite, PostgreSQL and MariaDB) with R6 rocker class

Nikolaus Pawlowski

Rendered fromPackages_and_databases.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-11
Started: 2021-12-02

Usage of S3 class functions on R6 rocker class

Nikolaus Pawlowski

Rendered fromS3_and_R6_functions.Rmdusingknitr::rmarkdownon Nov 07 2024.

Last update: 2021-12-11
Started: 2021-12-02

Readme and manuals

Help Manual

Help pageTopics
Append data to table.appendTable
Begin transaction.begin
Test connection parameters.canConnect
Clear query or statement result.clearResult
Information on query result columns.columnInfo
Commit transaction.commit
Establish database connection using stored parameters.connect
Create empty formatted table.createTable
Disconnect database.disconnect
Execute SQL statement in database. Combination of functions execute and clearResult. If required, database is automatically connected and disconnected.execute
Check if table exists.existsTable
Fetch SQL query result from database.fetch
Information on connection object.getInfoCon
Information on driver object.getInfoDrv
Information on result object.getInfoRes
Retrieve SQL query from database. Combination of functions sendQuery(), fetch() and clearResult(). If required, database is automatically connected and disconnected.getQuery
Information on number of retrieved rows.getRowCount
Information on number of affected rows.getRowsAffected
Information on sent statement.getStatement
Information whether all records were retrieved.hasCompleted
Check connection object.isValidCon
Check driver object.isValidDrv
Check result object.isValidRes
List table column names.listFields
List database objects.listObjects
List database tables.listTables
newDBnewDB
Read table.readTable
Remove table.removeTable
'rocker' Database Interface R6 Classrocker rocker-R6-class
READMErocker-README
'rocker' Database Interface R6 Class - S3 functionsrocker-S3-functions
Rollback transaction.rollback
Send SQL query to database.sendQuery
Send SQL statement to database.sendStatement
Setup database driver and define connection parameters.setupDriver
Setup database driver and define connection parameters for MariaDB using RMariaDB package. Wrapper for setupDriver() function.setupMariaDB
Setup database driver and define connection parameters for PostgreSQL using RPostgres package. Wrapper for setupDriver() function.setupPostgreSQL
Setup database driver and define connection parameters for SQLite using RSQLite package. Wrapper for setupDriver() function.setupSQLite
Reset database driver and connection parameters.unloadDriver
Check if an earlier opened connection is still open.validateCon
Write data to table.writeTable