Added db function as an alias of db.q

greenplum-db · Apr 23, 2014 · bbefe09 · bbefe09
1 parent e70e567
commit bbefe09
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: PivotalR
 Type: Package
 Title: R front-end to PostgreSQL and Pivotal (Greenplum) database,
         wrapper for MADlib
-Version: 0.1.15.47
+Version: 0.1.15.48
 Date: 2014-03-10
 Author: Predictive Analytics Team at Pivotal Inc. <user@madlib.net>,
         with contributions from Data Scientist Team at Pivotal Inc.

diff --git a/NAMESPACE b/NAMESPACE
@@ -141,7 +141,7 @@ export("array.len")
 
 exportMethods("na.omit")
 
-export("db.q")
+export("db.q", "db")
 
 export("vcov.lm.madlib", "vcov.lm.madlib.grps",
        "vcov.logregr.madlib.grps", "vcov.logregr.madlib")

diff --git a/R/db.q.R b/R/db.q.R
@@ -2,8 +2,8 @@
 ## directly execute SQL
 ## ----------------------------------------------------------------------
 
-db.q <- function(..., nrows = 100, conn.id = 1, sep = " ",
-                 verbose = TRUE)
+db <- db.q <- function(..., nrows = 100, conn.id = 1, sep = " ",
+                       verbose = TRUE)
 {
     if (!.is.conn.id.valid(conn.id))
         stop(conn.id, " is not a valid connection ID. ",

diff --git a/man/db.q.Rd b/man/db.q.Rd
@@ -1,4 +1,5 @@
 \name{db.q}
+\alias{db}
 \alias{db.q}
 
 \title{
@@ -8,6 +9,8 @@
   This function sends SQL queries into the connected database to execute, and then extracts the result if there is any.
 }
 \usage{
+db(..., nrows = 100, conn.id = 1, sep = " ", verbose = TRUE)
+
 db.q(..., nrows = 100, conn.id = 1, sep = " ", verbose = TRUE)
 }
 
@@ -68,4 +71,4 @@ db.disconnect(cid, verbose = FALSE)
 }
 
 \keyword{utility}
-\keyword{database}
+\keyword{database}