RegLogMongoConnector: Connector to MongoDB database

RegLogMongoConnectorR Documentation

Connector to MongoDB database

Description

[Experimental]

Object of this class handles all connections for the RegLogServer object to the database. It is created to handle MongoDB database compatible drivers. Provides methods than will be used by RegLogServer to get and send data.

Requires mongolite package to be installed.

Super class

shiny.reglog::RegLogConnector -> RegLogMongoConnector

Methods

Public methods

Inherited methods

Method new()

Initialization of the object

Usage
RegLogMongoConnector$new(
  mongo_url,
  mongo_db,
  mongo_options = mongolite::ssl_options(),
  collections = c("account", "reset_code", "logs"),
  custom_handlers = NULL
)
Arguments
mongo_url

URI to the MongoDB cluster

mongo_db

name of the MongoDB database

mongo_options

additional connection options such as SSL keys/certs

collections

names of the collections

custom_handlers

named list of custom handler functions. Every custom handler should take arguments: self and private - relating to the R6 object and message of class RegLogConnectorMessage. It should return RegLogConnectorMessage object.

table_names

character vector. Contains names of the collections in the database: first containing user data, second - reset codes information, third (optional) - logs from the object. For more info check documentation of mongo_database_create.

Returns

Object of RegLogMongoConnector class


Method clone()

The objects of this class are cloneable with this method.

Usage
RegLogMongoConnector$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


shiny.reglog documentation built on Aug. 31, 2022, 1:06 a.m.