db.connect.dsn: Create a connection to a database

In greenplum-db/GreenplumR: A Fast, Easy-to-Use Tool for Manipulating Tables in Databases

Create a connection to a database

Description

Create a connection to a PostgreSQL or Greenplum (Pivotal) database. One can create multiple connections to multiple databases. The connections are indexed by an integer starting from 1.

Usage

db.connect.dsn(dsn.key, db.ini = "~/db.ini",
default.schemas = NULL, verbose = TRUE, quick = FALSE)

Arguments

dsn.key	A string. The key name of the DSN file, containing info about connections. The useful key names of a dsn are: username, password, host, port, dbname, driver. The key names are case sensitive.
db.ini	A string, default is '~/db.ini'. db.ini is the path of the DSN file.
default.schemas	A string, default is NULL. The search path or default schemas of the database that you want to use. The string must be a set of schema names separated by commas. One can also use db.default.schemas or db.search.path to display or set the search path in the database.
verbose	A logival value, default is TRUE, whether to print some information while connecting to the database.
quick	A logical value, default is FALSE. Whether to skip some of the argument checks to speed up the creation of the connection. Useful when using this function inside a function, where you have already validate all the arguments. It is not recommended to set this value to TRUE when you are using this function directly.

Value

An integer, the ID number for the newly created connection.

Note

Right now only PostgreSQL and Greenplum databases are supported.

Author(s)

Author: Extensions Team at Pivotal Inc.

Maintainer: Hao Wu, Pivotal Inc. [e-mail]

See Also

db.connect connects a connection.

db.disconnect disconnects a connection.

db.list lists all active connections.

connection info the functions that extract information about the connection.

conn.eql tests whether two connections are the same.

db.search.path and db.default.schemas displays or sets the search path (i.e. default schemas) in the connected database.

Examples

## Not run: 
## connect to a database


## set up the database connection
## Assume that ~/db.ini contains all information about connections
## and there is a dsn key named foobar in db.ini. Each dsn has
## multiple key-value pairs. The useful key names are:
## username, password, host, port, dbname, driver.
cid <- db.connect.dsn('foobar', db.ini = '~/db.ini', verbose = FALSE)

db.disconnect(cid, verbose = FALSE)

## End(Not run)

greenplum-db/GreenplumR documentation built on Sept. 2, 2023, 8:09 a.m.