aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChandan Rajah <chandan.rajah@gmail.com>2013-06-06 12:35:31 +0100
committerChandan Rajah <chandan.rajah@gmail.com>2013-06-06 12:35:31 +0100
commit7ac084d99e8a248e2004cc983e051d75c3d6d3df (patch)
treed8686208b9c472d8fdcc5b14337dd1b4c420c8cb
parentc5111d865ea662564f3228f05f5b4d9a8eaffa95 (diff)
downloadSpyGlass-7ac084d99e8a248e2004cc983e051d75c3d6d3df.tar.gz
SpyGlass-7ac084d99e8a248e2004cc983e051d75c3d6d3df.zip
Cosmetic changes to Read Me
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index c68d0b5..9d3759d 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ Building
1. Read Mode Features
=====================
-HBaseSource supports modes namely GET_LIST, SCAN_RANGE and SCAN_ALL. Use the *sourceMode* parameter to select the source mode.
+HBaseSource supports modes namely **GET_LIST**, **SCAN_RANGE** and **SCAN_ALL**. Use the **_sourceMode_** parameter to select the source mode.
- **GET_LIST** -> Provide a list of keys to retrieve from the HBase table
- **SCAN_RANGE** -> Provide a start and stop key (inclusive) to get out of the HBase table.
@@ -24,7 +24,7 @@ HBaseSource supports modes namely GET_LIST, SCAN_RANGE and SCAN_ALL. Use the *so
GET_LIST
--------
-Requires the *keyList* parameter to be specified as well.
+Requires the **keyList** parameter to be specified as well.
(e.g.)
@@ -37,7 +37,7 @@ Requires the *keyList* parameter to be specified as well.
sourceMode = SourceMode.GET_LIST, keyList = List("5003914", "5000687", "5004897"))
-Additionally, the *versions* parameter can be used to retrieve more than one version of the row.
+Additionally, the _versions_ parameter can be used to retrieve more than one version of the row.
(e.g.)
@@ -152,7 +152,8 @@ Setting the *useSalt* parameter to *true* enables this functionality
"quorum_name:2181", 'key,
TABLE_SCHEMA.tail.map((x: Symbol) => "data").toArray,
TABLE_SCHEMA.tail.map((x: Symbol) => new Fields(x.name)).toArray,
- sourceMode = SourceMode.SCAN_RANGE, startKey = "11445", stopKey = "11455", useSalt = true, prefixList = "0123456789" )
+ sourceMode = SourceMode.SCAN_RANGE, startKey = "11445", stopKey = "11455",
+ useSalt = true, prefixList = "0123456789" )
.read
// Convert from ImmutableBytesWritable to String
@@ -189,7 +190,8 @@ Add the trait to the job class and start using the conversions in the pipe direc
"quorum_name:2181", 'key,
TABLE_SCHEMA.tail.map((x: Symbol) => "data").toArray,
TABLE_SCHEMA.tail.map((x: Symbol) => new Fields(x.name)).toArray,
- sourceMode = SourceMode.SCAN_RANGE, startKey = "11445", stopKey = "11455", useSalt = true, prefixList = "0123456789" )
+ sourceMode = SourceMode.SCAN_RANGE, startKey = "11445", stopKey = "11455",
+ useSalt = true, prefixList = "0123456789" )
.read
// Convert from ImmutableBytesWritable to String