print-methods: Display the connection information associated with a 'db'...

Description Usage Arguments Details Value Author(s) See Also Examples

Description

This function displays the SQL table, database, host, and connection information associated with a db.table or db.view object.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## S4 method for signature 'db.data.frame'
print(x)

## S4 method for signature 'db.Rquery'
print(x)

## S4 method for signature 'db.data.frame'
show(object)

## S4 method for signature 'db.Rquery'
show(object)

Arguments

x

The signature of the method. A db.data.frame (includes db.table and db.view) object, which points to a table or view in the database; or a db.Rquery object, which represents some operations on a db.data.frame object.

object

The signature of the method. A db.data.frame (includes db.table and db.view) object, which points to a table or view in the database; or a db.Rquery object, which represents some operations on a db.data.frame object.

Details

When the signature x is either a db.data.frame object or a db.Rquery object, this function displays the name of connected SQL database, the SQL database host, and the connection ID.

When the signature x is a db.data.frame object, the function also displays the associated table. When the signature x is a db.Rquery object, this function displays the temporary status of the input, and the table that it is derived from.

Value

This function returns nothing.

Author(s)

Author: Predictive Analytics Team at Pivotal Inc.

Maintainer: Frank McQuillan, Pivotal Inc. [email protected]

See Also

lk or lookat Displays the contents of an associated table.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 


## 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)

## create a table from the example data.frame "abalone"
x <- as.db.data.frame(abalone, conn.id = cid, verbose = FALSE)

## printing db.data.frame object
x # Display the associated table, and database information for x

db.disconnect(cid, verbose = FALSE)

## End(Not run)

PivotalR documentation built on May 30, 2017, 8:18 a.m.