aboutsummaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorReynold Xin <rxin@cs.berkeley.edu>2013-05-14 23:29:57 -0700
committerReynold Xin <rxin@cs.berkeley.edu>2013-05-14 23:29:57 -0700
commitf9d40a5848a2e1eef31ac63cd9221d5b77c1c5a7 (patch)
treea045b0394a1ba7f61b17fd1610446bf0101ab958 /core
parent404f9ff617401a2f8d12845861ce8f02cfe6442c (diff)
downloadspark-f9d40a5848a2e1eef31ac63cd9221d5b77c1c5a7.tar.gz
spark-f9d40a5848a2e1eef31ac63cd9221d5b77c1c5a7.tar.bz2
spark-f9d40a5848a2e1eef31ac63cd9221d5b77c1c5a7.zip
Added a comment in JdbcRDD for example usage.
Diffstat (limited to 'core')
-rw-r--r--core/src/main/scala/spark/rdd/JdbcRDD.scala4
1 files changed, 3 insertions, 1 deletions
diff --git a/core/src/main/scala/spark/rdd/JdbcRDD.scala b/core/src/main/scala/spark/rdd/JdbcRDD.scala
index b0f7054233..a50f407737 100644
--- a/core/src/main/scala/spark/rdd/JdbcRDD.scala
+++ b/core/src/main/scala/spark/rdd/JdbcRDD.scala
@@ -11,11 +11,13 @@ private[spark] class JdbcPartition(idx: Int, val lower: Long, val upper: Long) e
/**
* An RDD that executes an SQL query on a JDBC connection and reads results.
+ * For usage example, see test case JdbcRDDSuite.
+ *
* @param getConnection a function that returns an open Connection.
* The RDD takes care of closing the connection.
* @param sql the text of the query.
* The query must contain two ? placeholders for parameters used to partition the results.
- * E.g. "select title, author from books where ? <= id and id <= ?"
+ * E.g. "select title, author from books where ? <= id and id <= ?"
* @param lowerBound the minimum value of the first placeholder
* @param upperBound the maximum value of the second placeholder
* The lower and upper bounds are inclusive.