org.apache.hadoop.hbase

Class TestPartialResultsFromClientSide

java.lang.Object

org.apache.hadoop.hbase.TestPartialResultsFromClientSide

public class TestPartialResultsFromClientSide
extends Object

These tests are focused on testing how partial results appear to a client. Partial results are Results that contain only a portion of a row's complete list of cells. Partial results are formed when the server breaches its maximum result size when trying to service a client's RPC request. It is the responsibility of the scanner on the client side to recognize when partial results have been returned and to take action to form the complete results.

Unless the flag Scan.setAllowPartialResults(boolean) has been set to true, the caller of ResultScanner.next() should never see partial results.

Constructor Summary

Constructors

Constructor and Description
TestPartialResultsFromClientSide()

Method Summary

Modifier and Type	Method and Description
static void	setUpBeforeClass()
static void	tearDownAfterClass()
void	testAllowPartialResults() Ensure that we only see Results marked as partial when the allowPartial flag is set
void	testEquivalenceOfScanResults() Ensure that the results returned from a scanner that retrieves all results in a single RPC call matches the results that are returned from a scanner that must incrementally combine partial results into complete results.
void	testEquivalenceOfScanResults(Table table, Scan scan1, Scan scan2)
void	testExceptionThrownOnMismatchedPartialResults() When reconstructing the complete result from its partials we ensure that the row of each partial result is the same.
void	testExpectedNumberOfCellsPerPartialResult() Setting the max result size allows us to control how many cells we expect to see on each call to next on the scanner.
void	testExpectedNumberOfCellsPerPartialResult(Scan baseScan)
void	testExpectedNumberOfCellsPerPartialResult(Scan baseScan, int expectedNumberOfCells)
void	testExpectedValuesOfPartialResults() Ensure that the expected key values appear in a result returned from a scanner that is combining partial results into complete results
void	testExpectedValuesOfPartialResults(boolean reversed)
void	testNoPartialResultsWhenRowFilterPresent() When a scan has a filter where Filter.hasFilterRow() is true, the scanner should not return partial results.
void	testOrderingOfCellsInPartialResults() Order of cells in partial results matches the ordering of cells from complete results
void	testOrderingOfCellsInPartialResults(Scan basePartialScan)
void	testPartialResultsAndBatch() Test various combinations of batching and partial results for correctness
void	testPartialResultsAndBatch(int batch, int cellsPerPartialResult)
void	testPartialResultsAndCaching() Examine the interaction between the maxResultSize and caching.
void	testPartialResultsAndCaching(int resultSizeRowLimit, int cachingRowLimit)
void	testPartialResultsReassembly() Test the method Result#createCompleteResult(List, Result)
void	testPartialResultsReassembly(Scan scanBase)
void	testPartialResultsWithColumnFilter() Test partial Result re-assembly in the presence of different filters.
void	testPartialResultsWithColumnFilter(Filter filter)
void	testReadPointAndPartialResults()
void	testSmallScansDoNotAllowPartials() Small scans should not return partial results because it would prevent small scans from retrieving all of the necessary results in a single RPC request which is what makese small scans useful.
void	testSmallScansDoNotAllowPartials(Scan baseScan)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TestPartialResultsFromClientSide

public TestPartialResultsFromClientSide()

Method Detail

setUpBeforeClass

public static void setUpBeforeClass()
                             throws Exception

Throws:

Exception

tearDownAfterClass

public static void tearDownAfterClass()
                               throws Exception

Throws:

Exception

testExpectedValuesOfPartialResults

public void testExpectedValuesOfPartialResults()
                                        throws Exception

Ensure that the expected key values appear in a result returned from a scanner that is combining partial results into complete results

Throws:

Exception

testExpectedValuesOfPartialResults

public void testExpectedValuesOfPartialResults(boolean reversed)
                                        throws Exception

Throws:

Exception

testAllowPartialResults

public void testAllowPartialResults()
                             throws Exception

Ensure that we only see Results marked as partial when the allowPartial flag is set

Throws:

Exception

testEquivalenceOfScanResults

public void testEquivalenceOfScanResults()
                                  throws Exception

Ensure that the results returned from a scanner that retrieves all results in a single RPC call matches the results that are returned from a scanner that must incrementally combine partial results into complete results. A variety of scan configurations can be tested

Throws:

Exception

testEquivalenceOfScanResults

public void testEquivalenceOfScanResults(Table table,
                                         Scan scan1,
                                         Scan scan2)
                                  throws Exception

Throws:

Exception

testOrderingOfCellsInPartialResults

public void testOrderingOfCellsInPartialResults()
                                         throws Exception

Order of cells in partial results matches the ordering of cells from complete results

Throws:

Exception

testOrderingOfCellsInPartialResults

public void testOrderingOfCellsInPartialResults(Scan basePartialScan)
                                         throws Exception

Throws:

Exception

testExpectedNumberOfCellsPerPartialResult

public void testExpectedNumberOfCellsPerPartialResult()
                                               throws Exception

Setting the max result size allows us to control how many cells we expect to see on each call to next on the scanner. Test a variety of different sizes for correctness

Throws:

Exception

testExpectedNumberOfCellsPerPartialResult

public void testExpectedNumberOfCellsPerPartialResult(Scan baseScan)
                                               throws Exception

Throws:

Exception

testExpectedNumberOfCellsPerPartialResult

public void testExpectedNumberOfCellsPerPartialResult(Scan baseScan,
                                                      int expectedNumberOfCells)
                                               throws Exception

Throws:

Exception

testPartialResultsAndBatch

public void testPartialResultsAndBatch()
                                throws Exception

Test various combinations of batching and partial results for correctness

Throws:

Exception

testPartialResultsAndBatch

public void testPartialResultsAndBatch(int batch,
                                       int cellsPerPartialResult)
                                throws Exception

Throws:

Exception

testPartialResultsReassembly

public void testPartialResultsReassembly()
                                  throws Exception

Test the method Result#createCompleteResult(List, Result)

Throws:

Exception

testPartialResultsReassembly

public void testPartialResultsReassembly(Scan scanBase)
                                  throws Exception

Throws:

Exception

testExceptionThrownOnMismatchedPartialResults

public void testExceptionThrownOnMismatchedPartialResults()
                                                   throws IOException

When reconstructing the complete result from its partials we ensure that the row of each partial result is the same. If one of the rows differs, an exception is thrown.

Throws:

IOException

testNoPartialResultsWhenRowFilterPresent

public void testNoPartialResultsWhenRowFilterPresent()
                                              throws Exception

When a scan has a filter where Filter.hasFilterRow() is true, the scanner should not return partial results. The scanner cannot return partial results because the entire row needs to be read for the include/exclude decision to be made

Throws:

Exception

testPartialResultsAndCaching

public void testPartialResultsAndCaching()
                                  throws Exception

Examine the interaction between the maxResultSize and caching. If the caching limit is reached before the maxResultSize limit, we should not see partial results. On the other hand, if the maxResultSize limit is reached before the caching limit, it is likely that partial results will be seen.

Throws:

Exception

testPartialResultsAndCaching

public void testPartialResultsAndCaching(int resultSizeRowLimit,
                                         int cachingRowLimit)
                                  throws Exception

Parameters:

resultSizeRowLimit - The row limit that will be enforced through maxResultSize

cachingRowLimit - The row limit that will be enforced through caching

Throws:

Exception

testSmallScansDoNotAllowPartials

public void testSmallScansDoNotAllowPartials()
                                      throws Exception

Small scans should not return partial results because it would prevent small scans from retrieving all of the necessary results in a single RPC request which is what makese small scans useful. Thus, ensure that even when Scan.getAllowPartialResults() is true, small scans do not return partial results

Throws:

Exception

testSmallScansDoNotAllowPartials

public void testSmallScansDoNotAllowPartials(Scan baseScan)
                                      throws Exception

Throws:

Exception

testReadPointAndPartialResults

public void testReadPointAndPartialResults()
                                    throws Exception

Throws:

Exception

testPartialResultsWithColumnFilter

public void testPartialResultsWithColumnFilter()
                                        throws Exception

Test partial Result re-assembly in the presence of different filters. The Results from the partial scanner should match the Results returned from a scanner that receives all of the results in one RPC to the server. The partial scanner is tested with a variety of different result sizes (all of which are less than the size necessary to fetch an entire row)

Throws:

Exception

testPartialResultsWithColumnFilter

public void testPartialResultsWithColumnFilter(Filter filter)
                                        throws Exception

Throws:

Exception