PivotalR (version 0.1.18.5)

db.search.path: Display or set the search path (i.e. default schemas) for a connected session to a database. The use can easily switch to a schema that he has the privilege to write.

Description

Allow the user to check and set the search path for the session that he connects to the database. The search path is a set of schema names separated by commas. These are the default schemas that the programme will search and save tables if a schema name is not given together with the table name in the format of "schema_name.table_name".

Usage

db.search.path(conn.id = 1, set = NULL)
db.default.schemas(conn.id = 1, set = NULL)

Arguments

conn.id

An integer, default is 1. The ID of the database connection.

set

A string, default is NULL. The default schema names separated by commas.

Value

When set is NULL, this function prints the current connected session's search path.

See Also

db.connect connects to database, and the parameter default.schemas can be used to set the search path when connecting.

Examples

# NOT RUN {
<!-- %% @test .port Database port number -->
<!-- %% @test .dbname Database name -->
## set up the database connection
## Assume that .port is port number and .dbname is the database name
cid <- db.connect(port = .port, dbname = .dbname, verbose = FALSE, default.schemas =
"public,madlib")

db.search.path()

db.search.path(set = "public,madlibtestdata")

db.disconnect(cid, verbose = FALSE)
# }