connector (version 1.0.0)

log-functions: Connector Logging Functions

Description

A comprehensive set of generic functions and methods for logging connector operations. These functions provide automatic logging capabilities for read, write, remove, and list operations across different connector types, enabling transparent audit trails and operation tracking.

Usage

log_read_connector(connector_object, name, ...)
# S3 method for default
log_read_connector(connector_object, name, ...)
log_write_connector(connector_object, name, ...)
# S3 method for default
log_write_connector(connector_object, name, ...)
log_remove_connector(connector_object, name, ...)
# S3 method for default
log_remove_connector(connector_object, name, ...)
log_list_content_connector(connector_object, ...)
# S3 method for ConnectorDBI
log_read_connector(connector_object, name, ...)
# S3 method for ConnectorDBI
log_write_connector(connector_object, name, ...)
# S3 method for ConnectorDBI
log_remove_connector(connector_object, name, ...)
# S3 method for ConnectorFS
log_read_connector(connector_object, name, ...)
# S3 method for ConnectorFS
log_write_connector(connector_object, name, ...)
# S3 method for ConnectorFS
log_remove_connector(connector_object, name, ...)

Value

These are primarily side-effect functions that perform logging. The actual return value depends on the specific method implementation, typically:

• log_read_connector: Result of the read operation

• log_write_connector: Invisible result of write operation

• log_remove_connector: Invisible result of remove operation

• log_list_content_connector: List of connector contents

Arguments

connector_object

The connector object to log operations for. Can be any connector class (ConnectorFS, ConnectorDBI, ConnectorLogger, etc.)

name

Character string specifying the name or identifier of the resource being operated on (e.g., file name, table name)

...

Additional parameters passed to specific method implementations. May include connector-specific options or metadata.

Available Operations

log_read_connector(connector_object, name, ...)

Logs read operations when data is retrieved from a connector. Automatically called by read_cnt() and tbl_cnt() methods.

log_write_connector(connector_object, name, ...)

Logs write operations when data is stored to a connector. Automatically called by write_cnt() and upload_cnt() methods.

log_remove_connector(connector_object, name, ...)

Logs removal operations when resources are deleted from a connector. Automatically called by remove_cnt() methods.

log_list_content_connector(connector_object, ...)

Logs listing operations when connector contents are queried. Automatically called by list_content_cnt() methods.

Supported Connector Types

Each connector type has specialized logging implementations:

ConnectorFS

File system connectors log the full file path and operation type. Example log: "dataset.csv @ /path/to/data"

ConnectorDBI

Database connectors log driver information and database name. Example log: "table_name @ driver: SQLiteDriver, dbname: mydb.sqlite"

Integration with whirl Package

All logging operations use the whirl package for consistent log output:

• whirl::log_read() - For read operations

• whirl::log_write() - For write operations

• whirl::log_delete() - For remove operations

Details

Connector Logging Functions

The logging system is built around S3 generic functions that dispatch to specific implementations based on the connector class. Each operation is logged with contextual information including connector details, operation type, and resource names.

See Also

add_logs for adding logging capability to connectors, ConnectorLogger for the logger class, whirl package for underlying logging implementation

Examples

# Basic usage with file system connector
logged_fs <- add_logs(connectors(data = connector_fs(path = tempdir())))

# Write operation (automatically logged)
write_cnt(logged_fs$data, mtcars, "cars.csv")
# Output: "cars.csv @ /tmp/RtmpXXX"

#' # Read operation (automatically logged)
data <- read_cnt(logged_fs$data, "cars.csv")
# Output: "dataset.csv @ /tmp/RtmpXXX"

# Database connector example
logged_db <- add_logs(connectors(db = connector_dbi(RSQLite::SQLite(), ":memory:")))

# Operations are logged with database context
write_cnt(logged_db$db, iris, "iris_table")
# Output: "iris_table @ driver: SQLiteDriver, dbname: :memory:"