dbi.attach: Attach a Database Schema to the Search Path

View source: R/attach.R

dbi.attachR Documentation

Attach a Database Schema to the Search Path

Description

The database schema is attached to the R search path. This means that the schema is searched by R when evaluating a variable, so that dbi.tables in the schema can be accessed by simply giving their names.

Usage

dbi.attach(
  what,
  pos = 2L,
  name = NULL,
  warn.conflicts = FALSE,
  schema = NULL,
  graphics = TRUE
)

Arguments

what

a connection handle returned by dbConnect or a zero-argument function that returns a connection handle.

pos

an integer specifying position in search() where to attach.

name

a character string specifying the name to use for the attached database.

warn.conflicts

a logical value. If TRUE, warnings are printed about conflicts from attaching the database, unless that database contains an object .conflicts.OK. A conflict is a function masking a function, or a non-function masking a non-function.

schema

a character string specifying the name of the schema to attach.

graphics

a logical value; passed to menu. In interactive sessions, when schema is NULL and multiple schemas are found on what, a menu is displayed to select a schema.

Value

an environment, the attached schema is invisibly returned.

See Also

attach


dbi.table documentation built on June 29, 2025, 1:07 a.m.