| dsGetInfo {DSI} | R Documentation |
Get DataSHIELD-aware data repository metadata
Description
Get DataSHIELD-aware data repository metadata
Usage
dsGetInfo(dsObj, ...)
Arguments
dsObj |
An object inheriting from |
... |
Other arguments to methods. |
Value
a named list
Implementation notes
For 'DSDriver' subclasses, this should include the version of the package ('driver.version') and the version of the underlying client library ('client.version').
For 'DSConnection' objects this should report the version of the data repository application ('repo.version') and its name ('repo.name'), the database name ('dbname'), username, ('username'), host ('host'), port ('port'), etc. It MAY also include any other arguments related to the connection (e.g., thread id, socket or TCP connection type). It MUST NOT include the password.
For 'DSResult' objects, this should include the R expression being executed (an expression object tailored by the implementation of DSI) and if the query is complete (a result object tailored by the implementation of DSI).
See Also
Other DSDriver generics:
DSDriver-class,
dsConnect()
Other DSConnection generics:
DSConnection-class,
dsAggregate(),
dsAssignExpr(),
dsAssignResource(),
dsAssignTable(),
dsDisconnect(),
dsHasResource(),
dsHasTable(),
dsIsAsync(),
dsKeepAlive(),
dsListMethods(),
dsListPackages(),
dsListProfiles(),
dsListResources(),
dsListSymbols(),
dsListTables(),
dsListWorkspaces(),
dsRestoreWorkspace(),
dsRmSymbol(),
dsRmWorkspace(),
dsSaveWorkspace()
Other DSResult generics:
DSResult-class,
dsFetch(),
dsIsCompleted()