| <!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.regionserver;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.Cell;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.exceptions.UnexpectedStateException;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * The MemStore holds in-memory modifications to the Store. Modifications are {@link Cell}s.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <p><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * The MemStore functions should not be called in parallel. Callers should hold write and read<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * locks. This is done in {@link HStore}.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * </p><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>@InterfaceAudience.Private<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>public interface MemStore {<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> /**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Creates a snapshot of the current memstore. Snapshot must be cleared by call to<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * {@link #clearSnapshot(long)}.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @return {@link MemStoreSnapshot}<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> MemStoreSnapshot snapshot();<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Clears the current snapshot of the Memstore.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @param id<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @throws UnexpectedStateException<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @see #snapshot()<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> void clearSnapshot(long id) throws UnexpectedStateException;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Flush will first clear out the data in snapshot if any (It will take a second flush<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * invocation to clear the current Cell set). If snapshot is empty, current<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Cell set will be flushed.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @return On flush, how much memory we will clear.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> MemStoreSize getFlushableSize();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Return the size of the snapshot(s) if any<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @return size of the memstore snapshot<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> MemStoreSize getSnapshotSize();<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * Write an update<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param cell<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param memstoreSizing The delta in memstore size will be passed back via this.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * This will include both data size and heap overhead delta.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> void add(final Cell cell, MemStoreSizing memstoreSizing);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Write the updates<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @param cells<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param memstoreSizing The delta in memstore size will be passed back via this.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * This will include both data size and heap overhead delta.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> void add(Iterable<Cell> cells, MemStoreSizing memstoreSizing);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @return Oldest timestamp of all the Cells in the MemStore<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> long timeOfOldestEdit();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Update or insert the specified cells.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <p><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * For each Cell, insert into MemStore. This will atomically upsert the value for that<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * row/family/qualifier. If a Cell did already exist, it will then be removed.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <p><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * Currently the memstoreTS is kept at 0 so as each insert happens, it will be immediately<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * visible. May want to change this so it is atomic across all KeyValues.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * <p><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * This is called under row lock, so Get operations will still see updates atomically. Scans will<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * only see each KeyValue update as atomic.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param cells<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param readpoint readpoint below which we can safely remove duplicate Cells.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param memstoreSizing The delta in memstore size will be passed back via this.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * This will include both data size and heap overhead delta.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> void upsert(Iterable<Cell> cells, long readpoint, MemStoreSizing memstoreSizing);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return scanner over the memstore. This might include scanner over the snapshot when one is<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * present.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> List<KeyValueScanner> getScanners(long readPt) throws IOException;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> /**<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @return Total memory occupied by this MemStore. This won't include any size occupied by the<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * snapshot. We assume the snapshot will get cleared soon. This is not thread safe and<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * the memstore may be changed while computing its size. It is the responsibility of the<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * caller to make sure this doesn't happen.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> MemStoreSize size();<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * This method is called before the flush is executed.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @return an estimation (lower bound) of the unflushed sequence id in memstore after the flush<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * is executed. if memstore will be cleared returns {@code HConstants.NO_SEQNUM}.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> long preFlushSeqIDEstimation();<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /* Return true if the memstore may use some extra memory space*/<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> boolean isSloppy();<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * This message intends to inform the MemStore that next coming updates<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * are going to be part of the replaying edits from WAL<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> */<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> default void startReplayingFromWAL(){return;}<a name="line.134"></a> |
| <span class="sourceLineNo">135</span><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> /**<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * This message intends to inform the MemStore that the replaying edits from WAL<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * are done<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> default void stopReplayingFromWAL(){return;}<a name="line.140"></a> |
| <span class="sourceLineNo">141</span>}<a name="line.141"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |