fred-oracle: FRED-Oracle

In Metropolitan-Council/councilR: Functions and Templates for the Metropolitan Council

FRED-Oracle

Description

Functions for interacting with FRED-Oracle.

Usage

FRED_oracle_connection(
  uid = keyring::key_get("FREDOracle.uid"),
  pwd = keyring::key_get("FREDOracle.pwd"),
  url = keyring::key_get("FREDOracle.url"),
  dsn = keyring::key_get("FREDOracle.dsn")
)

fred_oracle_connection(
  uid = keyring::key_get("FREDOracle.uid"),
  pwd = keyring::key_get("FREDOracle.pwd"),
  url = keyring::key_get("FREDOracle.url"),
  dsn = keyring::key_get("FREDOracle.dsn")
)

import_from_FRED_oracle(
  table_name,
  uid = keyring::key_get("FREDOracle.uid"),
  pwd = keyring::key_get("FREDOracle.pwd"),
  url = keyring::key_get("FREDOracle.url"),
  dsn = keyring::key_get("FREDOracle.dsn")
)

import_from_fred_oracle(
  table_name,
  uid = keyring::key_get("FREDOracle.uid"),
  pwd = keyring::key_get("FREDOracle.pwd"),
  url = keyring::key_get("FREDOracle.url"),
  dsn = keyring::key_get("FREDOracle.dsn")
)

Arguments

uid	character, FRED-Oracle user id. Default value is keyring::key_get("FREDOracle.uid"),
pwd	character, FRED-Oracle password. Default value is keyring::key_get("FREDOracle.pwd").
url	character, FRED-Oracle URL. Default value is keyring::key_get("FREDOracle.url").
dsn	character, FRED-Oracle data source name. Default value is keyring::key_get("FREDOracle.dsn").
table_name	character, which table to pull. This should include the database name, separated by a period (i.e. "RESEARCH_WEB.TABLE_NAME")

Details

Both "FRED" and "fred" capitalization are supported.

• fred_oracle_connection() creates an connection to FRED-Oracle. This function will not automatically close the connection, so take care to use DBI::dbDisconnect() once you are done.

• import_from_fred_oracle() imports a given table from FRED-Oracle. The connection will be automatically closed after the table is imported.

Value

fred_oracle_connection() - An ODBC or JDBC connection object

import_from_fred_oracle() - Requested table

Note

See vignette("Credentials") to review credential management.

FRED-Oracle requires its own user id and password, separate from your Met Council credentials. Contact Matt Schroeder in CD-Research for assistance.

You must be set up with the appropriate database drivers to use these functions.

Windows users need ODBC with Oracle drivers. You must also have FREDOracle.dsn set in your keyring. Contact IS support for ODBC and driver installation.

Mac users need unixodbc and freetds, plus Java and JDBC drivers. Additionally, you must have set FREDOracle.url in your keyring and JDBC_HOME in your .Renviron. See instructions in the onboarding guide.

Further examples can be found in vignette("Databases").

See Also

Other database functions: FRED_connection(), emissions_connection(), gis_connection()

Examples

## Not run: 
library(councilR)
library(DBI)

# create connection
conn <- fred_oracle_connection()

# pull table using SQL
DBI::dbGetQuery(conn, "SELECT * FROM RESEARCH_WEB.RES_PERMIT_TYPE")

# disconnect
DBI::dbDisconnect(conn)

# import a specific table, with no additional SQL logic
import_from_FRED(table_name = "RESEARCH_WEB.RES_PERMIT_TYPE")

## End(Not run)

Metropolitan-Council/councilR documentation built on Jan. 28, 2025, 8:33 p.m.