http://git-wip-us.apache.org/repos/asf/hbase-site/blob/346adc37/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html index 8f0943d..63ba3f6 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Scan.html @@ -601,634 +601,657 @@ <span class="sourceLineNo">593</span> /**<a name="line.593"></a> <span class="sourceLineNo">594</span> * Get all available versions.<a name="line.594"></a> <span class="sourceLineNo">595</span> * @return this<a name="line.595"></a> -<span class="sourceLineNo">596</span> */<a name="line.596"></a> -<span class="sourceLineNo">597</span> public Scan setMaxVersions() {<a name="line.597"></a> -<span class="sourceLineNo">598</span> this.maxVersions = Integer.MAX_VALUE;<a name="line.598"></a> -<span class="sourceLineNo">599</span> return this;<a name="line.599"></a> -<span class="sourceLineNo">600</span> }<a name="line.600"></a> -<span class="sourceLineNo">601</span><a name="line.601"></a> -<span class="sourceLineNo">602</span> /**<a name="line.602"></a> -<span class="sourceLineNo">603</span> * Get up to the specified number of versions of each column.<a name="line.603"></a> -<span class="sourceLineNo">604</span> * @param maxVersions maximum versions for each column<a name="line.604"></a> -<span class="sourceLineNo">605</span> * @return this<a name="line.605"></a> -<span class="sourceLineNo">606</span> */<a name="line.606"></a> -<span class="sourceLineNo">607</span> public Scan setMaxVersions(int maxVersions) {<a name="line.607"></a> -<span class="sourceLineNo">608</span> this.maxVersions = maxVersions;<a name="line.608"></a> -<span class="sourceLineNo">609</span> return this;<a name="line.609"></a> -<span class="sourceLineNo">610</span> }<a name="line.610"></a> -<span class="sourceLineNo">611</span><a name="line.611"></a> -<span class="sourceLineNo">612</span> /**<a name="line.612"></a> -<span class="sourceLineNo">613</span> * Set the maximum number of cells to return for each call to next(). Callers should be aware<a name="line.613"></a> -<span class="sourceLineNo">614</span> * that this is not equivalent to calling {@link #setAllowPartialResults(boolean)}.<a name="line.614"></a> -<span class="sourceLineNo">615</span> * If you don't allow partial results, the number of cells in each Result must equal to your<a name="line.615"></a> -<span class="sourceLineNo">616</span> * batch setting unless it is the last Result for current row. So this method is helpful in paging<a name="line.616"></a> -<span class="sourceLineNo">617</span> * queries. If you just want to prevent OOM at client, use setAllowPartialResults(true) is better.<a name="line.617"></a> -<span class="sourceLineNo">618</span> * @param batch the maximum number of values<a name="line.618"></a> -<span class="sourceLineNo">619</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.619"></a> -<span class="sourceLineNo">620</span> */<a name="line.620"></a> -<span class="sourceLineNo">621</span> public Scan setBatch(int batch) {<a name="line.621"></a> -<span class="sourceLineNo">622</span> if (this.hasFilter() && this.filter.hasFilterRow()) {<a name="line.622"></a> -<span class="sourceLineNo">623</span> throw new IncompatibleFilterException(<a name="line.623"></a> -<span class="sourceLineNo">624</span> "Cannot set batch on a scan using a filter" +<a name="line.624"></a> -<span class="sourceLineNo">625</span> " that returns true for filter.hasFilterRow");<a name="line.625"></a> -<span class="sourceLineNo">626</span> }<a name="line.626"></a> -<span class="sourceLineNo">627</span> this.batch = batch;<a name="line.627"></a> -<span class="sourceLineNo">628</span> return this;<a name="line.628"></a> -<span class="sourceLineNo">629</span> }<a name="line.629"></a> -<span class="sourceLineNo">630</span><a name="line.630"></a> -<span class="sourceLineNo">631</span> /**<a name="line.631"></a> -<span class="sourceLineNo">632</span> * Set the maximum number of values to return per row per Column Family<a name="line.632"></a> -<span class="sourceLineNo">633</span> * @param limit the maximum number of values returned / row / CF<a name="line.633"></a> -<span class="sourceLineNo">634</span> */<a name="line.634"></a> -<span class="sourceLineNo">635</span> public Scan setMaxResultsPerColumnFamily(int limit) {<a name="line.635"></a> -<span class="sourceLineNo">636</span> this.storeLimit = limit;<a name="line.636"></a> -<span class="sourceLineNo">637</span> return this;<a name="line.637"></a> -<span class="sourceLineNo">638</span> }<a name="line.638"></a> -<span class="sourceLineNo">639</span><a name="line.639"></a> -<span class="sourceLineNo">640</span> /**<a name="line.640"></a> -<span class="sourceLineNo">641</span> * Set offset for the row per Column Family.<a name="line.641"></a> -<span class="sourceLineNo">642</span> * @param offset is the number of kvs that will be skipped.<a name="line.642"></a> +<span class="sourceLineNo">596</span> * @deprecated It is easy to misunderstand with column family's max versions, so use<a name="line.596"></a> +<span class="sourceLineNo">597</span> * {@link #readAllVersions()} instead.<a name="line.597"></a> +<span class="sourceLineNo">598</span> */<a name="line.598"></a> +<span class="sourceLineNo">599</span> @Deprecated<a name="line.599"></a> +<span class="sourceLineNo">600</span> public Scan setMaxVersions() {<a name="line.600"></a> +<span class="sourceLineNo">601</span> return readAllVersions();<a name="line.601"></a> +<span class="sourceLineNo">602</span> }<a name="line.602"></a> +<span class="sourceLineNo">603</span><a name="line.603"></a> +<span class="sourceLineNo">604</span> /**<a name="line.604"></a> +<span class="sourceLineNo">605</span> * Get up to the specified number of versions of each column.<a name="line.605"></a> +<span class="sourceLineNo">606</span> * @param maxVersions maximum versions for each column<a name="line.606"></a> +<span class="sourceLineNo">607</span> * @return this<a name="line.607"></a> +<span class="sourceLineNo">608</span> * @deprecated It is easy to misunderstand with column family's max versions, so use<a name="line.608"></a> +<span class="sourceLineNo">609</span> * {@link #readVersions(int)} instead.<a name="line.609"></a> +<span class="sourceLineNo">610</span> */<a name="line.610"></a> +<span class="sourceLineNo">611</span> @Deprecated<a name="line.611"></a> +<span class="sourceLineNo">612</span> public Scan setMaxVersions(int maxVersions) {<a name="line.612"></a> +<span class="sourceLineNo">613</span> return readVersions(maxVersions);<a name="line.613"></a> +<span class="sourceLineNo">614</span> }<a name="line.614"></a> +<span class="sourceLineNo">615</span><a name="line.615"></a> +<span class="sourceLineNo">616</span> /**<a name="line.616"></a> +<span class="sourceLineNo">617</span> * Get all available versions.<a name="line.617"></a> +<span class="sourceLineNo">618</span> * @return this<a name="line.618"></a> +<span class="sourceLineNo">619</span> */<a name="line.619"></a> +<span class="sourceLineNo">620</span> public Scan readAllVersions() {<a name="line.620"></a> +<span class="sourceLineNo">621</span> this.maxVersions = Integer.MAX_VALUE;<a name="line.621"></a> +<span class="sourceLineNo">622</span> return this;<a name="line.622"></a> +<span class="sourceLineNo">623</span> }<a name="line.623"></a> +<span class="sourceLineNo">624</span><a name="line.624"></a> +<span class="sourceLineNo">625</span> /**<a name="line.625"></a> +<span class="sourceLineNo">626</span> * Get up to the specified number of versions of each column.<a name="line.626"></a> +<span class="sourceLineNo">627</span> * @param versions specified number of versions for each column<a name="line.627"></a> +<span class="sourceLineNo">628</span> * @return this<a name="line.628"></a> +<span class="sourceLineNo">629</span> */<a name="line.629"></a> +<span class="sourceLineNo">630</span> public Scan readVersions(int versions) {<a name="line.630"></a> +<span class="sourceLineNo">631</span> this.maxVersions = versions;<a name="line.631"></a> +<span class="sourceLineNo">632</span> return this;<a name="line.632"></a> +<span class="sourceLineNo">633</span> }<a name="line.633"></a> +<span class="sourceLineNo">634</span><a name="line.634"></a> +<span class="sourceLineNo">635</span> /**<a name="line.635"></a> +<span class="sourceLineNo">636</span> * Set the maximum number of cells to return for each call to next(). Callers should be aware<a name="line.636"></a> +<span class="sourceLineNo">637</span> * that this is not equivalent to calling {@link #setAllowPartialResults(boolean)}.<a name="line.637"></a> +<span class="sourceLineNo">638</span> * If you don't allow partial results, the number of cells in each Result must equal to your<a name="line.638"></a> +<span class="sourceLineNo">639</span> * batch setting unless it is the last Result for current row. So this method is helpful in paging<a name="line.639"></a> +<span class="sourceLineNo">640</span> * queries. If you just want to prevent OOM at client, use setAllowPartialResults(true) is better.<a name="line.640"></a> +<span class="sourceLineNo">641</span> * @param batch the maximum number of values<a name="line.641"></a> +<span class="sourceLineNo">642</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.642"></a> <span class="sourceLineNo">643</span> */<a name="line.643"></a> -<span class="sourceLineNo">644</span> public Scan setRowOffsetPerColumnFamily(int offset) {<a name="line.644"></a> -<span class="sourceLineNo">645</span> this.storeOffset = offset;<a name="line.645"></a> -<span class="sourceLineNo">646</span> return this;<a name="line.646"></a> -<span class="sourceLineNo">647</span> }<a name="line.647"></a> -<span class="sourceLineNo">648</span><a name="line.648"></a> -<span class="sourceLineNo">649</span> /**<a name="line.649"></a> -<span class="sourceLineNo">650</span> * Set the number of rows for caching that will be passed to scanners.<a name="line.650"></a> -<span class="sourceLineNo">651</span> * If not set, the Configuration setting {@link HConstants#HBASE_CLIENT_SCANNER_CACHING} will<a name="line.651"></a> -<span class="sourceLineNo">652</span> * apply.<a name="line.652"></a> -<span class="sourceLineNo">653</span> * Higher caching values will enable faster scanners but will use more memory.<a name="line.653"></a> -<span class="sourceLineNo">654</span> * @param caching the number of rows for caching<a name="line.654"></a> -<span class="sourceLineNo">655</span> */<a name="line.655"></a> -<span class="sourceLineNo">656</span> public Scan setCaching(int caching) {<a name="line.656"></a> -<span class="sourceLineNo">657</span> this.caching = caching;<a name="line.657"></a> -<span class="sourceLineNo">658</span> return this;<a name="line.658"></a> -<span class="sourceLineNo">659</span> }<a name="line.659"></a> -<span class="sourceLineNo">660</span><a name="line.660"></a> -<span class="sourceLineNo">661</span> /**<a name="line.661"></a> -<span class="sourceLineNo">662</span> * @return the maximum result size in bytes. See {@link #setMaxResultSize(long)}<a name="line.662"></a> -<span class="sourceLineNo">663</span> */<a name="line.663"></a> -<span class="sourceLineNo">664</span> public long getMaxResultSize() {<a name="line.664"></a> -<span class="sourceLineNo">665</span> return maxResultSize;<a name="line.665"></a> -<span class="sourceLineNo">666</span> }<a name="line.666"></a> -<span class="sourceLineNo">667</span><a name="line.667"></a> -<span class="sourceLineNo">668</span> /**<a name="line.668"></a> -<span class="sourceLineNo">669</span> * Set the maximum result size. The default is -1; this means that no specific<a name="line.669"></a> -<span class="sourceLineNo">670</span> * maximum result size will be set for this scan, and the global configured<a name="line.670"></a> -<span class="sourceLineNo">671</span> * value will be used instead. (Defaults to unlimited).<a name="line.671"></a> -<span class="sourceLineNo">672</span> *<a name="line.672"></a> -<span class="sourceLineNo">673</span> * @param maxResultSize The maximum result size in bytes.<a name="line.673"></a> -<span class="sourceLineNo">674</span> */<a name="line.674"></a> -<span class="sourceLineNo">675</span> public Scan setMaxResultSize(long maxResultSize) {<a name="line.675"></a> -<span class="sourceLineNo">676</span> this.maxResultSize = maxResultSize;<a name="line.676"></a> -<span class="sourceLineNo">677</span> return this;<a name="line.677"></a> -<span class="sourceLineNo">678</span> }<a name="line.678"></a> -<span class="sourceLineNo">679</span><a name="line.679"></a> -<span class="sourceLineNo">680</span> @Override<a name="line.680"></a> -<span class="sourceLineNo">681</span> public Scan setFilter(Filter filter) {<a name="line.681"></a> -<span class="sourceLineNo">682</span> super.setFilter(filter);<a name="line.682"></a> -<span class="sourceLineNo">683</span> return this;<a name="line.683"></a> -<span class="sourceLineNo">684</span> }<a name="line.684"></a> -<span class="sourceLineNo">685</span><a name="line.685"></a> -<span class="sourceLineNo">686</span> /**<a name="line.686"></a> -<span class="sourceLineNo">687</span> * Setting the familyMap<a name="line.687"></a> -<span class="sourceLineNo">688</span> * @param familyMap map of family to qualifier<a name="line.688"></a> -<span class="sourceLineNo">689</span> * @return this<a name="line.689"></a> -<span class="sourceLineNo">690</span> */<a name="line.690"></a> -<span class="sourceLineNo">691</span> public Scan setFamilyMap(Map<byte [], NavigableSet<byte []>> familyMap) {<a name="line.691"></a> -<span class="sourceLineNo">692</span> this.familyMap = familyMap;<a name="line.692"></a> -<span class="sourceLineNo">693</span> return this;<a name="line.693"></a> -<span class="sourceLineNo">694</span> }<a name="line.694"></a> -<span class="sourceLineNo">695</span><a name="line.695"></a> -<span class="sourceLineNo">696</span> /**<a name="line.696"></a> -<span class="sourceLineNo">697</span> * Getting the familyMap<a name="line.697"></a> -<span class="sourceLineNo">698</span> * @return familyMap<a name="line.698"></a> -<span class="sourceLineNo">699</span> */<a name="line.699"></a> -<span class="sourceLineNo">700</span> public Map<byte [], NavigableSet<byte []>> getFamilyMap() {<a name="line.700"></a> -<span class="sourceLineNo">701</span> return this.familyMap;<a name="line.701"></a> -<span class="sourceLineNo">702</span> }<a name="line.702"></a> -<span class="sourceLineNo">703</span><a name="line.703"></a> -<span class="sourceLineNo">704</span> /**<a name="line.704"></a> -<span class="sourceLineNo">705</span> * @return the number of families in familyMap<a name="line.705"></a> -<span class="sourceLineNo">706</span> */<a name="line.706"></a> -<span class="sourceLineNo">707</span> public int numFamilies() {<a name="line.707"></a> -<span class="sourceLineNo">708</span> if(hasFamilies()) {<a name="line.708"></a> -<span class="sourceLineNo">709</span> return this.familyMap.size();<a name="line.709"></a> -<span class="sourceLineNo">710</span> }<a name="line.710"></a> -<span class="sourceLineNo">711</span> return 0;<a name="line.711"></a> -<span class="sourceLineNo">712</span> }<a name="line.712"></a> -<span class="sourceLineNo">713</span><a name="line.713"></a> -<span class="sourceLineNo">714</span> /**<a name="line.714"></a> -<span class="sourceLineNo">715</span> * @return true if familyMap is non empty, false otherwise<a name="line.715"></a> -<span class="sourceLineNo">716</span> */<a name="line.716"></a> -<span class="sourceLineNo">717</span> public boolean hasFamilies() {<a name="line.717"></a> -<span class="sourceLineNo">718</span> return !this.familyMap.isEmpty();<a name="line.718"></a> -<span class="sourceLineNo">719</span> }<a name="line.719"></a> -<span class="sourceLineNo">720</span><a name="line.720"></a> -<span class="sourceLineNo">721</span> /**<a name="line.721"></a> -<span class="sourceLineNo">722</span> * @return the keys of the familyMap<a name="line.722"></a> -<span class="sourceLineNo">723</span> */<a name="line.723"></a> -<span class="sourceLineNo">724</span> public byte[][] getFamilies() {<a name="line.724"></a> -<span class="sourceLineNo">725</span> if(hasFamilies()) {<a name="line.725"></a> -<span class="sourceLineNo">726</span> return this.familyMap.keySet().toArray(new byte[0][0]);<a name="line.726"></a> -<span class="sourceLineNo">727</span> }<a name="line.727"></a> -<span class="sourceLineNo">728</span> return null;<a name="line.728"></a> -<span class="sourceLineNo">729</span> }<a name="line.729"></a> -<span class="sourceLineNo">730</span><a name="line.730"></a> -<span class="sourceLineNo">731</span> /**<a name="line.731"></a> -<span class="sourceLineNo">732</span> * @return the startrow<a name="line.732"></a> -<span class="sourceLineNo">733</span> */<a name="line.733"></a> -<span class="sourceLineNo">734</span> public byte [] getStartRow() {<a name="line.734"></a> -<span class="sourceLineNo">735</span> return this.startRow;<a name="line.735"></a> -<span class="sourceLineNo">736</span> }<a name="line.736"></a> -<span class="sourceLineNo">737</span><a name="line.737"></a> -<span class="sourceLineNo">738</span> /**<a name="line.738"></a> -<span class="sourceLineNo">739</span> * @return if we should include start row when scan<a name="line.739"></a> -<span class="sourceLineNo">740</span> */<a name="line.740"></a> -<span class="sourceLineNo">741</span> public boolean includeStartRow() {<a name="line.741"></a> -<span class="sourceLineNo">742</span> return includeStartRow;<a name="line.742"></a> -<span class="sourceLineNo">743</span> }<a name="line.743"></a> -<span class="sourceLineNo">744</span><a name="line.744"></a> -<span class="sourceLineNo">745</span> /**<a name="line.745"></a> -<span class="sourceLineNo">746</span> * @return the stoprow<a name="line.746"></a> -<span class="sourceLineNo">747</span> */<a name="line.747"></a> -<span class="sourceLineNo">748</span> public byte[] getStopRow() {<a name="line.748"></a> -<span class="sourceLineNo">749</span> return this.stopRow;<a name="line.749"></a> -<span class="sourceLineNo">750</span> }<a name="line.750"></a> -<span class="sourceLineNo">751</span><a name="line.751"></a> -<span class="sourceLineNo">752</span> /**<a name="line.752"></a> -<span class="sourceLineNo">753</span> * @return if we should include stop row when scan<a name="line.753"></a> -<span class="sourceLineNo">754</span> */<a name="line.754"></a> -<span class="sourceLineNo">755</span> public boolean includeStopRow() {<a name="line.755"></a> -<span class="sourceLineNo">756</span> return includeStopRow;<a name="line.756"></a> -<span class="sourceLineNo">757</span> }<a name="line.757"></a> -<span class="sourceLineNo">758</span><a name="line.758"></a> -<span class="sourceLineNo">759</span> /**<a name="line.759"></a> -<span class="sourceLineNo">760</span> * @return the max number of versions to fetch<a name="line.760"></a> -<span class="sourceLineNo">761</span> */<a name="line.761"></a> -<span class="sourceLineNo">762</span> public int getMaxVersions() {<a name="line.762"></a> -<span class="sourceLineNo">763</span> return this.maxVersions;<a name="line.763"></a> -<span class="sourceLineNo">764</span> }<a name="line.764"></a> -<span class="sourceLineNo">765</span><a name="line.765"></a> -<span class="sourceLineNo">766</span> /**<a name="line.766"></a> -<span class="sourceLineNo">767</span> * @return maximum number of values to return for a single call to next()<a name="line.767"></a> -<span class="sourceLineNo">768</span> */<a name="line.768"></a> -<span class="sourceLineNo">769</span> public int getBatch() {<a name="line.769"></a> -<span class="sourceLineNo">770</span> return this.batch;<a name="line.770"></a> -<span class="sourceLineNo">771</span> }<a name="line.771"></a> -<span class="sourceLineNo">772</span><a name="line.772"></a> -<span class="sourceLineNo">773</span> /**<a name="line.773"></a> -<span class="sourceLineNo">774</span> * @return maximum number of values to return per row per CF<a name="line.774"></a> -<span class="sourceLineNo">775</span> */<a name="line.775"></a> -<span class="sourceLineNo">776</span> public int getMaxResultsPerColumnFamily() {<a name="line.776"></a> -<span class="sourceLineNo">777</span> return this.storeLimit;<a name="line.777"></a> -<span class="sourceLineNo">778</span> }<a name="line.778"></a> -<span class="sourceLineNo">779</span><a name="line.779"></a> -<span class="sourceLineNo">780</span> /**<a name="line.780"></a> -<span class="sourceLineNo">781</span> * Method for retrieving the scan's offset per row per column<a name="line.781"></a> -<span class="sourceLineNo">782</span> * family (#kvs to be skipped)<a name="line.782"></a> -<span class="sourceLineNo">783</span> * @return row offset<a name="line.783"></a> +<span class="sourceLineNo">644</span> public Scan setBatch(int batch) {<a name="line.644"></a> +<span class="sourceLineNo">645</span> if (this.hasFilter() && this.filter.hasFilterRow()) {<a name="line.645"></a> +<span class="sourceLineNo">646</span> throw new IncompatibleFilterException(<a name="line.646"></a> +<span class="sourceLineNo">647</span> "Cannot set batch on a scan using a filter" +<a name="line.647"></a> +<span class="sourceLineNo">648</span> " that returns true for filter.hasFilterRow");<a name="line.648"></a> +<span class="sourceLineNo">649</span> }<a name="line.649"></a> +<span class="sourceLineNo">650</span> this.batch = batch;<a name="line.650"></a> +<span class="sourceLineNo">651</span> return this;<a name="line.651"></a> +<span class="sourceLineNo">652</span> }<a name="line.652"></a> +<span class="sourceLineNo">653</span><a name="line.653"></a> +<span class="sourceLineNo">654</span> /**<a name="line.654"></a> +<span class="sourceLineNo">655</span> * Set the maximum number of values to return per row per Column Family<a name="line.655"></a> +<span class="sourceLineNo">656</span> * @param limit the maximum number of values returned / row / CF<a name="line.656"></a> +<span class="sourceLineNo">657</span> */<a name="line.657"></a> +<span class="sourceLineNo">658</span> public Scan setMaxResultsPerColumnFamily(int limit) {<a name="line.658"></a> +<span class="sourceLineNo">659</span> this.storeLimit = limit;<a name="line.659"></a> +<span class="sourceLineNo">660</span> return this;<a name="line.660"></a> +<span class="sourceLineNo">661</span> }<a name="line.661"></a> +<span class="sourceLineNo">662</span><a name="line.662"></a> +<span class="sourceLineNo">663</span> /**<a name="line.663"></a> +<span class="sourceLineNo">664</span> * Set offset for the row per Column Family.<a name="line.664"></a> +<span class="sourceLineNo">665</span> * @param offset is the number of kvs that will be skipped.<a name="line.665"></a> +<span class="sourceLineNo">666</span> */<a name="line.666"></a> +<span class="sourceLineNo">667</span> public Scan setRowOffsetPerColumnFamily(int offset) {<a name="line.667"></a> +<span class="sourceLineNo">668</span> this.storeOffset = offset;<a name="line.668"></a> +<span class="sourceLineNo">669</span> return this;<a name="line.669"></a> +<span class="sourceLineNo">670</span> }<a name="line.670"></a> +<span class="sourceLineNo">671</span><a name="line.671"></a> +<span class="sourceLineNo">672</span> /**<a name="line.672"></a> +<span class="sourceLineNo">673</span> * Set the number of rows for caching that will be passed to scanners.<a name="line.673"></a> +<span class="sourceLineNo">674</span> * If not set, the Configuration setting {@link HConstants#HBASE_CLIENT_SCANNER_CACHING} will<a name="line.674"></a> +<span class="sourceLineNo">675</span> * apply.<a name="line.675"></a> +<span class="sourceLineNo">676</span> * Higher caching values will enable faster scanners but will use more memory.<a name="line.676"></a> +<span class="sourceLineNo">677</span> * @param caching the number of rows for caching<a name="line.677"></a> +<span class="sourceLineNo">678</span> */<a name="line.678"></a> +<span class="sourceLineNo">679</span> public Scan setCaching(int caching) {<a name="line.679"></a> +<span class="sourceLineNo">680</span> this.caching = caching;<a name="line.680"></a> +<span class="sourceLineNo">681</span> return this;<a name="line.681"></a> +<span class="sourceLineNo">682</span> }<a name="line.682"></a> +<span class="sourceLineNo">683</span><a name="line.683"></a> +<span class="sourceLineNo">684</span> /**<a name="line.684"></a> +<span class="sourceLineNo">685</span> * @return the maximum result size in bytes. See {@link #setMaxResultSize(long)}<a name="line.685"></a> +<span class="sourceLineNo">686</span> */<a name="line.686"></a> +<span class="sourceLineNo">687</span> public long getMaxResultSize() {<a name="line.687"></a> +<span class="sourceLineNo">688</span> return maxResultSize;<a name="line.688"></a> +<span class="sourceLineNo">689</span> }<a name="line.689"></a> +<span class="sourceLineNo">690</span><a name="line.690"></a> +<span class="sourceLineNo">691</span> /**<a name="line.691"></a> +<span class="sourceLineNo">692</span> * Set the maximum result size. The default is -1; this means that no specific<a name="line.692"></a> +<span class="sourceLineNo">693</span> * maximum result size will be set for this scan, and the global configured<a name="line.693"></a> +<span class="sourceLineNo">694</span> * value will be used instead. (Defaults to unlimited).<a name="line.694"></a> +<span class="sourceLineNo">695</span> *<a name="line.695"></a> +<span class="sourceLineNo">696</span> * @param maxResultSize The maximum result size in bytes.<a name="line.696"></a> +<span class="sourceLineNo">697</span> */<a name="line.697"></a> +<span class="sourceLineNo">698</span> public Scan setMaxResultSize(long maxResultSize) {<a name="line.698"></a> +<span class="sourceLineNo">699</span> this.maxResultSize = maxResultSize;<a name="line.699"></a> +<span class="sourceLineNo">700</span> return this;<a name="line.700"></a> +<span class="sourceLineNo">701</span> }<a name="line.701"></a> +<span class="sourceLineNo">702</span><a name="line.702"></a> +<span class="sourceLineNo">703</span> @Override<a name="line.703"></a> +<span class="sourceLineNo">704</span> public Scan setFilter(Filter filter) {<a name="line.704"></a> +<span class="sourceLineNo">705</span> super.setFilter(filter);<a name="line.705"></a> +<span class="sourceLineNo">706</span> return this;<a name="line.706"></a> +<span class="sourceLineNo">707</span> }<a name="line.707"></a> +<span class="sourceLineNo">708</span><a name="line.708"></a> +<span class="sourceLineNo">709</span> /**<a name="line.709"></a> +<span class="sourceLineNo">710</span> * Setting the familyMap<a name="line.710"></a> +<span class="sourceLineNo">711</span> * @param familyMap map of family to qualifier<a name="line.711"></a> +<span class="sourceLineNo">712</span> * @return this<a name="line.712"></a> +<span class="sourceLineNo">713</span> */<a name="line.713"></a> +<span class="sourceLineNo">714</span> public Scan setFamilyMap(Map<byte [], NavigableSet<byte []>> familyMap) {<a name="line.714"></a> +<span class="sourceLineNo">715</span> this.familyMap = familyMap;<a name="line.715"></a> +<span class="sourceLineNo">716</span> return this;<a name="line.716"></a> +<span class="sourceLineNo">717</span> }<a name="line.717"></a> +<span class="sourceLineNo">718</span><a name="line.718"></a> +<span class="sourceLineNo">719</span> /**<a name="line.719"></a> +<span class="sourceLineNo">720</span> * Getting the familyMap<a name="line.720"></a> +<span class="sourceLineNo">721</span> * @return familyMap<a name="line.721"></a> +<span class="sourceLineNo">722</span> */<a name="line.722"></a> +<span class="sourceLineNo">723</span> public Map<byte [], NavigableSet<byte []>> getFamilyMap() {<a name="line.723"></a> +<span class="sourceLineNo">724</span> return this.familyMap;<a name="line.724"></a> +<span class="sourceLineNo">725</span> }<a name="line.725"></a> +<span class="sourceLineNo">726</span><a name="line.726"></a> +<span class="sourceLineNo">727</span> /**<a name="line.727"></a> +<span class="sourceLineNo">728</span> * @return the number of families in familyMap<a name="line.728"></a> +<span class="sourceLineNo">729</span> */<a name="line.729"></a> +<span class="sourceLineNo">730</span> public int numFamilies() {<a name="line.730"></a> +<span class="sourceLineNo">731</span> if(hasFamilies()) {<a name="line.731"></a> +<span class="sourceLineNo">732</span> return this.familyMap.size();<a name="line.732"></a> +<span class="sourceLineNo">733</span> }<a name="line.733"></a> +<span class="sourceLineNo">734</span> return 0;<a name="line.734"></a> +<span class="sourceLineNo">735</span> }<a name="line.735"></a> +<span class="sourceLineNo">736</span><a name="line.736"></a> +<span class="sourceLineNo">737</span> /**<a name="line.737"></a> +<span class="sourceLineNo">738</span> * @return true if familyMap is non empty, false otherwise<a name="line.738"></a> +<span class="sourceLineNo">739</span> */<a name="line.739"></a> +<span class="sourceLineNo">740</span> public boolean hasFamilies() {<a name="line.740"></a> +<span class="sourceLineNo">741</span> return !this.familyMap.isEmpty();<a name="line.741"></a> +<span class="sourceLineNo">742</span> }<a name="line.742"></a> +<span class="sourceLineNo">743</span><a name="line.743"></a> +<span class="sourceLineNo">744</span> /**<a name="line.744"></a> +<span class="sourceLineNo">745</span> * @return the keys of the familyMap<a name="line.745"></a> +<span class="sourceLineNo">746</span> */<a name="line.746"></a> +<span class="sourceLineNo">747</span> public byte[][] getFamilies() {<a name="line.747"></a> +<span class="sourceLineNo">748</span> if(hasFamilies()) {<a name="line.748"></a> +<span class="sourceLineNo">749</span> return this.familyMap.keySet().toArray(new byte[0][0]);<a name="line.749"></a> +<span class="sourceLineNo">750</span> }<a name="line.750"></a> +<span class="sourceLineNo">751</span> return null;<a name="line.751"></a> +<span class="sourceLineNo">752</span> }<a name="line.752"></a> +<span class="sourceLineNo">753</span><a name="line.753"></a> +<span class="sourceLineNo">754</span> /**<a name="line.754"></a> +<span class="sourceLineNo">755</span> * @return the startrow<a name="line.755"></a> +<span class="sourceLineNo">756</span> */<a name="line.756"></a> +<span class="sourceLineNo">757</span> public byte [] getStartRow() {<a name="line.757"></a> +<span class="sourceLineNo">758</span> return this.startRow;<a name="line.758"></a> +<span class="sourceLineNo">759</span> }<a name="line.759"></a> +<span class="sourceLineNo">760</span><a name="line.760"></a> +<span class="sourceLineNo">761</span> /**<a name="line.761"></a> +<span class="sourceLineNo">762</span> * @return if we should include start row when scan<a name="line.762"></a> +<span class="sourceLineNo">763</span> */<a name="line.763"></a> +<span class="sourceLineNo">764</span> public boolean includeStartRow() {<a name="line.764"></a> +<span class="sourceLineNo">765</span> return includeStartRow;<a name="line.765"></a> +<span class="sourceLineNo">766</span> }<a name="line.766"></a> +<span class="sourceLineNo">767</span><a name="line.767"></a> +<span class="sourceLineNo">768</span> /**<a name="line.768"></a> +<span class="sourceLineNo">769</span> * @return the stoprow<a name="line.769"></a> +<span class="sourceLineNo">770</span> */<a name="line.770"></a> +<span class="sourceLineNo">771</span> public byte[] getStopRow() {<a name="line.771"></a> +<span class="sourceLineNo">772</span> return this.stopRow;<a name="line.772"></a> +<span class="sourceLineNo">773</span> }<a name="line.773"></a> +<span class="sourceLineNo">774</span><a name="line.774"></a> +<span class="sourceLineNo">775</span> /**<a name="line.775"></a> +<span class="sourceLineNo">776</span> * @return if we should include stop row when scan<a name="line.776"></a> +<span class="sourceLineNo">777</span> */<a name="line.777"></a> +<span class="sourceLineNo">778</span> public boolean includeStopRow() {<a name="line.778"></a> +<span class="sourceLineNo">779</span> return includeStopRow;<a name="line.779"></a> +<span class="sourceLineNo">780</span> }<a name="line.780"></a> +<span class="sourceLineNo">781</span><a name="line.781"></a> +<span class="sourceLineNo">782</span> /**<a name="line.782"></a> +<span class="sourceLineNo">783</span> * @return the max number of versions to fetch<a name="line.783"></a> <span class="sourceLineNo">784</span> */<a name="line.784"></a> -<span class="sourceLineNo">785</span> public int getRowOffsetPerColumnFamily() {<a name="line.785"></a> -<span class="sourceLineNo">786</span> return this.storeOffset;<a name="line.786"></a> +<span class="sourceLineNo">785</span> public int getMaxVersions() {<a name="line.785"></a> +<span class="sourceLineNo">786</span> return this.maxVersions;<a name="line.786"></a> <span class="sourceLineNo">787</span> }<a name="line.787"></a> <span class="sourceLineNo">788</span><a name="line.788"></a> <span class="sourceLineNo">789</span> /**<a name="line.789"></a> -<span class="sourceLineNo">790</span> * @return caching the number of rows fetched when calling next on a scanner<a name="line.790"></a> +<span class="sourceLineNo">790</span> * @return maximum number of values to return for a single call to next()<a name="line.790"></a> <span class="sourceLineNo">791</span> */<a name="line.791"></a> -<span class="sourceLineNo">792</span> public int getCaching() {<a name="line.792"></a> -<span class="sourceLineNo">793</span> return this.caching;<a name="line.793"></a> +<span class="sourceLineNo">792</span> public int getBatch() {<a name="line.792"></a> +<span class="sourceLineNo">793</span> return this.batch;<a name="line.793"></a> <span class="sourceLineNo">794</span> }<a name="line.794"></a> <span class="sourceLineNo">795</span><a name="line.795"></a> <span class="sourceLineNo">796</span> /**<a name="line.796"></a> -<span class="sourceLineNo">797</span> * @return RowFilter<a name="line.797"></a> +<span class="sourceLineNo">797</span> * @return maximum number of values to return per row per CF<a name="line.797"></a> <span class="sourceLineNo">798</span> */<a name="line.798"></a> -<span class="sourceLineNo">799</span> @Override<a name="line.799"></a> -<span class="sourceLineNo">800</span> public Filter getFilter() {<a name="line.800"></a> -<span class="sourceLineNo">801</span> return filter;<a name="line.801"></a> -<span class="sourceLineNo">802</span> }<a name="line.802"></a> -<span class="sourceLineNo">803</span><a name="line.803"></a> -<span class="sourceLineNo">804</span> /**<a name="line.804"></a> -<span class="sourceLineNo">805</span> * @return true is a filter has been specified, false if not<a name="line.805"></a> -<span class="sourceLineNo">806</span> */<a name="line.806"></a> -<span class="sourceLineNo">807</span> public boolean hasFilter() {<a name="line.807"></a> -<span class="sourceLineNo">808</span> return filter != null;<a name="line.808"></a> -<span class="sourceLineNo">809</span> }<a name="line.809"></a> -<span class="sourceLineNo">810</span><a name="line.810"></a> -<span class="sourceLineNo">811</span> /**<a name="line.811"></a> -<span class="sourceLineNo">812</span> * Set whether blocks should be cached for this Scan.<a name="line.812"></a> -<span class="sourceLineNo">813</span> * <p><a name="line.813"></a> -<span class="sourceLineNo">814</span> * This is true by default. When true, default settings of the table and<a name="line.814"></a> -<span class="sourceLineNo">815</span> * family are used (this will never override caching blocks if the block<a name="line.815"></a> -<span class="sourceLineNo">816</span> * cache is disabled for that family or entirely).<a name="line.816"></a> -<span class="sourceLineNo">817</span> *<a name="line.817"></a> -<span class="sourceLineNo">818</span> * @param cacheBlocks if false, default settings are overridden and blocks<a name="line.818"></a> -<span class="sourceLineNo">819</span> * will not be cached<a name="line.819"></a> -<span class="sourceLineNo">820</span> */<a name="line.820"></a> -<span class="sourceLineNo">821</span> public Scan setCacheBlocks(boolean cacheBlocks) {<a name="line.821"></a> -<span class="sourceLineNo">822</span> this.cacheBlocks = cacheBlocks;<a name="line.822"></a> -<span class="sourceLineNo">823</span> return this;<a name="line.823"></a> -<span class="sourceLineNo">824</span> }<a name="line.824"></a> -<span class="sourceLineNo">825</span><a name="line.825"></a> -<span class="sourceLineNo">826</span> /**<a name="line.826"></a> -<span class="sourceLineNo">827</span> * Get whether blocks should be cached for this Scan.<a name="line.827"></a> -<span class="sourceLineNo">828</span> * @return true if default caching should be used, false if blocks should not<a name="line.828"></a> -<span class="sourceLineNo">829</span> * be cached<a name="line.829"></a> -<span class="sourceLineNo">830</span> */<a name="line.830"></a> -<span class="sourceLineNo">831</span> public boolean getCacheBlocks() {<a name="line.831"></a> -<span class="sourceLineNo">832</span> return cacheBlocks;<a name="line.832"></a> -<span class="sourceLineNo">833</span> }<a name="line.833"></a> -<span class="sourceLineNo">834</span><a name="line.834"></a> -<span class="sourceLineNo">835</span> /**<a name="line.835"></a> -<span class="sourceLineNo">836</span> * Set whether this scan is a reversed one<a name="line.836"></a> -<span class="sourceLineNo">837</span> * <p><a name="line.837"></a> -<span class="sourceLineNo">838</span> * This is false by default which means forward(normal) scan.<a name="line.838"></a> -<span class="sourceLineNo">839</span> *<a name="line.839"></a> -<span class="sourceLineNo">840</span> * @param reversed if true, scan will be backward order<a name="line.840"></a> -<span class="sourceLineNo">841</span> * @return this<a name="line.841"></a> -<span class="sourceLineNo">842</span> */<a name="line.842"></a> -<span class="sourceLineNo">843</span> public Scan setReversed(boolean reversed) {<a name="line.843"></a> -<span class="sourceLineNo">844</span> this.reversed = reversed;<a name="line.844"></a> -<span class="sourceLineNo">845</span> return this;<a name="line.845"></a> -<span class="sourceLineNo">846</span> }<a name="line.846"></a> -<span class="sourceLineNo">847</span><a name="line.847"></a> -<span class="sourceLineNo">848</span> /**<a name="line.848"></a> -<span class="sourceLineNo">849</span> * Get whether this scan is a reversed one.<a name="line.849"></a> -<span class="sourceLineNo">850</span> * @return true if backward scan, false if forward(default) scan<a name="line.850"></a> -<span class="sourceLineNo">851</span> */<a name="line.851"></a> -<span class="sourceLineNo">852</span> public boolean isReversed() {<a name="line.852"></a> -<span class="sourceLineNo">853</span> return reversed;<a name="line.853"></a> -<span class="sourceLineNo">854</span> }<a name="line.854"></a> -<span class="sourceLineNo">855</span><a name="line.855"></a> -<span class="sourceLineNo">856</span> /**<a name="line.856"></a> -<span class="sourceLineNo">857</span> * Setting whether the caller wants to see the partial results when server returns<a name="line.857"></a> -<span class="sourceLineNo">858</span> * less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client.<a name="line.858"></a> -<span class="sourceLineNo">859</span> * By default this value is false and the complete results will be assembled client side<a name="line.859"></a> -<span class="sourceLineNo">860</span> * before being delivered to the caller.<a name="line.860"></a> -<span class="sourceLineNo">861</span> * @param allowPartialResults<a name="line.861"></a> -<span class="sourceLineNo">862</span> * @return this<a name="line.862"></a> -<span class="sourceLineNo">863</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.863"></a> -<span class="sourceLineNo">864</span> * @see #setBatch(int)<a name="line.864"></a> +<span class="sourceLineNo">799</span> public int getMaxResultsPerColumnFamily() {<a name="line.799"></a> +<span class="sourceLineNo">800</span> return this.storeLimit;<a name="line.800"></a> +<span class="sourceLineNo">801</span> }<a name="line.801"></a> +<span class="sourceLineNo">802</span><a name="line.802"></a> +<span class="sourceLineNo">803</span> /**<a name="line.803"></a> +<span class="sourceLineNo">804</span> * Method for retrieving the scan's offset per row per column<a name="line.804"></a> +<span class="sourceLineNo">805</span> * family (#kvs to be skipped)<a name="line.805"></a> +<span class="sourceLineNo">806</span> * @return row offset<a name="line.806"></a> +<span class="sourceLineNo">807</span> */<a name="line.807"></a> +<span class="sourceLineNo">808</span> public int getRowOffsetPerColumnFamily() {<a name="line.808"></a> +<span class="sourceLineNo">809</span> return this.storeOffset;<a name="line.809"></a> +<span class="sourceLineNo">810</span> }<a name="line.810"></a> +<span class="sourceLineNo">811</span><a name="line.811"></a> +<span class="sourceLineNo">812</span> /**<a name="line.812"></a> +<span class="sourceLineNo">813</span> * @return caching the number of rows fetched when calling next on a scanner<a name="line.813"></a> +<span class="sourceLineNo">814</span> */<a name="line.814"></a> +<span class="sourceLineNo">815</span> public int getCaching() {<a name="line.815"></a> +<span class="sourceLineNo">816</span> return this.caching;<a name="line.816"></a> +<span class="sourceLineNo">817</span> }<a name="line.817"></a> +<span class="sourceLineNo">818</span><a name="line.818"></a> +<span class="sourceLineNo">819</span> /**<a name="line.819"></a> +<span class="sourceLineNo">820</span> * @return RowFilter<a name="line.820"></a> +<span class="sourceLineNo">821</span> */<a name="line.821"></a> +<span class="sourceLineNo">822</span> @Override<a name="line.822"></a> +<span class="sourceLineNo">823</span> public Filter getFilter() {<a name="line.823"></a> +<span class="sourceLineNo">824</span> return filter;<a name="line.824"></a> +<span class="sourceLineNo">825</span> }<a name="line.825"></a> +<span class="sourceLineNo">826</span><a name="line.826"></a> +<span class="sourceLineNo">827</span> /**<a name="line.827"></a> +<span class="sourceLineNo">828</span> * @return true is a filter has been specified, false if not<a name="line.828"></a> +<span class="sourceLineNo">829</span> */<a name="line.829"></a> +<span class="sourceLineNo">830</span> public boolean hasFilter() {<a name="line.830"></a> +<span class="sourceLineNo">831</span> return filter != null;<a name="line.831"></a> +<span class="sourceLineNo">832</span> }<a name="line.832"></a> +<span class="sourceLineNo">833</span><a name="line.833"></a> +<span class="sourceLineNo">834</span> /**<a name="line.834"></a> +<span class="sourceLineNo">835</span> * Set whether blocks should be cached for this Scan.<a name="line.835"></a> +<span class="sourceLineNo">836</span> * <p><a name="line.836"></a> +<span class="sourceLineNo">837</span> * This is true by default. When true, default settings of the table and<a name="line.837"></a> +<span class="sourceLineNo">838</span> * family are used (this will never override caching blocks if the block<a name="line.838"></a> +<span class="sourceLineNo">839</span> * cache is disabled for that family or entirely).<a name="line.839"></a> +<span class="sourceLineNo">840</span> *<a name="line.840"></a> +<span class="sourceLineNo">841</span> * @param cacheBlocks if false, default settings are overridden and blocks<a name="line.841"></a> +<span class="sourceLineNo">842</span> * will not be cached<a name="line.842"></a> +<span class="sourceLineNo">843</span> */<a name="line.843"></a> +<span class="sourceLineNo">844</span> public Scan setCacheBlocks(boolean cacheBlocks) {<a name="line.844"></a> +<span class="sourceLineNo">845</span> this.cacheBlocks = cacheBlocks;<a name="line.845"></a> +<span class="sourceLineNo">846</span> return this;<a name="line.846"></a> +<span class="sourceLineNo">847</span> }<a name="line.847"></a> +<span class="sourceLineNo">848</span><a name="line.848"></a> +<span class="sourceLineNo">849</span> /**<a name="line.849"></a> +<span class="sourceLineNo">850</span> * Get whether blocks should be cached for this Scan.<a name="line.850"></a> +<span class="sourceLineNo">851</span> * @return true if default caching should be used, false if blocks should not<a name="line.851"></a> +<span class="sourceLineNo">852</span> * be cached<a name="line.852"></a> +<span class="sourceLineNo">853</span> */<a name="line.853"></a> +<span class="sourceLineNo">854</span> public boolean getCacheBlocks() {<a name="line.854"></a> +<span class="sourceLineNo">855</span> return cacheBlocks;<a name="line.855"></a> +<span class="sourceLineNo">856</span> }<a name="line.856"></a> +<span class="sourceLineNo">857</span><a name="line.857"></a> +<span class="sourceLineNo">858</span> /**<a name="line.858"></a> +<span class="sourceLineNo">859</span> * Set whether this scan is a reversed one<a name="line.859"></a> +<span class="sourceLineNo">860</span> * <p><a name="line.860"></a> +<span class="sourceLineNo">861</span> * This is false by default which means forward(normal) scan.<a name="line.861"></a> +<span class="sourceLineNo">862</span> *<a name="line.862"></a> +<span class="sourceLineNo">863</span> * @param reversed if true, scan will be backward order<a name="line.863"></a> +<span class="sourceLineNo">864</span> * @return this<a name="line.864"></a> <span class="sourceLineNo">865</span> */<a name="line.865"></a> -<span class="sourceLineNo">866</span> public Scan setAllowPartialResults(final boolean allowPartialResults) {<a name="line.866"></a> -<span class="sourceLineNo">867</span> this.allowPartialResults = allowPartialResults;<a name="line.867"></a> +<span class="sourceLineNo">866</span> public Scan setReversed(boolean reversed) {<a name="line.866"></a> +<span class="sourceLineNo">867</span> this.reversed = reversed;<a name="line.867"></a> <span class="sourceLineNo">868</span> return this;<a name="line.868"></a> <span class="sourceLineNo">869</span> }<a name="line.869"></a> <span class="sourceLineNo">870</span><a name="line.870"></a> <span class="sourceLineNo">871</span> /**<a name="line.871"></a> -<span class="sourceLineNo">872</span> * @return true when the constructor of this scan understands that the results they will see may<a name="line.872"></a> -<span class="sourceLineNo">873</span> * only represent a partial portion of a row. The entire row would be retrieved by<a name="line.873"></a> -<span class="sourceLineNo">874</span> * subsequent calls to {@link ResultScanner#next()}<a name="line.874"></a> -<span class="sourceLineNo">875</span> */<a name="line.875"></a> -<span class="sourceLineNo">876</span> public boolean getAllowPartialResults() {<a name="line.876"></a> -<span class="sourceLineNo">877</span> return allowPartialResults;<a name="line.877"></a> -<span class="sourceLineNo">878</span> }<a name="line.878"></a> -<span class="sourceLineNo">879</span><a name="line.879"></a> -<span class="sourceLineNo">880</span> public Scan setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.880"></a> -<span class="sourceLineNo">881</span> return (Scan) super.setLoadColumnFamiliesOnDemand(value);<a name="line.881"></a> -<span class="sourceLineNo">882</span> }<a name="line.882"></a> -<span class="sourceLineNo">883</span><a name="line.883"></a> -<span class="sourceLineNo">884</span> /**<a name="line.884"></a> -<span class="sourceLineNo">885</span> * Compile the table and column family (i.e. schema) information<a name="line.885"></a> -<span class="sourceLineNo">886</span> * into a String. Useful for parsing and aggregation by debugging,<a name="line.886"></a> -<span class="sourceLineNo">887</span> * logging, and administration tools.<a name="line.887"></a> -<span class="sourceLineNo">888</span> * @return Map<a name="line.888"></a> -<span class="sourceLineNo">889</span> */<a name="line.889"></a> -<span class="sourceLineNo">890</span> @Override<a name="line.890"></a> -<span class="sourceLineNo">891</span> public Map<String, Object> getFingerprint() {<a name="line.891"></a> -<span class="sourceLineNo">892</span> Map<String, Object> map = new HashMap<>();<a name="line.892"></a> -<span class="sourceLineNo">893</span> List<String> families = new ArrayList<>();<a name="line.893"></a> -<span class="sourceLineNo">894</span> if(this.familyMap.isEmpty()) {<a name="line.894"></a> -<span class="sourceLineNo">895</span> map.put("families", "ALL");<a name="line.895"></a> -<span class="sourceLineNo">896</span> return map;<a name="line.896"></a> -<span class="sourceLineNo">897</span> } else {<a name="line.897"></a> -<span class="sourceLineNo">898</span> map.put("families", families);<a name="line.898"></a> -<span class="sourceLineNo">899</span> }<a name="line.899"></a> -<span class="sourceLineNo">900</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.900"></a> -<span class="sourceLineNo">901</span> this.familyMap.entrySet()) {<a name="line.901"></a> -<span class="sourceLineNo">902</span> families.add(Bytes.toStringBinary(entry.getKey()));<a name="line.902"></a> -<span class="sourceLineNo">903</span> }<a name="line.903"></a> -<span class="sourceLineNo">904</span> return map;<a name="line.904"></a> +<span class="sourceLineNo">872</span> * Get whether this scan is a reversed one.<a name="line.872"></a> +<span class="sourceLineNo">873</span> * @return true if backward scan, false if forward(default) scan<a name="line.873"></a> +<span class="sourceLineNo">874</span> */<a name="line.874"></a> +<span class="sourceLineNo">875</span> public boolean isReversed() {<a name="line.875"></a> +<span class="sourceLineNo">876</span> return reversed;<a name="line.876"></a> +<span class="sourceLineNo">877</span> }<a name="line.877"></a> +<span class="sourceLineNo">878</span><a name="line.878"></a> +<span class="sourceLineNo">879</span> /**<a name="line.879"></a> +<span class="sourceLineNo">880</span> * Setting whether the caller wants to see the partial results when server returns<a name="line.880"></a> +<span class="sourceLineNo">881</span> * less-than-expected cells. It is helpful while scanning a huge row to prevent OOM at client.<a name="line.881"></a> +<span class="sourceLineNo">882</span> * By default this value is false and the complete results will be assembled client side<a name="line.882"></a> +<span class="sourceLineNo">883</span> * before being delivered to the caller.<a name="line.883"></a> +<span class="sourceLineNo">884</span> * @param allowPartialResults<a name="line.884"></a> +<span class="sourceLineNo">885</span> * @return this<a name="line.885"></a> +<span class="sourceLineNo">886</span> * @see Result#mayHaveMoreCellsInRow()<a name="line.886"></a> +<span class="sourceLineNo">887</span> * @see #setBatch(int)<a name="line.887"></a> +<span class="sourceLineNo">888</span> */<a name="line.888"></a> +<span class="sourceLineNo">889</span> public Scan setAllowPartialResults(final boolean allowPartialResults) {<a name="line.889"></a> +<span class="sourceLineNo">890</span> this.allowPartialResults = allowPartialResults;<a name="line.890"></a> +<span class="sourceLineNo">891</span> return this;<a name="line.891"></a> +<span class="sourceLineNo">892</span> }<a name="line.892"></a> +<span class="sourceLineNo">893</span><a name="line.893"></a> +<span class="sourceLineNo">894</span> /**<a name="line.894"></a> +<span class="sourceLineNo">895</span> * @return true when the constructor of this scan understands that the results they will see may<a name="line.895"></a> +<span class="sourceLineNo">896</span> * only represent a partial portion of a row. The entire row would be retrieved by<a name="line.896"></a> +<span class="sourceLineNo">897</span> * subsequent calls to {@link ResultScanner#next()}<a name="line.897"></a> +<span class="sourceLineNo">898</span> */<a name="line.898"></a> +<span class="sourceLineNo">899</span> public boolean getAllowPartialResults() {<a name="line.899"></a> +<span class="sourceLineNo">900</span> return allowPartialResults;<a name="line.900"></a> +<span class="sourceLineNo">901</span> }<a name="line.901"></a> +<span class="sourceLineNo">902</span><a name="line.902"></a> +<span class="sourceLineNo">903</span> public Scan setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.903"></a> +<span class="sourceLineNo">904</span> return (Scan) super.setLoadColumnFamiliesOnDemand(value);<a name="line.904"></a> <span class="sourceLineNo">905</span> }<a name="line.905"></a> <span class="sourceLineNo">906</span><a name="line.906"></a> <span class="sourceLineNo">907</span> /**<a name="line.907"></a> -<span class="sourceLineNo">908</span> * Compile the details beyond the scope of getFingerprint (row, columns,<a name="line.908"></a> -<span class="sourceLineNo">909</span> * timestamps, etc.) into a Map along with the fingerprinted information.<a name="line.909"></a> -<span class="sourceLineNo">910</span> * Useful for debugging, logging, and administration tools.<a name="line.910"></a> -<span class="sourceLineNo">911</span> * @param maxCols a limit on the number of columns output prior to truncation<a name="line.911"></a> -<span class="sourceLineNo">912</span> * @return Map<a name="line.912"></a> -<span class="sourceLineNo">913</span> */<a name="line.913"></a> -<span class="sourceLineNo">914</span> @Override<a name="line.914"></a> -<span class="sourceLineNo">915</span> public Map<String, Object> toMap(int maxCols) {<a name="line.915"></a> -<span class="sourceLineNo">916</span> // start with the fingerpring map and build on top of it<a name="line.916"></a> -<span class="sourceLineNo">917</span> Map<String, Object> map = getFingerprint();<a name="line.917"></a> -<span class="sourceLineNo">918</span> // map from families to column list replaces fingerprint's list of families<a name="line.918"></a> -<span class="sourceLineNo">919</span> Map<String, List<String>> familyColumns = new HashMap<>();<a name="line.919"></a> -<span class="sourceLineNo">920</span> map.put("families", familyColumns);<a name="line.920"></a> -<span class="sourceLineNo">921</span> // add scalar information first<a name="line.921"></a> -<span class="sourceLineNo">922</span> map.put("startRow", Bytes.toStringBinary(this.startRow));<a name="line.922"></a> -<span class="sourceLineNo">923</span> map.put("stopRow", Bytes.toStringBinary(this.stopRow));<a name="line.923"></a> -<span class="sourceLineNo">924</span> map.put("maxVersions", this.maxVersions);<a name="line.924"></a> -<span class="sourceLineNo">925</span> map.put("batch", this.batch);<a name="line.925"></a> -<span class="sourceLineNo">926</span> map.put("caching", this.caching);<a name="line.926"></a> -<span class="sourceLineNo">927</span> map.put("maxResultSize", this.maxResultSize);<a name="line.927"></a> -<span class="sourceLineNo">928</span> map.put("cacheBlocks", this.cacheBlocks);<a name="line.928"></a> -<span class="sourceLineNo">929</span> map.put("loadColumnFamiliesOnDemand", this.loadColumnFamiliesOnDemand);<a name="line.929"></a> -<span class="sourceLineNo">930</span> List<Long> timeRange = new ArrayList<>(2);<a name="line.930"></a> -<span class="sourceLineNo">931</span> timeRange.add(this.tr.getMin());<a name="line.931"></a> -<span class="sourceLineNo">932</span> timeRange.add(this.tr.getMax());<a name="line.932"></a> -<span class="sourceLineNo">933</span> map.put("timeRange", timeRange);<a name="line.933"></a> -<span class="sourceLineNo">934</span> int colCount = 0;<a name="line.934"></a> -<span class="sourceLineNo">935</span> // iterate through affected families and list out up to maxCols columns<a name="line.935"></a> -<span class="sourceLineNo">936</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.936"></a> -<span class="sourceLineNo">937</span> this.familyMap.entrySet()) {<a name="line.937"></a> -<span class="sourceLineNo">938</span> List<String> columns = new ArrayList<>();<a name="line.938"></a> -<span class="sourceLineNo">939</span> familyColumns.put(Bytes.toStringBinary(entry.getKey()), columns);<a name="line.939"></a> -<span class="sourceLineNo">940</span> if(entry.getValue() == null) {<a name="line.940"></a> -<span class="sourceLineNo">941</span> colCount++;<a name="line.941"></a> -<span class="sourceLineNo">942</span> --maxCols;<a name="line.942"></a> -<span class="sourceLineNo">943</span> columns.add("ALL");<a name="line.943"></a> -<span class="sourceLineNo">944</span> } else {<a name="line.944"></a> -<span class="sourceLineNo">945</span> colCount += entry.getValue().size();<a name="line.945"></a> -<span class="sourceLineNo">946</span> if (maxCols <= 0) {<a name="line.946"></a> -<span class="sourceLineNo">947</span> continue;<a name="line.947"></a> -<span class="sourceLineNo">948</span> }<a name="line.948"></a> -<span class="sourceLineNo">949</span> for (byte [] column : entry.getValue()) {<a name="line.949"></a> -<span class="sourceLineNo">950</span> if (--maxCols <= 0) {<a name="line.950"></a> -<span class="sourceLineNo">951</span> continue;<a name="line.951"></a> -<span class="sourceLineNo">952</span> }<a name="line.952"></a> -<span class="sourceLineNo">953</span> columns.add(Bytes.toStringBinary(column));<a name="line.953"></a> -<span class="sourceLineNo">954</span> }<a name="line.954"></a> -<span class="sourceLineNo">955</span> }<a name="line.955"></a> -<span class="sourceLineNo">956</span> }<a name="line.956"></a> -<span class="sourceLineNo">957</span> map.put("totalColumns", colCount);<a name="line.957"></a> -<span class="sourceLineNo">958</span> if (this.filter != null) {<a name="line.958"></a> -<span class="sourceLineNo">959</span> map.put("filter", this.filter.toString());<a name="line.959"></a> -<span class="sourceLineNo">960</span> }<a name="line.960"></a> -<span class="sourceLineNo">961</span> // add the id if set<a name="line.961"></a> -<span class="sourceLineNo">962</span> if (getId() != null) {<a name="line.962"></a> -<span class="sourceLineNo">963</span> map.put("id", getId());<a name="line.963"></a> -<span class="sourceLineNo">964</span> }<a name="line.964"></a> -<span class="sourceLineNo">965</span> return map;<a name="line.965"></a> -<span class="sourceLineNo">966</span> }<a name="line.966"></a> -<span class="sourceLineNo">967</span><a name="line.967"></a> -<span class="sourceLineNo">968</span> /**<a name="line.968"></a> -<span class="sourceLineNo">969</span> * Enable/disable "raw" mode for this scan.<a name="line.969"></a> -<span class="sourceLineNo">970</span> * If "raw" is enabled the scan will return all<a name="line.970"></a> -<span class="sourceLineNo">971</span> * delete marker and deleted rows that have not<a name="line.971"></a> -<span class="sourceLineNo">972</span> * been collected, yet.<a name="line.972"></a> -<span class="sourceLineNo">973</span> * This is mostly useful for Scan on column families<a name="line.973"></a> -<span class="sourceLineNo">974</span> * that have KEEP_DELETED_ROWS enabled.<a name="line.974"></a> -<span class="sourceLineNo">975</span> * It is an error to specify any column when "raw" is set.<a name="line.975"></a> -<span class="sourceLineNo">976</span> * @param raw True/False to enable/disable "raw" mode.<a name="line.976"></a> -<span class="sourceLineNo">977</span> */<a name="line.977"></a> -<span class="sourceLineNo">978</span> public Scan setRaw(boolean raw) {<a name="line.978"></a> -<span class="sourceLineNo">979</span> setAttribute(RAW_ATTR, Bytes.toBytes(raw));<a name="line.979"></a> -<span class="sourceLineNo">980</span> return this;<a name="line.980"></a> -<span class="sourceLineNo">981</span> }<a name="line.981"></a> -<span class="sourceLineNo">982</span><a name="line.982"></a> -<span class="sourceLineNo">983</span> /**<a name="line.983"></a> -<span class="sourceLineNo">984</span> * @return True if this Scan is in "raw" mode.<a name="line.984"></a> -<span class="sourceLineNo">985</span> */<a name="line.985"></a> -<span class="sourceLineNo">986</span> public boolean isRaw() {<a name="line.986"></a> -<span class="sourceLineNo">987</span> byte[] attr = getAttribute(RAW_ATTR);<a name="line.987"></a> -<span class="sourceLineNo">988</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.988"></a> +<span class="sourceLineNo">908</span> * Compile the table and column family (i.e. schema) information<a name="line.908"></a> +<span class="sourceLineNo">909</span> * into a String. Useful for parsing and aggregation by debugging,<a name="line.909"></a> +<span class="sourceLineNo">910</span> * logging, and administration tools.<a name="line.910"></a> +<span class="sourceLineNo">911</span> * @return Map<a name="line.911"></a> +<span class="sourceLineNo">912</span> */<a name="line.912"></a> +<span class="sourceLineNo">913</span> @Override<a name="line.913"></a> +<span class="sourceLineNo">914</span> public Map<String, Object> getFingerprint() {<a name="line.914"></a> +<span class="sourceLineNo">915</span> Map<String, Object> map = new HashMap<>();<a name="line.915"></a> +<span class="sourceLineNo">916</span> List<String> families = new ArrayList<>();<a name="line.916"></a> +<span class="sourceLineNo">917</span> if(this.familyMap.isEmpty()) {<a name="line.917"></a> +<span class="sourceLineNo">918</span> map.put("families", "ALL");<a name="line.918"></a> +<span class="sourceLineNo">919</span> return map;<a name="line.919"></a> +<span class="sourceLineNo">920</span> } else {<a name="line.920"></a> +<span class="sourceLineNo">921</span> map.put("families", families);<a name="line.921"></a> +<span class="sourceLineNo">922</span> }<a name="line.922"></a> +<span class="sourceLineNo">923</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.923"></a> +<span class="sourceLineNo">924</span> this.familyMap.entrySet()) {<a name="line.924"></a> +<span class="sourceLineNo">925</span> families.add(Bytes.toStringBinary(entry.getKey()));<a name="line.925"></a> +<span class="sourceLineNo">926</span> }<a name="line.926"></a> +<span class="sourceLineNo">927</span> return map;<a name="line.927"></a> +<span class="sourceLineNo">928</span> }<a name="line.928"></a> +<span class="sourceLineNo">929</span><a name="line.929"></a> +<span class="sourceLineNo">930</span> /**<a name="line.930"></a> +<span class="sourceLineNo">931</span> * Compile the details beyond the scope of getFingerprint (row, columns,<a name="line.931"></a> +<span class="sourceLineNo">932</span> * timestamps, etc.) into a Map along with the fingerprinted information.<a name="line.932"></a> +<span class="sourceLineNo">933</span> * Useful for debugging, logging, and administration tools.<a name="line.933"></a> +<span class="sourceLineNo">934</span> * @param maxCols a limit on the number of columns output prior to truncation<a name="line.934"></a> +<span class="sourceLineNo">935</span> * @return Map<a name="line.935"></a> +<span class="sourceLineNo">936</span> */<a name="line.936"></a> +<span class="sourceLineNo">937</span> @Override<a name="line.937"></a> +<span class="sourceLineNo">938</span> public Map<String, Object> toMap(int maxCols) {<a name="line.938"></a> +<span class="sourceLineNo">939</span> // start with the fingerpring map and build on top of it<a name="line.939"></a> +<span class="sourceLineNo">940</span> Map<String, Object> map = getFingerprint();<a name="line.940"></a> +<span class="sourceLineNo">941</span> // map from families to column list replaces fingerprint's list of families<a name="line.941"></a> +<span class="sourceLineNo">942</span> Map<String, List<String>> familyColumns = new HashMap<>();<a name="line.942"></a> +<span class="sourceLineNo">943</span> map.put("families", familyColumns);<a name="line.943"></a> +<span class="sourceLineNo">944</span> // add scalar information first<a name="line.944"></a> +<span class="sourceLineNo">945</span> map.put("startRow", Bytes.toStringBinary(this.startRow));<a name="line.945"></a> +<span class="sourceLineNo">946</span> map.put("stopRow", Bytes.toStringBinary(this.stopRow));<a name="line.946"></a> +<span class="sourceLineNo">947</span> map.put("maxVersions", this.maxVersions);<a name="line.947"></a> +<span class="sourceLineNo">948</span> map.put("batch", this.batch);<a name="line.948"></a> +<span class="sourceLineNo">949</span> map.put("caching", this.caching);<a name="line.949"></a> +<span class="sourceLineNo">950</span> map.put("maxResultSize", this.maxResultSize);<a name="line.950"></a> +<span class="sourceLineNo">951</span> map.put("cacheBlocks", this.cacheBlocks);<a name="line.951"></a> +<span class="sourceLineNo">952</span> map.put("loadColumnFamiliesOnDemand", this.loadColumnFamiliesOnDemand);<a name="line.952"></a> +<span class="sourceLineNo">953</span> List<Long> timeRange = new ArrayList<>(2);<a name="line.953"></a> +<span class="sourceLineNo">954</span> timeRange.add(this.tr.getMin());<a name="line.954"></a> +<span class="sourceLineNo">955</span> timeRange.add(this.tr.getMax());<a name="line.955"></a> +<span class="sourceLineNo">956</span> map.put("timeRange", timeRange);<a name="line.956"></a> +<span class="sourceLineNo">957</span> int colCount = 0;<a name="line.957"></a> +<span class="sourceLineNo">958</span> // iterate through affected families and list out up to maxCols columns<a name="line.958"></a> +<span class="sourceLineNo">959</span> for (Map.Entry<byte [], NavigableSet<byte[]>> entry :<a name="line.959"></a> +<span class="sourceLineNo">960</span> this.familyMap.entrySet()) {<a name="line.960"></a> +<span class="sourceLineNo">961</span> List<String> columns = new ArrayList<>();<a name="line.961"></a> +<span class="sourceLineNo">962</span> familyColumns.put(Bytes.toStringBinary(entry.getKey()), columns);<a name="line.962"></a> +<span class="sourceLineNo">963</span> if(entry.getValue() == null) {<a name="line.963"></a> +<span class="sourceLineNo">964</span> colCount++;<a name="line.964"></a> +<span class="sourceLineNo">965</span> --maxCols;<a name="line.965"></a> +<span class="sourceLineNo">966</span> columns.add("ALL");<a name="line.966"></a> +<span class="sourceLineNo">967</span> } else {<a name="line.967"></a> +<span class="sourceLineNo">968</span> colCount += entry.getValue().size();<a name="line.968"></a> +<span class="sourceLineNo">969</span> if (maxCols <= 0) {<a name="line.969"></a> +<span class="sourceLineNo">970</span> continue;<a name="line.970"></a> +<span class="sourceLineNo">971</span> }<a name="line.971"></a> +<span class="sourceLineNo">972</span> for (byte [] column : entry.getValue()) {<a name="line.972"></a> +<span class="sourceLineNo">973</span> if (--maxCols <= 0) {<a name="line.973"></a> +<span class="sourceLineNo">974</span> continue;<a name="line.974"></a> +<span class="sourceLineNo">975</span> }<a name="line.975"></a> +<span class="sourceLineNo">976</span> columns.add(Bytes.toStringBinary(column));<a name="line.976"></a> +<span class="sourceLineNo">977</span> }<a name="line.977"></a> +<span class="sourceLineNo">978</span> }<a name="line.978"></a> +<span class="sourceLineNo">979</span> }<a name="line.979"></a> +<span class="sourceLineNo">980</span> map.put("totalColumns", colCount);<a name="line.980"></a> +<span class="sourceLineNo">981</span> if (this.filter != null) {<a name="line.981"></a> +<span class="sourceLineNo">982</span> map.put("filter", this.filter.toString());<a name="line.982"></a> +<span class="sourceLineNo">983</span> }<a name="line.983"></a> +<span class="sourceLineNo">984</span> // add the id if set<a name="line.984"></a> +<span class="sourceLineNo">985</span> if (getId() != null) {<a name="line.985"></a> +<span class="sourceLineNo">986</span> map.put("id", getId());<a name="line.986"></a> +<span class="sourceLineNo">987</span> }<a name="line.987"></a> +<span class="sourceLineNo">988</span> return map;<a name="line.988"></a> <span class="sourceLineNo">989</span> }<a name="line.989"></a> <span class="sourceLineNo">990</span><a name="line.990"></a> <span class="sourceLineNo">991</span> /**<a name="line.991"></a> -<span class="sourceLineNo">992</span> * Set whether this scan is a small scan<a name="line.992"></a> -<span class="sourceLineNo">993</span> * <p><a name="line.993"></a> -<span class="sourceLineNo">994</span> * Small scan should use pread and big scan can use seek + read seek + read is fast but can cause<a name="line.994"></a> -<span class="sourceLineNo">995</span> * two problem (1) resource contention (2) cause too much network io [89-fb] Using pread for<a name="line.995"></a> -<span class="sourceLineNo">996</span> * non-compaction read request https://issues.apache.org/jira/browse/HBASE-7266 On the other hand,<a name="line.996"></a> -<span class="sourceLineNo">997</span> * if setting it true, we would do openScanner,next,closeScanner in one RPC call. It means the<a name="line.997"></a> -<span class="sourceLineNo">998</span> * better performance for small scan. [HBASE-9488]. Generally, if the scan range is within one<a name="line.998"></a> -<span class="sourceLineNo">999</span> * data block(64KB), it could be considered as a small scan.<a name="line.999"></a> -<span class="sourceLineNo">1000</span> * @param small<a name="line.1000"></a> -<span class="sourceLineNo">1001</span> * @deprecated since 2.0.0. Use {@link #setLimit(int)} and {@link #setReadType(ReadType)} instead.<a name="line.1001"></a> -<span class="sourceLineNo">1002</span> * And for the one rpc optimization, now we will also fetch data when openScanner, and<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> * if the number of rows reaches the limit then we will close the scanner<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> * automatically which means we will fall back to one rpc.<a name="line.1004"></a> -<span class="sourceLineNo">1005</span> * @see #setLimit(int)<a name="line.1005"></a> -<span class="sourceLineNo">1006</span> * @see #setReadType(ReadType)<a name="line.1006"></a> -<span class="sourceLineNo">1007</span> */<a name="line.1007"></a> -<span class="sourceLineNo">1008</span> @Deprecated<a name="line.1008"></a> -<span class="sourceLineNo">1009</span> public Scan setSmall(boolean small) {<a name="line.1009"></a> -<span class="sourceLineNo">1010</span> this.small = small;<a name="line.1010"></a> -<span class="sourceLineNo">1011</span> this.readType = ReadType.PREAD;<a name="line.1011"></a> -<span class="sourceLineNo">1012</span> return this;<a name="line.1012"></a> -<span class="sourceLineNo">1013</span> }<a name="line.1013"></a> -<span class="sourceLineNo">1014</span><a name="line.1014"></a> -<span class="sourceLineNo">1015</span> /**<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> * Get whether this scan is a small scan<a name="line.1016"></a> -<span class="sourceLineNo">1017</span> * @return true if small scan<a name="line.1017"></a> -<span class="sourceLineNo">1018</span> * @deprecated since 2.0.0. See the comment of {@link #setSmall(boolean)}<a name="line.1018"></a> -<span class="sourceLineNo">1019</span> */<a name="line.1019"></a> -<span class="sourceLineNo">1020</span> @Deprecated<a name="line.1020"></a> -<span class="sourceLineNo">1021</span> public boolean isSmall() {<a name="line.1021"></a> -<span class="sourceLineNo">1022</span> return small;<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> }<a name="line.1023"></a> -<span class="sourceLineNo">1024</span><a name="line.1024"></a> -<span class="sourceLineNo">1025</span> @Override<a name="line.1025"></a> -<span class="sourceLineNo">1026</span> public Scan setAttribute(String name, byte[] value) {<a name="line.1026"></a> -<span class="sourceLineNo">1027</span> return (Scan) super.setAttribute(name, value);<a name="line.1027"></a> -<span class="sourceLineNo">1028</span> }<a name="line.1028"></a> -<span class="sourceLineNo">1029</span><a name="line.1029"></a> -<span class="sourceLineNo">1030</span> @Override<a name="line.1030"></a> -<span class="sourceLineNo">1031</span> public Scan setId(String id) {<a name="line.1031"></a> -<span class="sourceLineNo">1032</span> return (Scan) super.setId(id);<a name="line.1032"></a> -<span class="sourceLineNo">1033</span> }<a name="line.1033"></a> -<span class="sourceLineNo">1034</span><a name="line.1034"></a> -<span class="sourceLineNo">1035</span> @Override<a name="line.1035"></a> -<span class="sourceLineNo">1036</span> public Scan setAuthorizations(Authorizations authorizations) {<a name="line.1036"></a> -<span class="sourceLineNo">1037</span> return (Scan) super.setAuthorizations(authorizations);<a name="line.1037"></a> -<span class="sourceLineNo">1038</span> }<a name="line.1038"></a> -<span class="sourceLineNo">1039</span><a name="line.1039"></a> -<span class="sourceLineNo">1040</span> @Override<a name="line.1040"></a> -<span class="sourceLineNo">1041</span> public Scan setACL(Map<String, Permission> perms) {<a name="line.1041"></a> -<span class="sourceLineNo">1042</span> return (Scan) super.setACL(perms);<a name="line.1042"></a> -<span class="sourceLineNo">1043</span> }<a name="line.1043"></a> -<span class="sourceLineNo">1044</span><a name="line.1044"></a> -<span class="sourceLineNo">1045</span> @Override<a name="line.1045"></a> -<span class="sourceLineNo">1046</span> public Scan setACL(String user, Permission perms) {<a name="line.1046"></a> -<span class="sourceLineNo">1047</span> return (Scan) super.setACL(user, perms);<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> }<a name="line.1048"></a> -<span class="sourceLineNo">1049</span><a name="line.1049"></a> -<span class="sourceLineNo">1050</span> @Override<a name="line.1050"></a> -<span class="sourceLineNo">1051</span> public Scan setConsistency(Consistency consistency) {<a name="line.1051"></a> -<span class="sourceLineNo">1052</span> return (Scan) super.setConsistency(consistency);<a name="line.1052"></a> -<span class="sourceLineNo">1053</span> }<a name="line.1053"></a> -<span class="sourceLineNo">1054</span><a name="line.1054"></a> -<span class="sourceLineNo">1055</span> @Override<a name="line.1055"></a> -<span class="sourceLineNo">1056</span> public Scan setReplicaId(int Id) {<a name="line.1056"></a> -<span class="sourceLineNo">1057</span> return (Scan) super.setReplicaId(Id);<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> }<a name="line.1058"></a> -<span class="sourceLineNo">1059</span><a name="line.1059"></a> -<span class="sourceLineNo">1060</span> @Override<a name="line.1060"></a> -<span class="sourceLineNo">1061</span> public Scan setIsolationLevel(IsolationLevel level) {<a name="line.1061"></a> -<span class="sourceLineNo">1062</span> return (Scan) super.setIsolationLevel(level);<a name="line.1062"></a> -<span class="sourceLineNo">1063</span> }<a name="line.1063"></a> -<span class="sourceLineNo">1064</span><a name="line.1064"></a> -<span class="sourceLineNo">1065</span> @Override<a name="line.1065"></a> -<span class="sourceLineNo">1066</span> public Scan setPriority(int priority) {<a name="line.1066"></a> -<span class="sourceLineNo">1067</span> return (Scan) super.setPriority(priority);<a name="line.1067"></a> -<span class="sourceLineNo">1068</span> }<a name="line.1068"></a> -<span class="sourceLineNo">1069</span><a name="line.1069"></a> -<span class="sourceLineNo">1070</span> /**<a name="line.1070"></a> -<span class="sourceLineNo">1071</span> * Enable collection of {@link ScanMetrics}. For advanced users.<a name="line.1071"></a> -<span class="sourceLineNo">1072</span> * @param enabled Set to true to enable accumulating scan metrics<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> */<a name="line.1073"></a> -<span class="sourceLineNo">1074</span> public Scan setScanMetricsEnabled(final boolean enabled) {<a name="line.1074"></a> -<span class="sourceLineNo">1075</span> setAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE, Bytes.toBytes(Boolean.valueOf(enabled)));<a name="line.1075"></a> -<span class="sourceLineNo">1076</span> return this;<a name="line.1076"></a> -<span class="sourceLineNo">1077</span> }<a name="line.1077"></a> -<span class="sourceLineNo">1078</span><a name="line.1078"></a> -<span class="sourceLineNo">1079</span> /**<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> * @return True if collection of scan metrics is enabled. For advanced users.<a name="line.1080"></a> -<span class="sourceLineNo">1081</span> */<a name="line.1081"></a> -<span class="sourceLineNo">1082</span> public boolean isScanMetricsEnabled() {<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> byte[] attr = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_ENABLE);<a name="line.1083"></a> -<span class="sourceLineNo">1084</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.1084"></a> -<span class="sourceLineNo">1085</span> }<a name="line.1085"></a> -<span class="sourceLineNo">1086</span><a name="line.1086"></a> -<span class="sourceLineNo">1087</span> /**<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> * @return Metrics on this Scan, if metrics were enabled.<a name="line.1088"></a> -<span class="sourceLineNo">1089</span> * @see #setScanMetricsEnabled(boolean)<a name="line.1089"></a> -<span class="sourceLineNo">1090</span> * @deprecated Use {@link ResultScanner#getScanMetrics()} instead. And notice that, please do not<a name="line.1090"></a> -<span class="sourceLineNo">1091</span> * use this method and {@link ResultScanner#getScanMetrics()} together, the metrics<a name="line.1091"></a> -<span class="sourceLineNo">1092</span> * will be messed up.<a name="line.1092"></a> -<span class="sourceLineNo">1093</span> */<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> @Deprecated<a name="line.1094"></a> -<span class="sourceLineNo">1095</span> public ScanMetrics getScanMetrics() {<a name="line.1095"></a> -<span class="sourceLineNo">1096</span> byte[] bytes = getAttribute(Scan.SCAN_ATTRIBUTES_METRICS_DATA);<a name="line.1096"></a> -<span class="sourceLineNo">1097</span> if (bytes == null) return null;<a name="line.1097"></a> -<span class="sourceLineNo">1098</span> return ProtobufUtil.toScanMetrics(bytes);<a name="line.1098"></a> -<span class="sourceLineNo">1099</span> }<a name="line.1099"></a> -<span class="sourceLineNo">1100</span><a name="line.1100"></a> -<span class="sourceLineNo">1101</span> public Boolean isAsyncPrefetch() {<a name="line.1101"></a> -<span class="sourceLineNo">1102</span> return asyncPrefetch;<a name="line.1102"></a> -<span class="sourceLineNo">1103</span> }<a name="line.1103"></a> -<span class="sourceLineNo">1104</span><a name="line.1104"></a> -<span class="sourceLineNo">1105</span> public Scan setAsyncPrefetch(boolean asyncPrefetch) {<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> this.asyncPrefetch = asyncPrefetch;<a name="line.1106"></a> -<span class="sourceLineNo">1107</span> return this;<a name="line.1107"></a> +<span class="sourceLineNo">992</span> * Enable/disable "raw" mode for this scan.<a name="line.992"></a> +<span class="sourceLineNo">993</span> * If "raw" is enabled the scan will return all<a name="line.993"></a> +<span class="sourceLineNo">994</span> * delete marker and deleted rows that have not<a name="line.994"></a> +<span class="sourceLineNo">995</span> * been collected, yet.<a name="line.995"></a> +<span class="sourceLineNo">996</span> * This is mostly useful for Scan on column families<a name="line.996"></a> +<span class="sourceLineNo">997</span> * that have KEEP_DELETED_ROWS enabled.<a name="line.997"></a> +<span class="sourceLineNo">998</span> * It is an error to specify any column when "raw" is set.<a name="line.998"></a> +<span class="sourceLineNo">999</span> * @param raw True/False to enable/disable "raw" mode.<a name="line.999"></a> +<span class="sourceLineNo">1000</span> */<a name="line.1000"></a> +<span class="sourceLineNo">1001</span> public Scan setRaw(boolean raw) {<a name="line.1001"></a> +<span class="sourceLineNo">1002</span> setAttribute(RAW_ATTR, Bytes.toBytes(raw));<a name="line.1002"></a> +<span class="sourceLineNo">1003</span> return this;<a name="line.1003"></a> +<span class="sourceLineNo">1004</span> }<a name="line.1004"></a> +<span class="sourceLineNo">1005</span><a name="line.1005"></a> +<span class="sourceLineNo">1006</span> /**<a name="line.1006"></a> +<span class="sourceLineNo">1007</span> * @return True if this Scan is in "raw" mode.<a name="line.1007"></a> +<span class="sourceLineNo">1008</span> */<a name="line.1008"></a> +<span class="sourceLineNo">1009</span> public boolean isRaw() {<a name="line.1009"></a> +<span class="sourceLineNo">1010</span> byte[] attr = getAttribute(RAW_ATTR);<a name="line.1010"></a> +<span class="sourceLineNo">1011</span> return attr == null ? false : Bytes.toBoolean(attr);<a name="line.1011"></a> +<span class="sourceLineNo">1012</span> }<a name="line.1012"></a> +<span class="sourceLineNo">1013</span><a name="line.1013"></a> +<span class="sourceLineNo">1014</span> /**<a name="line.1014"></a> +<span class="sourceLineNo">1015</span> * Set whether this scan is a small scan<a name="line.1015"></a> +<span class="sourceLineNo">1016</span> * <p><a name="line.1016"></a> +<span class="sourceLineNo">1017</span> * Small scan should use pread and big scan can use seek + read seek + read is fast but can cause<a name="line.1017"></a> +<span class="sourceLineNo">1018</span> * two problem (1) resource contention (2) cause too much network io [89-fb] Using pread for<a name="line.1018"></a> +<span class="sourceLineNo">1019</span> * non-compaction read request https://issues.apache.org/jira/browse/HBASE-7266 On the other hand,<a name="line.1019"></a> +<span class="sourceLineNo">1020</span> * if setting it true, we would do openScanner,next,closeScanner in one RPC call. It means the<a name="line.1020"></a> +<span class="sourceLineNo">1021</span> * better performance for small scan. [HBASE-9488]. Generally, if the scan range is within one<a name="line.1021"></a> +<span class="sourceLineNo">1022</span> * data block(64KB), it could be considered as a small scan.<a name="line.1022"></a> +<span class="sourceLineNo">1023</span> * @param small<a name="line.1023"></a> +<span class="sourceLineNo">1024</span> * @deprecated since 2.0.0. Use {@link #setLimit(int)} and {@link #setReadType(ReadType)} instead.<a name="line.1024"></a> +<span class="sourceLineNo">1025</span> * And for the one rpc optimization, now we will also fetch data when openScanner, and<a name="line.1025"></a> +<span class="sourceLineNo">1026</span> * if the number of rows reaches the limit then we will close the scanner<a name="line.1026"></a> +<span class="sourceLineNo">1027</span> * automatically which means we will fall back to one rpc.<a name="line.1027"></a> +<span class="sourceLineNo">1028</span> * @see #setLimit(int)<a name="line.1028"></a> +<span class="sourceLineNo">1029</span> * @see #setReadType(ReadType)<a name="line.1029"></a> +<span class="sourceLineNo">1030</span> */<a name="line.1030"></a> +<span class="sourceLineNo">1031</span> @Deprecated<a name="line.1031"></a> +<span class="sourceLineNo">1032</span> public Scan setSmall(boolean small) {<a name="line.1032"></a> +<span class="sourceLineNo">1033</span> this.small = small;<a name="line.1033"></a> +<span class="sourceLineNo">1034</span> this.readType = ReadType.PREAD;<a name="line.1034"></a> +<span class="sourceLineNo">1035</span> return this;<a name="line.1035"></a> +<span class="sourceLineNo">1036</span> }<a name="line.1036"></a> +<span class="sourceLineNo">1037</span><a name="line.1037"></a> +<span class="sourceLineNo">1038</span> /**<a name="line.1038"></a> +<span class="sourceLineNo">1039</span> * Get whether this scan is a small scan<a name="line.1039"></a> +<span class="sourceLineNo">1040</span> * @return true if small scan<a name="line.1040"></a> +<span class="sourceLineNo">1041</span> * @deprecated since 2.0.0. See the comment of {@link #setSmall(boolean)}<a name="line.1041"></a> +<span class="sourceLineNo">1042</span> */<a name="line.1042"></a> +<span class="sourceLineNo">1043</span> @Deprecated<a name="line.1043"></a> +<span class="sourceLineNo">1044</span> public boolean isSmall() {<a name="line.1044"></a> +<span class="sourceLineNo">1045</span> return small;<a name="line.1045"></a> +<span class="sourceLineNo">1046</span> }<a name="line.1046"></a> +<span class="sourceLineNo">1047</span><a name="line.1047"></a> +<span class="sourceLineNo">1048</span> @Override<a name="line.1048"></a> +<span class="sourceLineNo">1049</span> public Scan setAttribute(String name, byte[] value) {<a name="line.1049"></a> +<span class="sourceLineNo">1050</span> return (Scan) super.setAttribute(name, value);<a name="line.1050"></a> +<span class="sourceLineNo">1051</span> }<a name="line.1051"></a> +<span class="sourceLineNo">1052</span><a name="line.1052"></a> +<span class="sourceLineNo">1053</span> @Override<a name="line.1053"></a> +<span class="sourceLineNo">1054</span> public Scan setId(String id) {<a name="line.1054"></a> +<span class="sourceLineNo">1055</span> return (Scan) super.setId(id);<a name="line.1055"></a> +<span class="sourceLineNo">1056</span> }<a name="line.1056"></a> +<span class="sourceLineNo">1057</span><a name="line.1057"></a> +<span class="sourceLineNo">1058</span> @Override<a name="line.1058"></a> +<span class="sourceLineNo">1059</span> public Scan setAuthorizations(Authorizations authorizations) {<a name="line.1059"></a> +<span class="sourceLineNo">1060</span> return (Scan) super.setAuthorizations(authorizations);<a name="line.1060"></a> +<span class="sourceLineNo">1061</span> }<a name="line.1061"></a> +<span class="sourceLineNo">1062</span><a name="line.1062"></a> +<span class="sourceLineNo">1063</span> @Override<a name="line.1063"></a> +<span class="sourceLineNo">1064</span> public Scan setACL(Map<String, Permission> perms) {<a name="line.1064"></a> +<span class="sourceLineNo">1065</span> return (Scan) super.setACL(perms);<a name="line.1065"></a> +<span class="sourceLineNo">1066</span> }<a name="line.1066"></a> +<span class="sourceLineNo">1067</span><a name="line.1067"></a> +<span class="sourceLineNo">1068</span> @Override<a name="line.1068"></a> +<span class="sourceLineNo">1069</span> public Scan setACL(String user, Permission perms) {<a name="line.1069"></a> +<span class="sourceLineNo">1070</span> return (Scan) super.setACL(user, perms);<a name="line.1070"></a> +<span class="sourceLineNo">1071</span> }<a name="line.1071"></a> +<span class="sourceLineNo">1072</span><a name="line.1072"></a> +<span class="sourceLineNo">1073</span> @Override<a name="line.1073"></a> +<span class="sourceLineNo">1074</span> public Scan setConsistency(Consistency consistency) {<a name="line.1074"></a> +<span class="sourceLineNo">1075</span> return (Scan) super.setConsistency(consistency);<a name="line.1075"></a> +<span class="sourceLineNo">1076</span> }<a name="line.1076"></a>
<TRUNCATED>
