http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Entry.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Entry.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Entry.html index 0fa5a23..e31f5c6 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Entry.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Entry.html @@ -148,143 +148,160 @@ <span class="sourceLineNo">140</span> void sync(long txid) throws IOException;<a name="line.140"></a> <span class="sourceLineNo">141</span><a name="line.141"></a> <span class="sourceLineNo">142</span> /**<a name="line.142"></a> -<span class="sourceLineNo">143</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores<a name="line.143"></a> -<span class="sourceLineNo">144</span> * in order to be able to do accounting to figure which WALs can be let go. This method tells WAL<a name="line.144"></a> -<span class="sourceLineNo">145</span> * that some region is about to flush. The flush can be the whole region or for a column family<a name="line.145"></a> -<span class="sourceLineNo">146</span> * of the region only.<a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * <p>Currently, it is expected that the update lock is held for the region; i.e. no<a name="line.148"></a> -<span class="sourceLineNo">149</span> * concurrent appends while we set up cache flush.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if<a name="line.151"></a> -<span class="sourceLineNo">152</span> * we are flushing a subset of all families but there are no edits in those families not<a name="line.152"></a> -<span class="sourceLineNo">153</span> * being flushed; in other words, this is effectively same as a flush of all of the region<a name="line.153"></a> -<span class="sourceLineNo">154</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.154"></a> -<span class="sourceLineNo">155</span> * oldest/lowest outstanding edit.<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @see #completeCacheFlush(byte[])<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @see #abortCacheFlush(byte[])<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> /**<a name="line.163"></a> -<span class="sourceLineNo">164</span> * Complete the cache flush.<a name="line.164"></a> -<span class="sourceLineNo">165</span> * @param encodedRegionName Encoded region name.<a name="line.165"></a> -<span class="sourceLineNo">166</span> * @see #startCacheFlush(byte[], Set)<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @see #abortCacheFlush(byte[])<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> void completeCacheFlush(final byte[] encodedRegionName);<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery<a name="line.172"></a> -<span class="sourceLineNo">173</span> * for an aborted flush currently is a restart of the regionserver so the<a name="line.173"></a> -<span class="sourceLineNo">174</span> * snapshot content dropped by the failure gets restored to the memstore.<a name="line.174"></a> -<span class="sourceLineNo">175</span> * @param encodedRegionName Encoded region name.<a name="line.175"></a> -<span class="sourceLineNo">176</span> */<a name="line.176"></a> -<span class="sourceLineNo">177</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> /**<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return Coprocessor host.<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> WALCoprocessorHost getCoprocessorHost();<a name="line.182"></a> -<span class="sourceLineNo">183</span><a name="line.183"></a> -<span class="sourceLineNo">184</span> /**<a name="line.184"></a> -<span class="sourceLineNo">185</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @param encodedRegionName The region to get the number for.<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.188"></a> -<span class="sourceLineNo">189</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> @VisibleForTesting<a name="line.191"></a> -<span class="sourceLineNo">192</span> @Deprecated<a name="line.192"></a> -<span class="sourceLineNo">193</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.193"></a> -<span class="sourceLineNo">194</span><a name="line.194"></a> -<span class="sourceLineNo">195</span> /**<a name="line.195"></a> -<span class="sourceLineNo">196</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @param encodedRegionName The region to get the number for.<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param familyName The family to get the number for.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /**<a name="line.203"></a> -<span class="sourceLineNo">204</span> * Human readable identifying information about the state of this WAL.<a name="line.204"></a> -<span class="sourceLineNo">205</span> * Implementors are encouraged to include information appropriate for debugging.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * Consumers are advised not to rely on the details of the returned String; it does<a name="line.206"></a> -<span class="sourceLineNo">207</span> * not have a defined structure.<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> @Override<a name="line.209"></a> -<span class="sourceLineNo">210</span> String toString();<a name="line.210"></a> +<span class="sourceLineNo">143</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.143"></a> +<span class="sourceLineNo">144</span> * vs hsync.<a name="line.144"></a> +<span class="sourceLineNo">145</span> */<a name="line.145"></a> +<span class="sourceLineNo">146</span> default void sync(boolean forceSync) throws IOException {<a name="line.146"></a> +<span class="sourceLineNo">147</span> sync();<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> /**<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param txid Transaction id to sync to.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.152"></a> +<span class="sourceLineNo">153</span> * vs hsync.<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> default void sync(long txid, boolean forceSync) throws IOException {<a name="line.155"></a> +<span class="sourceLineNo">156</span> sync(txid);<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> /**<a name="line.159"></a> +<span class="sourceLineNo">160</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores<a name="line.160"></a> +<span class="sourceLineNo">161</span> * in order to be able to do accounting to figure which WALs can be let go. This method tells WAL<a name="line.161"></a> +<span class="sourceLineNo">162</span> * that some region is about to flush. The flush can be the whole region or for a column family<a name="line.162"></a> +<span class="sourceLineNo">163</span> * of the region only.<a name="line.163"></a> +<span class="sourceLineNo">164</span> *<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <p>Currently, it is expected that the update lock is held for the region; i.e. no<a name="line.165"></a> +<span class="sourceLineNo">166</span> * concurrent appends while we set up cache flush.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if<a name="line.168"></a> +<span class="sourceLineNo">169</span> * we are flushing a subset of all families but there are no edits in those families not<a name="line.169"></a> +<span class="sourceLineNo">170</span> * being flushed; in other words, this is effectively same as a flush of all of the region<a name="line.170"></a> +<span class="sourceLineNo">171</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.171"></a> +<span class="sourceLineNo">172</span> * oldest/lowest outstanding edit.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @see #completeCacheFlush(byte[])<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @see #abortCacheFlush(byte[])<a name="line.174"></a> +<span class="sourceLineNo">175</span> */<a name="line.175"></a> +<span class="sourceLineNo">176</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> /**<a name="line.180"></a> +<span class="sourceLineNo">181</span> * Complete the cache flush.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param encodedRegionName Encoded region name.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @see #startCacheFlush(byte[], Set)<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @see #abortCacheFlush(byte[])<a name="line.184"></a> +<span class="sourceLineNo">185</span> */<a name="line.185"></a> +<span class="sourceLineNo">186</span> void completeCacheFlush(final byte[] encodedRegionName);<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery<a name="line.189"></a> +<span class="sourceLineNo">190</span> * for an aborted flush currently is a restart of the regionserver so the<a name="line.190"></a> +<span class="sourceLineNo">191</span> * snapshot content dropped by the failure gets restored to the memstore.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param encodedRegionName Encoded region name.<a name="line.192"></a> +<span class="sourceLineNo">193</span> */<a name="line.193"></a> +<span class="sourceLineNo">194</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @return Coprocessor host.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> WALCoprocessorHost getCoprocessorHost();<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> /**<a name="line.201"></a> +<span class="sourceLineNo">202</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @param encodedRegionName The region to get the number for.<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.205"></a> +<span class="sourceLineNo">206</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.206"></a> +<span class="sourceLineNo">207</span> */<a name="line.207"></a> +<span class="sourceLineNo">208</span> @VisibleForTesting<a name="line.208"></a> +<span class="sourceLineNo">209</span> @Deprecated<a name="line.209"></a> +<span class="sourceLineNo">210</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.210"></a> <span class="sourceLineNo">211</span><a name="line.211"></a> <span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * When outside clients need to consume persisted WALs, they rely on a provided<a name="line.213"></a> -<span class="sourceLineNo">214</span> * Reader.<a name="line.214"></a> -<span class="sourceLineNo">215</span> */<a name="line.215"></a> -<span class="sourceLineNo">216</span> interface Reader extends Closeable {<a name="line.216"></a> -<span class="sourceLineNo">217</span> Entry next() throws IOException;<a name="line.217"></a> -<span class="sourceLineNo">218</span> Entry next(Entry reuse) throws IOException;<a name="line.218"></a> -<span class="sourceLineNo">219</span> void seek(long pos) throws IOException;<a name="line.219"></a> -<span class="sourceLineNo">220</span> long getPosition() throws IOException;<a name="line.220"></a> -<span class="sourceLineNo">221</span> void reset() throws IOException;<a name="line.221"></a> -<span class="sourceLineNo">222</span> }<a name="line.222"></a> -<span class="sourceLineNo">223</span><a name="line.223"></a> -<span class="sourceLineNo">224</span> /**<a name="line.224"></a> -<span class="sourceLineNo">225</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> class Entry {<a name="line.227"></a> -<span class="sourceLineNo">228</span> private final WALEdit edit;<a name="line.228"></a> -<span class="sourceLineNo">229</span> private final WALKeyImpl key;<a name="line.229"></a> -<span class="sourceLineNo">230</span><a name="line.230"></a> -<span class="sourceLineNo">231</span> public Entry() {<a name="line.231"></a> -<span class="sourceLineNo">232</span> this(new WALKeyImpl(), new WALEdit());<a name="line.232"></a> -<span class="sourceLineNo">233</span> }<a name="line.233"></a> -<span class="sourceLineNo">234</span><a name="line.234"></a> -<span class="sourceLineNo">235</span> /**<a name="line.235"></a> -<span class="sourceLineNo">236</span> * Constructor for both params<a name="line.236"></a> -<span class="sourceLineNo">237</span> *<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @param edit log's edit<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @param key log's key<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> this.key = key;<a name="line.242"></a> -<span class="sourceLineNo">243</span> this.edit = edit;<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Gets the edit<a name="line.247"></a> -<span class="sourceLineNo">248</span> *<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @return edit<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> public WALEdit getEdit() {<a name="line.251"></a> -<span class="sourceLineNo">252</span> return edit;<a name="line.252"></a> -<span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span><a name="line.254"></a> -<span class="sourceLineNo">255</span> /**<a name="line.255"></a> -<span class="sourceLineNo">256</span> * Gets the key<a name="line.256"></a> -<span class="sourceLineNo">257</span> *<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @return key<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> public WALKeyImpl getKey() {<a name="line.260"></a> -<span class="sourceLineNo">261</span> return key;<a name="line.261"></a> -<span class="sourceLineNo">262</span> }<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> /**<a name="line.264"></a> -<span class="sourceLineNo">265</span> * Set compression context for this entry.<a name="line.265"></a> -<span class="sourceLineNo">266</span> *<a name="line.266"></a> -<span class="sourceLineNo">267</span> * @param compressionContext<a name="line.267"></a> -<span class="sourceLineNo">268</span> * Compression context<a name="line.268"></a> -<span class="sourceLineNo">269</span> */<a name="line.269"></a> -<span class="sourceLineNo">270</span> public void setCompressionContext(CompressionContext compressionContext) {<a name="line.270"></a> -<span class="sourceLineNo">271</span> key.setCompressionContext(compressionContext);<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> @Override<a name="line.274"></a> -<span class="sourceLineNo">275</span> public String toString() {<a name="line.275"></a> -<span class="sourceLineNo">276</span> return this.key + "=" + this.edit;<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span> }<a name="line.278"></a> -<span class="sourceLineNo">279</span>}<a name="line.279"></a> +<span class="sourceLineNo">213</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @param encodedRegionName The region to get the number for.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param familyName The family to get the number for.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.216"></a> +<span class="sourceLineNo">217</span> */<a name="line.217"></a> +<span class="sourceLineNo">218</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * Human readable identifying information about the state of this WAL.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Implementors are encouraged to include information appropriate for debugging.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * Consumers are advised not to rely on the details of the returned String; it does<a name="line.223"></a> +<span class="sourceLineNo">224</span> * not have a defined structure.<a name="line.224"></a> +<span class="sourceLineNo">225</span> */<a name="line.225"></a> +<span class="sourceLineNo">226</span> @Override<a name="line.226"></a> +<span class="sourceLineNo">227</span> String toString();<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> /**<a name="line.229"></a> +<span class="sourceLineNo">230</span> * When outside clients need to consume persisted WALs, they rely on a provided<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Reader.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> interface Reader extends Closeable {<a name="line.233"></a> +<span class="sourceLineNo">234</span> Entry next() throws IOException;<a name="line.234"></a> +<span class="sourceLineNo">235</span> Entry next(Entry reuse) throws IOException;<a name="line.235"></a> +<span class="sourceLineNo">236</span> void seek(long pos) throws IOException;<a name="line.236"></a> +<span class="sourceLineNo">237</span> long getPosition() throws IOException;<a name="line.237"></a> +<span class="sourceLineNo">238</span> void reset() throws IOException;<a name="line.238"></a> +<span class="sourceLineNo">239</span> }<a name="line.239"></a> +<span class="sourceLineNo">240</span><a name="line.240"></a> +<span class="sourceLineNo">241</span> /**<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.242"></a> +<span class="sourceLineNo">243</span> */<a name="line.243"></a> +<span class="sourceLineNo">244</span> class Entry {<a name="line.244"></a> +<span class="sourceLineNo">245</span> private final WALEdit edit;<a name="line.245"></a> +<span class="sourceLineNo">246</span> private final WALKeyImpl key;<a name="line.246"></a> +<span class="sourceLineNo">247</span><a name="line.247"></a> +<span class="sourceLineNo">248</span> public Entry() {<a name="line.248"></a> +<span class="sourceLineNo">249</span> this(new WALKeyImpl(), new WALEdit());<a name="line.249"></a> +<span class="sourceLineNo">250</span> }<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> /**<a name="line.252"></a> +<span class="sourceLineNo">253</span> * Constructor for both params<a name="line.253"></a> +<span class="sourceLineNo">254</span> *<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @param edit log's edit<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @param key log's key<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.258"></a> +<span class="sourceLineNo">259</span> this.key = key;<a name="line.259"></a> +<span class="sourceLineNo">260</span> this.edit = edit;<a name="line.260"></a> +<span class="sourceLineNo">261</span> }<a name="line.261"></a> +<span class="sourceLineNo">262</span><a name="line.262"></a> +<span class="sourceLineNo">263</span> /**<a name="line.263"></a> +<span class="sourceLineNo">264</span> * Gets the edit<a name="line.264"></a> +<span class="sourceLineNo">265</span> *<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return edit<a name="line.266"></a> +<span class="sourceLineNo">267</span> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> public WALEdit getEdit() {<a name="line.268"></a> +<span class="sourceLineNo">269</span> return edit;<a name="line.269"></a> +<span class="sourceLineNo">270</span> }<a name="line.270"></a> +<span class="sourceLineNo">271</span><a name="line.271"></a> +<span class="sourceLineNo">272</span> /**<a name="line.272"></a> +<span class="sourceLineNo">273</span> * Gets the key<a name="line.273"></a> +<span class="sourceLineNo">274</span> *<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @return key<a name="line.275"></a> +<span class="sourceLineNo">276</span> */<a name="line.276"></a> +<span class="sourceLineNo">277</span> public WALKeyImpl getKey() {<a name="line.277"></a> +<span class="sourceLineNo">278</span> return key;<a name="line.278"></a> +<span class="sourceLineNo">279</span> }<a name="line.279"></a> +<span class="sourceLineNo">280</span><a name="line.280"></a> +<span class="sourceLineNo">281</span> /**<a name="line.281"></a> +<span class="sourceLineNo">282</span> * Set compression context for this entry.<a name="line.282"></a> +<span class="sourceLineNo">283</span> *<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @param compressionContext<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Compression context<a name="line.285"></a> +<span class="sourceLineNo">286</span> */<a name="line.286"></a> +<span class="sourceLineNo">287</span> public void setCompressionContext(CompressionContext compressionContext) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> key.setCompressionContext(compressionContext);<a name="line.288"></a> +<span class="sourceLineNo">289</span> }<a name="line.289"></a> +<span class="sourceLineNo">290</span><a name="line.290"></a> +<span class="sourceLineNo">291</span> @Override<a name="line.291"></a> +<span class="sourceLineNo">292</span> public String toString() {<a name="line.292"></a> +<span class="sourceLineNo">293</span> return this.key + "=" + this.edit;<a name="line.293"></a> +<span class="sourceLineNo">294</span> }<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span>}<a name="line.296"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Reader.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Reader.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Reader.html index 0fa5a23..e31f5c6 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Reader.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.Reader.html @@ -148,143 +148,160 @@ <span class="sourceLineNo">140</span> void sync(long txid) throws IOException;<a name="line.140"></a> <span class="sourceLineNo">141</span><a name="line.141"></a> <span class="sourceLineNo">142</span> /**<a name="line.142"></a> -<span class="sourceLineNo">143</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores<a name="line.143"></a> -<span class="sourceLineNo">144</span> * in order to be able to do accounting to figure which WALs can be let go. This method tells WAL<a name="line.144"></a> -<span class="sourceLineNo">145</span> * that some region is about to flush. The flush can be the whole region or for a column family<a name="line.145"></a> -<span class="sourceLineNo">146</span> * of the region only.<a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * <p>Currently, it is expected that the update lock is held for the region; i.e. no<a name="line.148"></a> -<span class="sourceLineNo">149</span> * concurrent appends while we set up cache flush.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if<a name="line.151"></a> -<span class="sourceLineNo">152</span> * we are flushing a subset of all families but there are no edits in those families not<a name="line.152"></a> -<span class="sourceLineNo">153</span> * being flushed; in other words, this is effectively same as a flush of all of the region<a name="line.153"></a> -<span class="sourceLineNo">154</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.154"></a> -<span class="sourceLineNo">155</span> * oldest/lowest outstanding edit.<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @see #completeCacheFlush(byte[])<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @see #abortCacheFlush(byte[])<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> /**<a name="line.163"></a> -<span class="sourceLineNo">164</span> * Complete the cache flush.<a name="line.164"></a> -<span class="sourceLineNo">165</span> * @param encodedRegionName Encoded region name.<a name="line.165"></a> -<span class="sourceLineNo">166</span> * @see #startCacheFlush(byte[], Set)<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @see #abortCacheFlush(byte[])<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> void completeCacheFlush(final byte[] encodedRegionName);<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery<a name="line.172"></a> -<span class="sourceLineNo">173</span> * for an aborted flush currently is a restart of the regionserver so the<a name="line.173"></a> -<span class="sourceLineNo">174</span> * snapshot content dropped by the failure gets restored to the memstore.<a name="line.174"></a> -<span class="sourceLineNo">175</span> * @param encodedRegionName Encoded region name.<a name="line.175"></a> -<span class="sourceLineNo">176</span> */<a name="line.176"></a> -<span class="sourceLineNo">177</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> /**<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return Coprocessor host.<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> WALCoprocessorHost getCoprocessorHost();<a name="line.182"></a> -<span class="sourceLineNo">183</span><a name="line.183"></a> -<span class="sourceLineNo">184</span> /**<a name="line.184"></a> -<span class="sourceLineNo">185</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @param encodedRegionName The region to get the number for.<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.188"></a> -<span class="sourceLineNo">189</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> @VisibleForTesting<a name="line.191"></a> -<span class="sourceLineNo">192</span> @Deprecated<a name="line.192"></a> -<span class="sourceLineNo">193</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.193"></a> -<span class="sourceLineNo">194</span><a name="line.194"></a> -<span class="sourceLineNo">195</span> /**<a name="line.195"></a> -<span class="sourceLineNo">196</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @param encodedRegionName The region to get the number for.<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param familyName The family to get the number for.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /**<a name="line.203"></a> -<span class="sourceLineNo">204</span> * Human readable identifying information about the state of this WAL.<a name="line.204"></a> -<span class="sourceLineNo">205</span> * Implementors are encouraged to include information appropriate for debugging.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * Consumers are advised not to rely on the details of the returned String; it does<a name="line.206"></a> -<span class="sourceLineNo">207</span> * not have a defined structure.<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> @Override<a name="line.209"></a> -<span class="sourceLineNo">210</span> String toString();<a name="line.210"></a> +<span class="sourceLineNo">143</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.143"></a> +<span class="sourceLineNo">144</span> * vs hsync.<a name="line.144"></a> +<span class="sourceLineNo">145</span> */<a name="line.145"></a> +<span class="sourceLineNo">146</span> default void sync(boolean forceSync) throws IOException {<a name="line.146"></a> +<span class="sourceLineNo">147</span> sync();<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> /**<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param txid Transaction id to sync to.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.152"></a> +<span class="sourceLineNo">153</span> * vs hsync.<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> default void sync(long txid, boolean forceSync) throws IOException {<a name="line.155"></a> +<span class="sourceLineNo">156</span> sync(txid);<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> /**<a name="line.159"></a> +<span class="sourceLineNo">160</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores<a name="line.160"></a> +<span class="sourceLineNo">161</span> * in order to be able to do accounting to figure which WALs can be let go. This method tells WAL<a name="line.161"></a> +<span class="sourceLineNo">162</span> * that some region is about to flush. The flush can be the whole region or for a column family<a name="line.162"></a> +<span class="sourceLineNo">163</span> * of the region only.<a name="line.163"></a> +<span class="sourceLineNo">164</span> *<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <p>Currently, it is expected that the update lock is held for the region; i.e. no<a name="line.165"></a> +<span class="sourceLineNo">166</span> * concurrent appends while we set up cache flush.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if<a name="line.168"></a> +<span class="sourceLineNo">169</span> * we are flushing a subset of all families but there are no edits in those families not<a name="line.169"></a> +<span class="sourceLineNo">170</span> * being flushed; in other words, this is effectively same as a flush of all of the region<a name="line.170"></a> +<span class="sourceLineNo">171</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.171"></a> +<span class="sourceLineNo">172</span> * oldest/lowest outstanding edit.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @see #completeCacheFlush(byte[])<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @see #abortCacheFlush(byte[])<a name="line.174"></a> +<span class="sourceLineNo">175</span> */<a name="line.175"></a> +<span class="sourceLineNo">176</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> /**<a name="line.180"></a> +<span class="sourceLineNo">181</span> * Complete the cache flush.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param encodedRegionName Encoded region name.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @see #startCacheFlush(byte[], Set)<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @see #abortCacheFlush(byte[])<a name="line.184"></a> +<span class="sourceLineNo">185</span> */<a name="line.185"></a> +<span class="sourceLineNo">186</span> void completeCacheFlush(final byte[] encodedRegionName);<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery<a name="line.189"></a> +<span class="sourceLineNo">190</span> * for an aborted flush currently is a restart of the regionserver so the<a name="line.190"></a> +<span class="sourceLineNo">191</span> * snapshot content dropped by the failure gets restored to the memstore.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param encodedRegionName Encoded region name.<a name="line.192"></a> +<span class="sourceLineNo">193</span> */<a name="line.193"></a> +<span class="sourceLineNo">194</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @return Coprocessor host.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> WALCoprocessorHost getCoprocessorHost();<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> /**<a name="line.201"></a> +<span class="sourceLineNo">202</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @param encodedRegionName The region to get the number for.<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.205"></a> +<span class="sourceLineNo">206</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.206"></a> +<span class="sourceLineNo">207</span> */<a name="line.207"></a> +<span class="sourceLineNo">208</span> @VisibleForTesting<a name="line.208"></a> +<span class="sourceLineNo">209</span> @Deprecated<a name="line.209"></a> +<span class="sourceLineNo">210</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.210"></a> <span class="sourceLineNo">211</span><a name="line.211"></a> <span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * When outside clients need to consume persisted WALs, they rely on a provided<a name="line.213"></a> -<span class="sourceLineNo">214</span> * Reader.<a name="line.214"></a> -<span class="sourceLineNo">215</span> */<a name="line.215"></a> -<span class="sourceLineNo">216</span> interface Reader extends Closeable {<a name="line.216"></a> -<span class="sourceLineNo">217</span> Entry next() throws IOException;<a name="line.217"></a> -<span class="sourceLineNo">218</span> Entry next(Entry reuse) throws IOException;<a name="line.218"></a> -<span class="sourceLineNo">219</span> void seek(long pos) throws IOException;<a name="line.219"></a> -<span class="sourceLineNo">220</span> long getPosition() throws IOException;<a name="line.220"></a> -<span class="sourceLineNo">221</span> void reset() throws IOException;<a name="line.221"></a> -<span class="sourceLineNo">222</span> }<a name="line.222"></a> -<span class="sourceLineNo">223</span><a name="line.223"></a> -<span class="sourceLineNo">224</span> /**<a name="line.224"></a> -<span class="sourceLineNo">225</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> class Entry {<a name="line.227"></a> -<span class="sourceLineNo">228</span> private final WALEdit edit;<a name="line.228"></a> -<span class="sourceLineNo">229</span> private final WALKeyImpl key;<a name="line.229"></a> -<span class="sourceLineNo">230</span><a name="line.230"></a> -<span class="sourceLineNo">231</span> public Entry() {<a name="line.231"></a> -<span class="sourceLineNo">232</span> this(new WALKeyImpl(), new WALEdit());<a name="line.232"></a> -<span class="sourceLineNo">233</span> }<a name="line.233"></a> -<span class="sourceLineNo">234</span><a name="line.234"></a> -<span class="sourceLineNo">235</span> /**<a name="line.235"></a> -<span class="sourceLineNo">236</span> * Constructor for both params<a name="line.236"></a> -<span class="sourceLineNo">237</span> *<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @param edit log's edit<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @param key log's key<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> this.key = key;<a name="line.242"></a> -<span class="sourceLineNo">243</span> this.edit = edit;<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Gets the edit<a name="line.247"></a> -<span class="sourceLineNo">248</span> *<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @return edit<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> public WALEdit getEdit() {<a name="line.251"></a> -<span class="sourceLineNo">252</span> return edit;<a name="line.252"></a> -<span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span><a name="line.254"></a> -<span class="sourceLineNo">255</span> /**<a name="line.255"></a> -<span class="sourceLineNo">256</span> * Gets the key<a name="line.256"></a> -<span class="sourceLineNo">257</span> *<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @return key<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> public WALKeyImpl getKey() {<a name="line.260"></a> -<span class="sourceLineNo">261</span> return key;<a name="line.261"></a> -<span class="sourceLineNo">262</span> }<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> /**<a name="line.264"></a> -<span class="sourceLineNo">265</span> * Set compression context for this entry.<a name="line.265"></a> -<span class="sourceLineNo">266</span> *<a name="line.266"></a> -<span class="sourceLineNo">267</span> * @param compressionContext<a name="line.267"></a> -<span class="sourceLineNo">268</span> * Compression context<a name="line.268"></a> -<span class="sourceLineNo">269</span> */<a name="line.269"></a> -<span class="sourceLineNo">270</span> public void setCompressionContext(CompressionContext compressionContext) {<a name="line.270"></a> -<span class="sourceLineNo">271</span> key.setCompressionContext(compressionContext);<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> @Override<a name="line.274"></a> -<span class="sourceLineNo">275</span> public String toString() {<a name="line.275"></a> -<span class="sourceLineNo">276</span> return this.key + "=" + this.edit;<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span> }<a name="line.278"></a> -<span class="sourceLineNo">279</span>}<a name="line.279"></a> +<span class="sourceLineNo">213</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @param encodedRegionName The region to get the number for.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param familyName The family to get the number for.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.216"></a> +<span class="sourceLineNo">217</span> */<a name="line.217"></a> +<span class="sourceLineNo">218</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * Human readable identifying information about the state of this WAL.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Implementors are encouraged to include information appropriate for debugging.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * Consumers are advised not to rely on the details of the returned String; it does<a name="line.223"></a> +<span class="sourceLineNo">224</span> * not have a defined structure.<a name="line.224"></a> +<span class="sourceLineNo">225</span> */<a name="line.225"></a> +<span class="sourceLineNo">226</span> @Override<a name="line.226"></a> +<span class="sourceLineNo">227</span> String toString();<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> /**<a name="line.229"></a> +<span class="sourceLineNo">230</span> * When outside clients need to consume persisted WALs, they rely on a provided<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Reader.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> interface Reader extends Closeable {<a name="line.233"></a> +<span class="sourceLineNo">234</span> Entry next() throws IOException;<a name="line.234"></a> +<span class="sourceLineNo">235</span> Entry next(Entry reuse) throws IOException;<a name="line.235"></a> +<span class="sourceLineNo">236</span> void seek(long pos) throws IOException;<a name="line.236"></a> +<span class="sourceLineNo">237</span> long getPosition() throws IOException;<a name="line.237"></a> +<span class="sourceLineNo">238</span> void reset() throws IOException;<a name="line.238"></a> +<span class="sourceLineNo">239</span> }<a name="line.239"></a> +<span class="sourceLineNo">240</span><a name="line.240"></a> +<span class="sourceLineNo">241</span> /**<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.242"></a> +<span class="sourceLineNo">243</span> */<a name="line.243"></a> +<span class="sourceLineNo">244</span> class Entry {<a name="line.244"></a> +<span class="sourceLineNo">245</span> private final WALEdit edit;<a name="line.245"></a> +<span class="sourceLineNo">246</span> private final WALKeyImpl key;<a name="line.246"></a> +<span class="sourceLineNo">247</span><a name="line.247"></a> +<span class="sourceLineNo">248</span> public Entry() {<a name="line.248"></a> +<span class="sourceLineNo">249</span> this(new WALKeyImpl(), new WALEdit());<a name="line.249"></a> +<span class="sourceLineNo">250</span> }<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> /**<a name="line.252"></a> +<span class="sourceLineNo">253</span> * Constructor for both params<a name="line.253"></a> +<span class="sourceLineNo">254</span> *<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @param edit log's edit<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @param key log's key<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.258"></a> +<span class="sourceLineNo">259</span> this.key = key;<a name="line.259"></a> +<span class="sourceLineNo">260</span> this.edit = edit;<a name="line.260"></a> +<span class="sourceLineNo">261</span> }<a name="line.261"></a> +<span class="sourceLineNo">262</span><a name="line.262"></a> +<span class="sourceLineNo">263</span> /**<a name="line.263"></a> +<span class="sourceLineNo">264</span> * Gets the edit<a name="line.264"></a> +<span class="sourceLineNo">265</span> *<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return edit<a name="line.266"></a> +<span class="sourceLineNo">267</span> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> public WALEdit getEdit() {<a name="line.268"></a> +<span class="sourceLineNo">269</span> return edit;<a name="line.269"></a> +<span class="sourceLineNo">270</span> }<a name="line.270"></a> +<span class="sourceLineNo">271</span><a name="line.271"></a> +<span class="sourceLineNo">272</span> /**<a name="line.272"></a> +<span class="sourceLineNo">273</span> * Gets the key<a name="line.273"></a> +<span class="sourceLineNo">274</span> *<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @return key<a name="line.275"></a> +<span class="sourceLineNo">276</span> */<a name="line.276"></a> +<span class="sourceLineNo">277</span> public WALKeyImpl getKey() {<a name="line.277"></a> +<span class="sourceLineNo">278</span> return key;<a name="line.278"></a> +<span class="sourceLineNo">279</span> }<a name="line.279"></a> +<span class="sourceLineNo">280</span><a name="line.280"></a> +<span class="sourceLineNo">281</span> /**<a name="line.281"></a> +<span class="sourceLineNo">282</span> * Set compression context for this entry.<a name="line.282"></a> +<span class="sourceLineNo">283</span> *<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @param compressionContext<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Compression context<a name="line.285"></a> +<span class="sourceLineNo">286</span> */<a name="line.286"></a> +<span class="sourceLineNo">287</span> public void setCompressionContext(CompressionContext compressionContext) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> key.setCompressionContext(compressionContext);<a name="line.288"></a> +<span class="sourceLineNo">289</span> }<a name="line.289"></a> +<span class="sourceLineNo">290</span><a name="line.290"></a> +<span class="sourceLineNo">291</span> @Override<a name="line.291"></a> +<span class="sourceLineNo">292</span> public String toString() {<a name="line.292"></a> +<span class="sourceLineNo">293</span> return this.key + "=" + this.edit;<a name="line.293"></a> +<span class="sourceLineNo">294</span> }<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span>}<a name="line.296"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.html index 0fa5a23..e31f5c6 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WAL.html @@ -148,143 +148,160 @@ <span class="sourceLineNo">140</span> void sync(long txid) throws IOException;<a name="line.140"></a> <span class="sourceLineNo">141</span><a name="line.141"></a> <span class="sourceLineNo">142</span> /**<a name="line.142"></a> -<span class="sourceLineNo">143</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores<a name="line.143"></a> -<span class="sourceLineNo">144</span> * in order to be able to do accounting to figure which WALs can be let go. This method tells WAL<a name="line.144"></a> -<span class="sourceLineNo">145</span> * that some region is about to flush. The flush can be the whole region or for a column family<a name="line.145"></a> -<span class="sourceLineNo">146</span> * of the region only.<a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * <p>Currently, it is expected that the update lock is held for the region; i.e. no<a name="line.148"></a> -<span class="sourceLineNo">149</span> * concurrent appends while we set up cache flush.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.150"></a> -<span class="sourceLineNo">151</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if<a name="line.151"></a> -<span class="sourceLineNo">152</span> * we are flushing a subset of all families but there are no edits in those families not<a name="line.152"></a> -<span class="sourceLineNo">153</span> * being flushed; in other words, this is effectively same as a flush of all of the region<a name="line.153"></a> -<span class="sourceLineNo">154</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.154"></a> -<span class="sourceLineNo">155</span> * oldest/lowest outstanding edit.<a name="line.155"></a> -<span class="sourceLineNo">156</span> * @see #completeCacheFlush(byte[])<a name="line.156"></a> -<span class="sourceLineNo">157</span> * @see #abortCacheFlush(byte[])<a name="line.157"></a> -<span class="sourceLineNo">158</span> */<a name="line.158"></a> -<span class="sourceLineNo">159</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<a name="line.161"></a> -<span class="sourceLineNo">162</span><a name="line.162"></a> -<span class="sourceLineNo">163</span> /**<a name="line.163"></a> -<span class="sourceLineNo">164</span> * Complete the cache flush.<a name="line.164"></a> -<span class="sourceLineNo">165</span> * @param encodedRegionName Encoded region name.<a name="line.165"></a> -<span class="sourceLineNo">166</span> * @see #startCacheFlush(byte[], Set)<a name="line.166"></a> -<span class="sourceLineNo">167</span> * @see #abortCacheFlush(byte[])<a name="line.167"></a> -<span class="sourceLineNo">168</span> */<a name="line.168"></a> -<span class="sourceLineNo">169</span> void completeCacheFlush(final byte[] encodedRegionName);<a name="line.169"></a> -<span class="sourceLineNo">170</span><a name="line.170"></a> -<span class="sourceLineNo">171</span> /**<a name="line.171"></a> -<span class="sourceLineNo">172</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery<a name="line.172"></a> -<span class="sourceLineNo">173</span> * for an aborted flush currently is a restart of the regionserver so the<a name="line.173"></a> -<span class="sourceLineNo">174</span> * snapshot content dropped by the failure gets restored to the memstore.<a name="line.174"></a> -<span class="sourceLineNo">175</span> * @param encodedRegionName Encoded region name.<a name="line.175"></a> -<span class="sourceLineNo">176</span> */<a name="line.176"></a> -<span class="sourceLineNo">177</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.177"></a> -<span class="sourceLineNo">178</span><a name="line.178"></a> -<span class="sourceLineNo">179</span> /**<a name="line.179"></a> -<span class="sourceLineNo">180</span> * @return Coprocessor host.<a name="line.180"></a> -<span class="sourceLineNo">181</span> */<a name="line.181"></a> -<span class="sourceLineNo">182</span> WALCoprocessorHost getCoprocessorHost();<a name="line.182"></a> -<span class="sourceLineNo">183</span><a name="line.183"></a> -<span class="sourceLineNo">184</span> /**<a name="line.184"></a> -<span class="sourceLineNo">185</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.185"></a> -<span class="sourceLineNo">186</span> * @param encodedRegionName The region to get the number for.<a name="line.186"></a> -<span class="sourceLineNo">187</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.187"></a> -<span class="sourceLineNo">188</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.188"></a> -<span class="sourceLineNo">189</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.189"></a> -<span class="sourceLineNo">190</span> */<a name="line.190"></a> -<span class="sourceLineNo">191</span> @VisibleForTesting<a name="line.191"></a> -<span class="sourceLineNo">192</span> @Deprecated<a name="line.192"></a> -<span class="sourceLineNo">193</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.193"></a> -<span class="sourceLineNo">194</span><a name="line.194"></a> -<span class="sourceLineNo">195</span> /**<a name="line.195"></a> -<span class="sourceLineNo">196</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @param encodedRegionName The region to get the number for.<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param familyName The family to get the number for.<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.199"></a> -<span class="sourceLineNo">200</span> */<a name="line.200"></a> -<span class="sourceLineNo">201</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> /**<a name="line.203"></a> -<span class="sourceLineNo">204</span> * Human readable identifying information about the state of this WAL.<a name="line.204"></a> -<span class="sourceLineNo">205</span> * Implementors are encouraged to include information appropriate for debugging.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * Consumers are advised not to rely on the details of the returned String; it does<a name="line.206"></a> -<span class="sourceLineNo">207</span> * not have a defined structure.<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> @Override<a name="line.209"></a> -<span class="sourceLineNo">210</span> String toString();<a name="line.210"></a> +<span class="sourceLineNo">143</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.143"></a> +<span class="sourceLineNo">144</span> * vs hsync.<a name="line.144"></a> +<span class="sourceLineNo">145</span> */<a name="line.145"></a> +<span class="sourceLineNo">146</span> default void sync(boolean forceSync) throws IOException {<a name="line.146"></a> +<span class="sourceLineNo">147</span> sync();<a name="line.147"></a> +<span class="sourceLineNo">148</span> }<a name="line.148"></a> +<span class="sourceLineNo">149</span><a name="line.149"></a> +<span class="sourceLineNo">150</span> /**<a name="line.150"></a> +<span class="sourceLineNo">151</span> * @param txid Transaction id to sync to.<a name="line.151"></a> +<span class="sourceLineNo">152</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.152"></a> +<span class="sourceLineNo">153</span> * vs hsync.<a name="line.153"></a> +<span class="sourceLineNo">154</span> */<a name="line.154"></a> +<span class="sourceLineNo">155</span> default void sync(long txid, boolean forceSync) throws IOException {<a name="line.155"></a> +<span class="sourceLineNo">156</span> sync(txid);<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<a name="line.157"></a> +<span class="sourceLineNo">158</span><a name="line.158"></a> +<span class="sourceLineNo">159</span> /**<a name="line.159"></a> +<span class="sourceLineNo">160</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores<a name="line.160"></a> +<span class="sourceLineNo">161</span> * in order to be able to do accounting to figure which WALs can be let go. This method tells WAL<a name="line.161"></a> +<span class="sourceLineNo">162</span> * that some region is about to flush. The flush can be the whole region or for a column family<a name="line.162"></a> +<span class="sourceLineNo">163</span> * of the region only.<a name="line.163"></a> +<span class="sourceLineNo">164</span> *<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <p>Currently, it is expected that the update lock is held for the region; i.e. no<a name="line.165"></a> +<span class="sourceLineNo">166</span> * concurrent appends while we set up cache flush.<a name="line.166"></a> +<span class="sourceLineNo">167</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.167"></a> +<span class="sourceLineNo">168</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if<a name="line.168"></a> +<span class="sourceLineNo">169</span> * we are flushing a subset of all families but there are no edits in those families not<a name="line.169"></a> +<span class="sourceLineNo">170</span> * being flushed; in other words, this is effectively same as a flush of all of the region<a name="line.170"></a> +<span class="sourceLineNo">171</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.171"></a> +<span class="sourceLineNo">172</span> * oldest/lowest outstanding edit.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @see #completeCacheFlush(byte[])<a name="line.173"></a> +<span class="sourceLineNo">174</span> * @see #abortCacheFlush(byte[])<a name="line.174"></a> +<span class="sourceLineNo">175</span> */<a name="line.175"></a> +<span class="sourceLineNo">176</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.176"></a> +<span class="sourceLineNo">177</span><a name="line.177"></a> +<span class="sourceLineNo">178</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<a name="line.178"></a> +<span class="sourceLineNo">179</span><a name="line.179"></a> +<span class="sourceLineNo">180</span> /**<a name="line.180"></a> +<span class="sourceLineNo">181</span> * Complete the cache flush.<a name="line.181"></a> +<span class="sourceLineNo">182</span> * @param encodedRegionName Encoded region name.<a name="line.182"></a> +<span class="sourceLineNo">183</span> * @see #startCacheFlush(byte[], Set)<a name="line.183"></a> +<span class="sourceLineNo">184</span> * @see #abortCacheFlush(byte[])<a name="line.184"></a> +<span class="sourceLineNo">185</span> */<a name="line.185"></a> +<span class="sourceLineNo">186</span> void completeCacheFlush(final byte[] encodedRegionName);<a name="line.186"></a> +<span class="sourceLineNo">187</span><a name="line.187"></a> +<span class="sourceLineNo">188</span> /**<a name="line.188"></a> +<span class="sourceLineNo">189</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery<a name="line.189"></a> +<span class="sourceLineNo">190</span> * for an aborted flush currently is a restart of the regionserver so the<a name="line.190"></a> +<span class="sourceLineNo">191</span> * snapshot content dropped by the failure gets restored to the memstore.<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param encodedRegionName Encoded region name.<a name="line.192"></a> +<span class="sourceLineNo">193</span> */<a name="line.193"></a> +<span class="sourceLineNo">194</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.194"></a> +<span class="sourceLineNo">195</span><a name="line.195"></a> +<span class="sourceLineNo">196</span> /**<a name="line.196"></a> +<span class="sourceLineNo">197</span> * @return Coprocessor host.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> WALCoprocessorHost getCoprocessorHost();<a name="line.199"></a> +<span class="sourceLineNo">200</span><a name="line.200"></a> +<span class="sourceLineNo">201</span> /**<a name="line.201"></a> +<span class="sourceLineNo">202</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.202"></a> +<span class="sourceLineNo">203</span> * @param encodedRegionName The region to get the number for.<a name="line.203"></a> +<span class="sourceLineNo">204</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.204"></a> +<span class="sourceLineNo">205</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.205"></a> +<span class="sourceLineNo">206</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.206"></a> +<span class="sourceLineNo">207</span> */<a name="line.207"></a> +<span class="sourceLineNo">208</span> @VisibleForTesting<a name="line.208"></a> +<span class="sourceLineNo">209</span> @Deprecated<a name="line.209"></a> +<span class="sourceLineNo">210</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.210"></a> <span class="sourceLineNo">211</span><a name="line.211"></a> <span class="sourceLineNo">212</span> /**<a name="line.212"></a> -<span class="sourceLineNo">213</span> * When outside clients need to consume persisted WALs, they rely on a provided<a name="line.213"></a> -<span class="sourceLineNo">214</span> * Reader.<a name="line.214"></a> -<span class="sourceLineNo">215</span> */<a name="line.215"></a> -<span class="sourceLineNo">216</span> interface Reader extends Closeable {<a name="line.216"></a> -<span class="sourceLineNo">217</span> Entry next() throws IOException;<a name="line.217"></a> -<span class="sourceLineNo">218</span> Entry next(Entry reuse) throws IOException;<a name="line.218"></a> -<span class="sourceLineNo">219</span> void seek(long pos) throws IOException;<a name="line.219"></a> -<span class="sourceLineNo">220</span> long getPosition() throws IOException;<a name="line.220"></a> -<span class="sourceLineNo">221</span> void reset() throws IOException;<a name="line.221"></a> -<span class="sourceLineNo">222</span> }<a name="line.222"></a> -<span class="sourceLineNo">223</span><a name="line.223"></a> -<span class="sourceLineNo">224</span> /**<a name="line.224"></a> -<span class="sourceLineNo">225</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.225"></a> -<span class="sourceLineNo">226</span> */<a name="line.226"></a> -<span class="sourceLineNo">227</span> class Entry {<a name="line.227"></a> -<span class="sourceLineNo">228</span> private final WALEdit edit;<a name="line.228"></a> -<span class="sourceLineNo">229</span> private final WALKeyImpl key;<a name="line.229"></a> -<span class="sourceLineNo">230</span><a name="line.230"></a> -<span class="sourceLineNo">231</span> public Entry() {<a name="line.231"></a> -<span class="sourceLineNo">232</span> this(new WALKeyImpl(), new WALEdit());<a name="line.232"></a> -<span class="sourceLineNo">233</span> }<a name="line.233"></a> -<span class="sourceLineNo">234</span><a name="line.234"></a> -<span class="sourceLineNo">235</span> /**<a name="line.235"></a> -<span class="sourceLineNo">236</span> * Constructor for both params<a name="line.236"></a> -<span class="sourceLineNo">237</span> *<a name="line.237"></a> -<span class="sourceLineNo">238</span> * @param edit log's edit<a name="line.238"></a> -<span class="sourceLineNo">239</span> * @param key log's key<a name="line.239"></a> -<span class="sourceLineNo">240</span> */<a name="line.240"></a> -<span class="sourceLineNo">241</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.241"></a> -<span class="sourceLineNo">242</span> this.key = key;<a name="line.242"></a> -<span class="sourceLineNo">243</span> this.edit = edit;<a name="line.243"></a> -<span class="sourceLineNo">244</span> }<a name="line.244"></a> -<span class="sourceLineNo">245</span><a name="line.245"></a> -<span class="sourceLineNo">246</span> /**<a name="line.246"></a> -<span class="sourceLineNo">247</span> * Gets the edit<a name="line.247"></a> -<span class="sourceLineNo">248</span> *<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @return edit<a name="line.249"></a> -<span class="sourceLineNo">250</span> */<a name="line.250"></a> -<span class="sourceLineNo">251</span> public WALEdit getEdit() {<a name="line.251"></a> -<span class="sourceLineNo">252</span> return edit;<a name="line.252"></a> -<span class="sourceLineNo">253</span> }<a name="line.253"></a> -<span class="sourceLineNo">254</span><a name="line.254"></a> -<span class="sourceLineNo">255</span> /**<a name="line.255"></a> -<span class="sourceLineNo">256</span> * Gets the key<a name="line.256"></a> -<span class="sourceLineNo">257</span> *<a name="line.257"></a> -<span class="sourceLineNo">258</span> * @return key<a name="line.258"></a> -<span class="sourceLineNo">259</span> */<a name="line.259"></a> -<span class="sourceLineNo">260</span> public WALKeyImpl getKey() {<a name="line.260"></a> -<span class="sourceLineNo">261</span> return key;<a name="line.261"></a> -<span class="sourceLineNo">262</span> }<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> /**<a name="line.264"></a> -<span class="sourceLineNo">265</span> * Set compression context for this entry.<a name="line.265"></a> -<span class="sourceLineNo">266</span> *<a name="line.266"></a> -<span class="sourceLineNo">267</span> * @param compressionContext<a name="line.267"></a> -<span class="sourceLineNo">268</span> * Compression context<a name="line.268"></a> -<span class="sourceLineNo">269</span> */<a name="line.269"></a> -<span class="sourceLineNo">270</span> public void setCompressionContext(CompressionContext compressionContext) {<a name="line.270"></a> -<span class="sourceLineNo">271</span> key.setCompressionContext(compressionContext);<a name="line.271"></a> -<span class="sourceLineNo">272</span> }<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> @Override<a name="line.274"></a> -<span class="sourceLineNo">275</span> public String toString() {<a name="line.275"></a> -<span class="sourceLineNo">276</span> return this.key + "=" + this.edit;<a name="line.276"></a> -<span class="sourceLineNo">277</span> }<a name="line.277"></a> -<span class="sourceLineNo">278</span> }<a name="line.278"></a> -<span class="sourceLineNo">279</span>}<a name="line.279"></a> +<span class="sourceLineNo">213</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.213"></a> +<span class="sourceLineNo">214</span> * @param encodedRegionName The region to get the number for.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * @param familyName The family to get the number for.<a name="line.215"></a> +<span class="sourceLineNo">216</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.216"></a> +<span class="sourceLineNo">217</span> */<a name="line.217"></a> +<span class="sourceLineNo">218</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * Human readable identifying information about the state of this WAL.<a name="line.221"></a> +<span class="sourceLineNo">222</span> * Implementors are encouraged to include information appropriate for debugging.<a name="line.222"></a> +<span class="sourceLineNo">223</span> * Consumers are advised not to rely on the details of the returned String; it does<a name="line.223"></a> +<span class="sourceLineNo">224</span> * not have a defined structure.<a name="line.224"></a> +<span class="sourceLineNo">225</span> */<a name="line.225"></a> +<span class="sourceLineNo">226</span> @Override<a name="line.226"></a> +<span class="sourceLineNo">227</span> String toString();<a name="line.227"></a> +<span class="sourceLineNo">228</span><a name="line.228"></a> +<span class="sourceLineNo">229</span> /**<a name="line.229"></a> +<span class="sourceLineNo">230</span> * When outside clients need to consume persisted WALs, they rely on a provided<a name="line.230"></a> +<span class="sourceLineNo">231</span> * Reader.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> interface Reader extends Closeable {<a name="line.233"></a> +<span class="sourceLineNo">234</span> Entry next() throws IOException;<a name="line.234"></a> +<span class="sourceLineNo">235</span> Entry next(Entry reuse) throws IOException;<a name="line.235"></a> +<span class="sourceLineNo">236</span> void seek(long pos) throws IOException;<a name="line.236"></a> +<span class="sourceLineNo">237</span> long getPosition() throws IOException;<a name="line.237"></a> +<span class="sourceLineNo">238</span> void reset() throws IOException;<a name="line.238"></a> +<span class="sourceLineNo">239</span> }<a name="line.239"></a> +<span class="sourceLineNo">240</span><a name="line.240"></a> +<span class="sourceLineNo">241</span> /**<a name="line.241"></a> +<span class="sourceLineNo">242</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.242"></a> +<span class="sourceLineNo">243</span> */<a name="line.243"></a> +<span class="sourceLineNo">244</span> class Entry {<a name="line.244"></a> +<span class="sourceLineNo">245</span> private final WALEdit edit;<a name="line.245"></a> +<span class="sourceLineNo">246</span> private final WALKeyImpl key;<a name="line.246"></a> +<span class="sourceLineNo">247</span><a name="line.247"></a> +<span class="sourceLineNo">248</span> public Entry() {<a name="line.248"></a> +<span class="sourceLineNo">249</span> this(new WALKeyImpl(), new WALEdit());<a name="line.249"></a> +<span class="sourceLineNo">250</span> }<a name="line.250"></a> +<span class="sourceLineNo">251</span><a name="line.251"></a> +<span class="sourceLineNo">252</span> /**<a name="line.252"></a> +<span class="sourceLineNo">253</span> * Constructor for both params<a name="line.253"></a> +<span class="sourceLineNo">254</span> *<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @param edit log's edit<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @param key log's key<a name="line.256"></a> +<span class="sourceLineNo">257</span> */<a name="line.257"></a> +<span class="sourceLineNo">258</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.258"></a> +<span class="sourceLineNo">259</span> this.key = key;<a name="line.259"></a> +<span class="sourceLineNo">260</span> this.edit = edit;<a name="line.260"></a> +<span class="sourceLineNo">261</span> }<a name="line.261"></a> +<span class="sourceLineNo">262</span><a name="line.262"></a> +<span class="sourceLineNo">263</span> /**<a name="line.263"></a> +<span class="sourceLineNo">264</span> * Gets the edit<a name="line.264"></a> +<span class="sourceLineNo">265</span> *<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return edit<a name="line.266"></a> +<span class="sourceLineNo">267</span> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> public WALEdit getEdit() {<a name="line.268"></a> +<span class="sourceLineNo">269</span> return edit;<a name="line.269"></a> +<span class="sourceLineNo">270</span> }<a name="line.270"></a> +<span class="sourceLineNo">271</span><a name="line.271"></a> +<span class="sourceLineNo">272</span> /**<a name="line.272"></a> +<span class="sourceLineNo">273</span> * Gets the key<a name="line.273"></a> +<span class="sourceLineNo">274</span> *<a name="line.274"></a> +<span class="sourceLineNo">275</span> * @return key<a name="line.275"></a> +<span class="sourceLineNo">276</span> */<a name="line.276"></a> +<span class="sourceLineNo">277</span> public WALKeyImpl getKey() {<a name="line.277"></a> +<span class="sourceLineNo">278</span> return key;<a name="line.278"></a> +<span class="sourceLineNo">279</span> }<a name="line.279"></a> +<span class="sourceLineNo">280</span><a name="line.280"></a> +<span class="sourceLineNo">281</span> /**<a name="line.281"></a> +<span class="sourceLineNo">282</span> * Set compression context for this entry.<a name="line.282"></a> +<span class="sourceLineNo">283</span> *<a name="line.283"></a> +<span class="sourceLineNo">284</span> * @param compressionContext<a name="line.284"></a> +<span class="sourceLineNo">285</span> * Compression context<a name="line.285"></a> +<span class="sourceLineNo">286</span> */<a name="line.286"></a> +<span class="sourceLineNo">287</span> public void setCompressionContext(CompressionContext compressionContext) {<a name="line.287"></a> +<span class="sourceLineNo">288</span> key.setCompressionContext(compressionContext);<a name="line.288"></a> +<span class="sourceLineNo">289</span> }<a name="line.289"></a> +<span class="sourceLineNo">290</span><a name="line.290"></a> +<span class="sourceLineNo">291</span> @Override<a name="line.291"></a> +<span class="sourceLineNo">292</span> public String toString() {<a name="line.292"></a> +<span class="sourceLineNo">293</span> return this.key + "=" + this.edit;<a name="line.293"></a> +<span class="sourceLineNo">294</span> }<a name="line.294"></a> +<span class="sourceLineNo">295</span> }<a name="line.295"></a> +<span class="sourceLineNo">296</span>}<a name="line.296"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.AsyncWriter.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.AsyncWriter.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.AsyncWriter.html index 4a4e386..6959ba69 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.AsyncWriter.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.AsyncWriter.html @@ -87,7 +87,7 @@ <span class="sourceLineNo">079</span> // Writers are used internally. Users outside of the WAL should be relying on the<a name="line.79"></a> <span class="sourceLineNo">080</span> // interface provided by WAL.<a name="line.80"></a> <span class="sourceLineNo">081</span> interface Writer extends WriterBase {<a name="line.81"></a> -<span class="sourceLineNo">082</span> void sync() throws IOException;<a name="line.82"></a> +<span class="sourceLineNo">082</span> void sync(boolean forceSync) throws IOException;<a name="line.82"></a> <span class="sourceLineNo">083</span><a name="line.83"></a> <span class="sourceLineNo">084</span> void append(WAL.Entry entry) throws IOException;<a name="line.84"></a> <span class="sourceLineNo">085</span> }<a name="line.85"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.Writer.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.Writer.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.Writer.html index 4a4e386..6959ba69 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.Writer.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.Writer.html @@ -87,7 +87,7 @@ <span class="sourceLineNo">079</span> // Writers are used internally. Users outside of the WAL should be relying on the<a name="line.79"></a> <span class="sourceLineNo">080</span> // interface provided by WAL.<a name="line.80"></a> <span class="sourceLineNo">081</span> interface Writer extends WriterBase {<a name="line.81"></a> -<span class="sourceLineNo">082</span> void sync() throws IOException;<a name="line.82"></a> +<span class="sourceLineNo">082</span> void sync(boolean forceSync) throws IOException;<a name="line.82"></a> <span class="sourceLineNo">083</span><a name="line.83"></a> <span class="sourceLineNo">084</span> void append(WAL.Entry entry) throws IOException;<a name="line.84"></a> <span class="sourceLineNo">085</span> }<a name="line.85"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.WriterBase.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.WriterBase.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.WriterBase.html index 4a4e386..6959ba69 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.WriterBase.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.WriterBase.html @@ -87,7 +87,7 @@ <span class="sourceLineNo">079</span> // Writers are used internally. Users outside of the WAL should be relying on the<a name="line.79"></a> <span class="sourceLineNo">080</span> // interface provided by WAL.<a name="line.80"></a> <span class="sourceLineNo">081</span> interface Writer extends WriterBase {<a name="line.81"></a> -<span class="sourceLineNo">082</span> void sync() throws IOException;<a name="line.82"></a> +<span class="sourceLineNo">082</span> void sync(boolean forceSync) throws IOException;<a name="line.82"></a> <span class="sourceLineNo">083</span><a name="line.83"></a> <span class="sourceLineNo">084</span> void append(WAL.Entry entry) throws IOException;<a name="line.84"></a> <span class="sourceLineNo">085</span> }<a name="line.85"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6eb695c8/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.html b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.html index 4a4e386..6959ba69 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/wal/WALProvider.html @@ -87,7 +87,7 @@ <span class="sourceLineNo">079</span> // Writers are used internally. Users outside of the WAL should be relying on the<a name="line.79"></a> <span class="sourceLineNo">080</span> // interface provided by WAL.<a name="line.80"></a> <span class="sourceLineNo">081</span> interface Writer extends WriterBase {<a name="line.81"></a> -<span class="sourceLineNo">082</span> void sync() throws IOException;<a name="line.82"></a> +<span class="sourceLineNo">082</span> void sync(boolean forceSync) throws IOException;<a name="line.82"></a> <span class="sourceLineNo">083</span><a name="line.83"></a> <span class="sourceLineNo">084</span> void append(WAL.Entry entry) throws IOException;<a name="line.84"></a> <span class="sourceLineNo">085</span> }<a name="line.85"></a>