makeLocalConnDetails: Make a local Postgres Connection Details object

In patelm9/pg13: pg13 Package

Description

Connect and disconnect to a local Postgres database that does not require credentialing. These functions automatically set the dbms and server arguments to "postgresql" and "localhost/dbname", leaving the database name (dbname) and port (port) as the only connection details that are modifiable by the user. Note that these functions cannot be used to connect to a local instance that requires a username and password.

Connect and disconnect to a local Postgres database that does not require credentialing. These functions automatically set the dbms and server arguments to "postgresql" and "localhost/dbname", leaving the database name (dbname) and port (port) as the only connection details that are modifiable by the user. Note that these functions cannot be used to connect to a local instance that requires a username and password.

Usage

makeLocalConnDetails(dbname = "athena", port = 5432)

Arguments

dbname	Name of a local Postgres database, Default: 'athena'
port	The port on the server to connect to, Default: 5432

Value

A connectionDetails class object that lists all the details needed to connect to a database.

Local ConnectionDetails

This function returns a connectionDetails class object for functions that make the database connection within its caller environment, such as those belonging to the OHDSI Feature Extraction package. A connection can be made by passing the connectionDetails class object to the connect. This process can be simplified into a single function call with localConnect, which performs both operations but will not return a connectionDetails object if it is desired as a return value.

This function returns a connectionDetails class object for functions that make the database connection within its caller environment, such as those belonging to the OHDSI Feature Extraction package. A connection can be made by passing the connectionDetails class object to the connect. This process can be simplified into a single function call with localConnect, which performs both operations but will not return a connectionDetails object if it is desired as a return value.

See Also

createConnectionDetails

Other local functions: localConnect(), local_connect(), local(), make_local_conn_details()

patelm9/pg13 documentation built on Dec. 26, 2021, 8:17 p.m.