HBASE-1600 Table#checkAndPut() docs are too vague (Csaba Skrabak)

This commit is contained in:
Michael Stack 2016-10-25 09:19:32 -07:00
parent caa1a8494a
commit 36aa416856
1 changed files with 17 additions and 2 deletions

View File

@ -231,7 +231,12 @@ public interface Table extends Closeable {
/** /**
* Atomically checks if a row/family/qualifier value matches the expected * Atomically checks if a row/family/qualifier value matches the expected
* value. If it does, it adds the put. If the passed value is null, the check * value. If it does, it adds the put. If the passed value is null, the check
* is for the lack of column (ie: non-existance) * is for the lack of column (ie: non-existence)
*
* The expected value argument of this call is on the left and the current
* value of the cell is on the right side of the comparison operator.
*
* Ie. eg. GREATER operator means expected value > existing <=> add the put.
* *
* @param row to check * @param row to check
* @param family column family to check * @param family column family to check
@ -286,7 +291,12 @@ public interface Table extends Closeable {
/** /**
* Atomically checks if a row/family/qualifier value matches the expected * Atomically checks if a row/family/qualifier value matches the expected
* value. If it does, it adds the delete. If the passed value is null, the * value. If it does, it adds the delete. If the passed value is null, the
* check is for the lack of column (ie: non-existance) * check is for the lack of column (ie: non-existence)
*
* The expected value argument of this call is on the left and the current
* value of the cell is on the right side of the comparison operator.
*
* Ie. eg. GREATER operator means expected value > existing <=> add the delete.
* *
* @param row to check * @param row to check
* @param family column family to check * @param family column family to check
@ -555,6 +565,11 @@ public interface Table extends Closeable {
* If it does, it performs the row mutations. If the passed value is null, the check * If it does, it performs the row mutations. If the passed value is null, the check
* is for the lack of column (ie: non-existence) * is for the lack of column (ie: non-existence)
* *
* The expected value argument of this call is on the left and the current
* value of the cell is on the right side of the comparison operator.
*
* Ie. eg. GREATER operator means expected value > existing <=> perform row mutations.
*
* @param row to check * @param row to check
* @param family column family to check * @param family column family to check
* @param qualifier column qualifier to check * @param qualifier column qualifier to check