| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.wal;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Closeable;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Set;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HConstants;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.regionserver.wal.FailedLogCloseException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.regionserver.wal.WALActionsListener;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.regionserver.wal.WALSyncTimeoutIOException;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.replication.regionserver.WALFileLengthProvider;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * A Write Ahead Log (WAL) provides service for reading, writing waledits. This interface provides<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * APIs for WAL users (such as RegionServer) to use the WAL (do append, sync, etc). Note that some<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * internals, such as log rolling and performance evaluation tools, will use WAL.equals to determine<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * if they have already seen a given WAL.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>@InterfaceAudience.Private<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>@InterfaceStability.Evolving<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>public interface WAL extends Closeable, WALFileLengthProvider {<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Registers WALActionsListener<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> */<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> void registerWALActionsListener(final WALActionsListener listener);<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Unregisters WALActionsListener<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> boolean unregisterWALActionsListener(final WALActionsListener listener);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> /**<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * Roll the log writer. That is, start writing log messages to a new file.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <p/><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * The implementation is synchronized in order to make sure there's one rollWriter running at any<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * given time.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @return If lots of logs, flush the stores of returned regions so next time through we can clean<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * logs. Returns null if nothing to flush. Names are actual region names as returned by<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * {@link RegionInfo#getEncodedName()}<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Map<byte[], List<byte[]>> rollWriter() throws FailedLogCloseException, IOException;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Roll the log writer. That is, start writing log messages to a new file.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <p/><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * The implementation is synchronized in order to make sure there's one rollWriter running at any<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * given time. n * If true, force creation of a new writer even if no entries have been written to<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * the current writer<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @return If lots of logs, flush the stores of returned regions so next time through we can clean<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * logs. Returns null if nothing to flush. Names are actual region names as returned by<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * {@link RegionInfo#getEncodedName()}<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> Map<byte[], List<byte[]>> rollWriter(boolean force) throws IOException;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Stop accepting new writes. If we have unsynced writes still in buffer, sync them. Extant edits<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * are left in place in backing storage to be replayed later.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> void shutdown() throws IOException;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Caller no longer needs any edits from this WAL. Implementers are free to reclaim underlying<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * resources after this call; i.e. filesystem based WALs can archive or delete files.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> @Override<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> void close() throws IOException;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Append a set of data edits to the WAL. 'Data' here means that the content in the edits will<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * also have transitioned through the memstore.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <p/><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * The WAL is not flushed/sync'd after this transaction completes BUT on return this edit must<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * have its region edit/sequence id assigned else it messes up our unification of mvcc and<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * sequenceid. On return <code>key</code> will have the region edit/sequence id filled in.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param info the regioninfo associated with append<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param key Modified by this call; we add to it this edits region edit/sequence id.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param edits Edits to append. MAY CONTAIN NO EDITS for case where we want to get an edit<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * sequence id that is after all currently appended edits.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @return Returns a 'transaction id' and <code>key</code> will have the region edit/sequence id<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * in it.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @see #appendMarker(RegionInfo, WALKeyImpl, WALEdit)<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> long appendData(RegionInfo info, WALKeyImpl key, WALEdit edits) throws IOException;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Append an operational 'meta' event marker edit to the WAL. A marker meta edit could be a<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * FlushDescriptor, a compaction marker, or a region event marker; e.g. region open or region<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * close. The difference between a 'marker' append and a 'data' append as in<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * {@link #appendData(RegionInfo, WALKeyImpl, WALEdit)}is that a marker will not have transitioned<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * through the memstore.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <p/><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * The WAL is not flushed/sync'd after this transaction completes BUT on return this edit must<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * have its region edit/sequence id assigned else it messes up our unification of mvcc and<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * sequenceid. On return <code>key</code> will have the region edit/sequence id filled in.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param info the regioninfo associated with append<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param key Modified by this call; we add to it this edits region edit/sequence id.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param edits Edits to append. MAY CONTAIN NO EDITS for case where we want to get an edit<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * sequence id that is after all currently appended edits.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @return Returns a 'transaction id' and <code>key</code> will have the region edit/sequence id<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * in it.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @see #appendData(RegionInfo, WALKeyImpl, WALEdit)<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> long appendMarker(RegionInfo info, WALKeyImpl key, WALEdit edits) throws IOException;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> /**<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * updates the seuence number of a specific store. depending on the flag: replaces current seq<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * number if the given seq id is bigger, or even if it is lower than existing one<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> void updateStore(byte[] encodedRegionName, byte[] familyName, Long sequenceid,<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> boolean onlyIfGreater);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Sync what we have in the WAL.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> void sync() throws IOException;<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> /**<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * Sync the WAL if the txId was not already sync'd.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param txid Transaction id to sync to.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> */<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> void sync(long txid) throws IOException;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> /**<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * vs hsync.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> default void sync(boolean forceSync) throws IOException {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> sync();<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> /**<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param txid Transaction id to sync to.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @param forceSync Flag to force sync rather than flushing to the buffer. Example - Hadoop hflush<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * vs hsync.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @throws when timeout, it would throw {@link WALSyncTimeoutIOException}.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> */<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> default void sync(long txid, boolean forceSync) throws IOException {<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> sync(txid);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * WAL keeps track of the sequence numbers that are as yet not flushed im memstores in order to be<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * able to do accounting to figure which WALs can be let go. This method tells WAL that some<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * region is about to flush. The flush can be the whole region or for a column family of the<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * region only.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * <p><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * Currently, it is expected that the update lock is held for the region; i.e. no concurrent<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * appends while we set up cache flush.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @param families Families to flush. May be a subset of all families in the region.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @return Returns {@link HConstants#NO_SEQNUM} if we are flushing the whole region OR if we are<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * flushing a subset of all families but there are no edits in those families not being<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * flushed; in other words, this is effectively same as a flush of all of the region<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * though we were passed a subset of regions. Otherwise, it returns the sequence id of the<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * oldest/lowest outstanding edit.<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @see #completeCacheFlush(byte[], long)<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @see #abortCacheFlush(byte[])<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> Long startCacheFlush(final byte[] encodedRegionName, Set<byte[]> families);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> Long startCacheFlush(final byte[] encodedRegionName, Map<byte[], Long> familyToSeq);<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> * Complete the cache flush.<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @param encodedRegionName Encoded region name.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param maxFlushedSeqId The maxFlushedSeqId for this flush. There is no edit in memory that is<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * less that this sequence id.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @see #startCacheFlush(byte[], Set)<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @see #abortCacheFlush(byte[])<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> */<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> void completeCacheFlush(final byte[] encodedRegionName, long maxFlushedSeqId);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> /**<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * Abort a cache flush. Call if the flush fails. Note that the only recovery for an aborted flush<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * currently is a restart of the regionserver so the snapshot content dropped by the failure gets<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * restored to the memstore.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param encodedRegionName Encoded region name.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> void abortCacheFlush(byte[] encodedRegionName);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> /** Returns Coprocessor host. */<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> WALCoprocessorHost getCoprocessorHost();<a name="line.207"></a> |
| <span class="sourceLineNo">208</span><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> /**<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * Gets the earliest unflushed sequence id in the memstore for the region.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @param encodedRegionName The region to get the number for.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * @deprecated Since version 1.2.0. Removing because not used and exposes subtle internal<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * workings. Use {@link #getEarliestMemStoreSeqNum(byte[], byte[])}<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> */<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> @Deprecated<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> /**<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * Gets the earliest unflushed sequence id in the memstore for the store.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @param encodedRegionName The region to get the number for.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @param familyName The family to get the number for.<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @return The earliest/lowest/oldest sequence id if present, HConstants.NO_SEQNUM if absent.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> */<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> long getEarliestMemStoreSeqNum(byte[] encodedRegionName, byte[] familyName);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span><a name="line.226"></a> |
| <span class="sourceLineNo">227</span> /**<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * Human readable identifying information about the state of this WAL. Implementors are encouraged<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * to include information appropriate for debugging. Consumers are advised not to rely on the<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * details of the returned String; it does not have a defined structure.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> */<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> @Override<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> String toString();<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> * When outside clients need to consume persisted WALs, they rely on a provided Reader.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> */<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> interface Reader extends Closeable {<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> Entry next() throws IOException;<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> Entry next(Entry reuse) throws IOException;<a name="line.241"></a> |
| <span class="sourceLineNo">242</span><a name="line.242"></a> |
| <span class="sourceLineNo">243</span> void seek(long pos) throws IOException;<a name="line.243"></a> |
| <span class="sourceLineNo">244</span><a name="line.244"></a> |
| <span class="sourceLineNo">245</span> long getPosition() throws IOException;<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> void reset() throws IOException;<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> }<a name="line.248"></a> |
| <span class="sourceLineNo">249</span><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> /**<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * Utility class that lets us keep track of the edit with it's key.<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> class Entry {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> private final WALEdit edit;<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> private final WALKeyImpl key;<a name="line.255"></a> |
| <span class="sourceLineNo">256</span><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> public Entry() {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> this(new WALKeyImpl(), new WALEdit());<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> /**<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Constructor for both params<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * @param edit log's edit<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * @param key log's key<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> */<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> public Entry(WALKeyImpl key, WALEdit edit) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> this.key = key;<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> this.edit = edit;<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> }<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> * Gets the edit n<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> */<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> public WALEdit getEdit() {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> return edit;<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<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> * Gets the key n<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> */<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public WALKeyImpl getKey() {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> return key;<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> }<a name="line.283"></a> |
| <span class="sourceLineNo">284</span><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> @Override<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> public String toString() {<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> return this.key + "=" + this.edit;<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> }<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
