Package 'orderly.db' reference manual

Title:	Database Support for 'orderly2'
Description:	Access databases from 'orderly2' while running reports. Includes the basic 'SQL' support originally included in 'orderly' for establishing connections and setting up data for use within a report.
Authors:	Rich FitzJohn [aut, cre], Imperial College of Science, Technology and Medicine [cph]
Maintainer:	Rich FitzJohn <[email protected]>
License:	MIT + file LICENSE
Version:	0.1.3
Built:	2024-11-28 03:39:21 UTC
Source:	https://github.com/mrc-ide/orderly.db

Create connection to database

Create a persistent connection object to the database

orderly_db_connection(database = NULL, instance = NULL)
orderly_db_connection(database = NULL, instance = NULL)

`database`	The name of the database. This can be omitted (or `NULL`) where you only have a single database, but must be specified if you have more than one database configured.
`instance`	The instance of the database (within a given `database`). This can be omitted (or `NULL`) where you have not used instances or where you have only one configured.

The connection object

Extract data from a database

orderly_db_query(query, database = NULL, instance = NULL, name = NULL)
orderly_db_query(query, database = NULL, instance = NULL, name = NULL)

`query`	Query to evaluate
`database`	The name of the database. This can be omitted (or `NULL`) where you only have a single database, but must be specified if you have more than one database configured.
`instance`	The instance of the database (within a given `database`). This can be omitted (or `NULL`) where you have not used instances or where you have only one configured.
`name`	An optional name that you can use to look up this query in your metadata.

The extracted data

Create temporary view

orderly_db_view(query, as, database = NULL, instance = NULL)
orderly_db_view(query, as, database = NULL, instance = NULL)

`query`	Query to create view from
`as`	Name of the view in the database
`database`	The name of the database. This can be omitted (or `NULL`) where you only have a single database, but must be specified if you have more than one database configured.
`instance`	The instance of the database (within a given `database`). This can be omitted (or `NULL`) where you have not used instances or where you have only one configured.

Undefined