blob: 65029d6045bd59277b6dd1e977837d3620149790 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.mob, class: MobFileName">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.mob;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import org.apache.hadoop.hbase.util.MD5Hash;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">/**</span>
<span class="source-line-no">024</span><span id="line-24"> * The mob file name. It consists of a md5 of a start key, a date, uuid and encoded region name. It</span>
<span class="source-line-no">025</span><span id="line-25"> * looks like md5(start) + date + uuid+ "_" + encoded region name.</span>
<span class="source-line-no">026</span><span id="line-26"> * &lt;ol&gt;</span>
<span class="source-line-no">027</span><span id="line-27"> * &lt;li&gt;characters 0-31: md5 hex string of a start key. Since the length of the start key is not</span>
<span class="source-line-no">028</span><span id="line-28"> * fixed, have to use the md5 instead which has a fix length.&lt;/li&gt;</span>
<span class="source-line-no">029</span><span id="line-29"> * &lt;li&gt;characters 32-39: a string of a date with format yyyymmdd. The date is the latest timestamp</span>
<span class="source-line-no">030</span><span id="line-30"> * of cells in this file&lt;/li&gt;</span>
<span class="source-line-no">031</span><span id="line-31"> * &lt;li&gt;the remaining characters: the uuid.&lt;/li&gt;</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;/ol&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * Using md5 hex string of start key as the prefix of file name makes files with the same start key</span>
<span class="source-line-no">034</span><span id="line-34"> * unique, they're different from the ones with other start keys The cells come from different</span>
<span class="source-line-no">035</span><span id="line-35"> * regions might be in the same mob file by region split, this is allowed. Has the latest timestamp</span>
<span class="source-line-no">036</span><span id="line-36"> * of cells in the file name in order to clean the expired mob files by TTL easily. If this</span>
<span class="source-line-no">037</span><span id="line-37"> * timestamp is older than the TTL, it's regarded as expired.</span>
<span class="source-line-no">038</span><span id="line-38"> */</span>
<span class="source-line-no">039</span><span id="line-39">@InterfaceAudience.Private</span>
<span class="source-line-no">040</span><span id="line-40">public final class MobFileName {</span>
<span class="source-line-no">041</span><span id="line-41"> private final String date;</span>
<span class="source-line-no">042</span><span id="line-42"> private final String startKey;</span>
<span class="source-line-no">043</span><span id="line-43"> private final String uuid;</span>
<span class="source-line-no">044</span><span id="line-44"> private final String fileName;</span>
<span class="source-line-no">045</span><span id="line-45"> // Name of a region this MOB file belongs to</span>
<span class="source-line-no">046</span><span id="line-46"> private final String regionName;</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> private static final int STARTKEY_END_INDEX = 32;</span>
<span class="source-line-no">049</span><span id="line-49"> private static final int DATE_END_INDEX = 40;</span>
<span class="source-line-no">050</span><span id="line-50"> private static final int UUID_END_INDEX = 72;</span>
<span class="source-line-no">051</span><span id="line-51"> public static final String REGION_SEP = "_";</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> /**</span>
<span class="source-line-no">054</span><span id="line-54"> * Creates an instance of MobFileName</span>
<span class="source-line-no">055</span><span id="line-55"> * @param startKey The start key.</span>
<span class="source-line-no">056</span><span id="line-56"> * @param date The string of the latest timestamp of cells in this file, the format is</span>
<span class="source-line-no">057</span><span id="line-57"> * yyyymmdd.</span>
<span class="source-line-no">058</span><span id="line-58"> * @param uuid The uuid</span>
<span class="source-line-no">059</span><span id="line-59"> * @param regionName name of a region, where this file was created during flush or compaction.</span>
<span class="source-line-no">060</span><span id="line-60"> */</span>
<span class="source-line-no">061</span><span id="line-61"> private MobFileName(byte[] startKey, String date, String uuid, String regionName) {</span>
<span class="source-line-no">062</span><span id="line-62"> this.startKey = MD5Hash.getMD5AsHex(startKey, 0, startKey.length);</span>
<span class="source-line-no">063</span><span id="line-63"> this.uuid = uuid;</span>
<span class="source-line-no">064</span><span id="line-64"> this.date = date;</span>
<span class="source-line-no">065</span><span id="line-65"> this.regionName = regionName;</span>
<span class="source-line-no">066</span><span id="line-66"> this.fileName = this.startKey + this.date + this.uuid + REGION_SEP + this.regionName;</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> /**</span>
<span class="source-line-no">070</span><span id="line-70"> * Creates an instance of MobFileName</span>
<span class="source-line-no">071</span><span id="line-71"> * @param startKey The md5 hex string of the start key.</span>
<span class="source-line-no">072</span><span id="line-72"> * @param date The string of the latest timestamp of cells in this file, the format is</span>
<span class="source-line-no">073</span><span id="line-73"> * yyyymmdd.</span>
<span class="source-line-no">074</span><span id="line-74"> * @param uuid The uuid</span>
<span class="source-line-no">075</span><span id="line-75"> * @param regionName name of a region, where this file was created during flush or compaction.</span>
<span class="source-line-no">076</span><span id="line-76"> */</span>
<span class="source-line-no">077</span><span id="line-77"> private MobFileName(String startKey, String date, String uuid, String regionName) {</span>
<span class="source-line-no">078</span><span id="line-78"> this.startKey = startKey;</span>
<span class="source-line-no">079</span><span id="line-79"> this.uuid = uuid;</span>
<span class="source-line-no">080</span><span id="line-80"> this.date = date;</span>
<span class="source-line-no">081</span><span id="line-81"> this.regionName = regionName;</span>
<span class="source-line-no">082</span><span id="line-82"> this.fileName = this.startKey + this.date + this.uuid + REGION_SEP + this.regionName;</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> /**</span>
<span class="source-line-no">086</span><span id="line-86"> * Creates an instance of MobFileName</span>
<span class="source-line-no">087</span><span id="line-87"> * @param startKey The md5 hex string of the start key.</span>
<span class="source-line-no">088</span><span id="line-88"> * @param date The string of the latest timestamp of cells in this file, the format is</span>
<span class="source-line-no">089</span><span id="line-89"> * yyyymmdd.</span>
<span class="source-line-no">090</span><span id="line-90"> * @param uuid The uuid.</span>
<span class="source-line-no">091</span><span id="line-91"> * @param regionName name of a region, where this file was created during flush or compaction.</span>
<span class="source-line-no">092</span><span id="line-92"> * @return An instance of a MobFileName.</span>
<span class="source-line-no">093</span><span id="line-93"> */</span>
<span class="source-line-no">094</span><span id="line-94"> public static MobFileName create(byte[] startKey, String date, String uuid, String regionName) {</span>
<span class="source-line-no">095</span><span id="line-95"> return new MobFileName(startKey, date, uuid, regionName);</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> /**</span>
<span class="source-line-no">099</span><span id="line-99"> * Creates an instance of MobFileName</span>
<span class="source-line-no">100</span><span id="line-100"> * @param startKey The md5 hex string of the start key.</span>
<span class="source-line-no">101</span><span id="line-101"> * @param date The string of the latest timestamp of cells in this file, the format is</span>
<span class="source-line-no">102</span><span id="line-102"> * yyyymmdd.</span>
<span class="source-line-no">103</span><span id="line-103"> * @param uuid The uuid.</span>
<span class="source-line-no">104</span><span id="line-104"> * @param regionName name of a region, where this file was created during flush or compaction.</span>
<span class="source-line-no">105</span><span id="line-105"> * @return An instance of a MobFileName.</span>
<span class="source-line-no">106</span><span id="line-106"> */</span>
<span class="source-line-no">107</span><span id="line-107"> public static MobFileName create(String startKey, String date, String uuid, String regionName) {</span>
<span class="source-line-no">108</span><span id="line-108"> return new MobFileName(startKey, date, uuid, regionName);</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> /**</span>
<span class="source-line-no">112</span><span id="line-112"> * Creates an instance of MobFileName.</span>
<span class="source-line-no">113</span><span id="line-113"> * @param fileName The string format of a file name.</span>
<span class="source-line-no">114</span><span id="line-114"> * @return An instance of a MobFileName.</span>
<span class="source-line-no">115</span><span id="line-115"> */</span>
<span class="source-line-no">116</span><span id="line-116"> public static MobFileName create(String fileName) {</span>
<span class="source-line-no">117</span><span id="line-117"> // The format of a file name is md5HexString(0-31bytes) + date(32-39bytes) + UUID</span>
<span class="source-line-no">118</span><span id="line-118"> // + "_" + region</span>
<span class="source-line-no">119</span><span id="line-119"> // The date format is yyyyMMdd</span>
<span class="source-line-no">120</span><span id="line-120"> String startKey = fileName.substring(0, STARTKEY_END_INDEX);</span>
<span class="source-line-no">121</span><span id="line-121"> String date = fileName.substring(STARTKEY_END_INDEX, DATE_END_INDEX);</span>
<span class="source-line-no">122</span><span id="line-122"> String uuid = fileName.substring(DATE_END_INDEX, UUID_END_INDEX);</span>
<span class="source-line-no">123</span><span id="line-123"> String regionName = fileName.substring(UUID_END_INDEX + 1);</span>
<span class="source-line-no">124</span><span id="line-124"> return new MobFileName(startKey, date, uuid, regionName);</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"></span>
<span class="source-line-no">127</span><span id="line-127"> public static boolean isOldMobFileName(String name) {</span>
<span class="source-line-no">128</span><span id="line-128"> return name.indexOf(REGION_SEP) &lt; 0;</span>
<span class="source-line-no">129</span><span id="line-129"> }</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> /**</span>
<span class="source-line-no">132</span><span id="line-132"> * get startKey from MobFileName.</span>
<span class="source-line-no">133</span><span id="line-133"> * @param fileName file name.</span>
<span class="source-line-no">134</span><span id="line-134"> */</span>
<span class="source-line-no">135</span><span id="line-135"> public static String getStartKeyFromName(final String fileName) {</span>
<span class="source-line-no">136</span><span id="line-136"> return fileName.substring(0, STARTKEY_END_INDEX);</span>
<span class="source-line-no">137</span><span id="line-137"> }</span>
<span class="source-line-no">138</span><span id="line-138"></span>
<span class="source-line-no">139</span><span id="line-139"> /**</span>
<span class="source-line-no">140</span><span id="line-140"> * get date from MobFileName.</span>
<span class="source-line-no">141</span><span id="line-141"> * @param fileName file name.</span>
<span class="source-line-no">142</span><span id="line-142"> */</span>
<span class="source-line-no">143</span><span id="line-143"> public static String getDateFromName(final String fileName) {</span>
<span class="source-line-no">144</span><span id="line-144"> return fileName.substring(STARTKEY_END_INDEX, DATE_END_INDEX);</span>
<span class="source-line-no">145</span><span id="line-145"> }</span>
<span class="source-line-no">146</span><span id="line-146"></span>
<span class="source-line-no">147</span><span id="line-147"> /**</span>
<span class="source-line-no">148</span><span id="line-148"> * Gets the hex string of the md5 for a start key.</span>
<span class="source-line-no">149</span><span id="line-149"> * @return The hex string of the md5 for a start key.</span>
<span class="source-line-no">150</span><span id="line-150"> */</span>
<span class="source-line-no">151</span><span id="line-151"> public String getStartKey() {</span>
<span class="source-line-no">152</span><span id="line-152"> return startKey;</span>
<span class="source-line-no">153</span><span id="line-153"> }</span>
<span class="source-line-no">154</span><span id="line-154"></span>
<span class="source-line-no">155</span><span id="line-155"> /**</span>
<span class="source-line-no">156</span><span id="line-156"> * Gets region name</span>
<span class="source-line-no">157</span><span id="line-157"> * @return name of a region, where this file was created during flush or compaction.</span>
<span class="source-line-no">158</span><span id="line-158"> */</span>
<span class="source-line-no">159</span><span id="line-159"> public String getRegionName() {</span>
<span class="source-line-no">160</span><span id="line-160"> return regionName;</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> /**</span>
<span class="source-line-no">164</span><span id="line-164"> * Gets the date string. Its format is yyyymmdd.</span>
<span class="source-line-no">165</span><span id="line-165"> * @return The date string.</span>
<span class="source-line-no">166</span><span id="line-166"> */</span>
<span class="source-line-no">167</span><span id="line-167"> public String getDate() {</span>
<span class="source-line-no">168</span><span id="line-168"> return this.date;</span>
<span class="source-line-no">169</span><span id="line-169"> }</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> @Override</span>
<span class="source-line-no">172</span><span id="line-172"> public int hashCode() {</span>
<span class="source-line-no">173</span><span id="line-173"> return fileName.hashCode();</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> @Override</span>
<span class="source-line-no">177</span><span id="line-177"> public boolean equals(Object anObject) {</span>
<span class="source-line-no">178</span><span id="line-178"> if (this == anObject) {</span>
<span class="source-line-no">179</span><span id="line-179"> return true;</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"> if (anObject instanceof MobFileName) {</span>
<span class="source-line-no">182</span><span id="line-182"> MobFileName another = (MobFileName) anObject;</span>
<span class="source-line-no">183</span><span id="line-183"> return this.getFileName().equals(another.getFileName());</span>
<span class="source-line-no">184</span><span id="line-184"> }</span>
<span class="source-line-no">185</span><span id="line-185"> return false;</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> /**</span>
<span class="source-line-no">189</span><span id="line-189"> * Gets the file name.</span>
<span class="source-line-no">190</span><span id="line-190"> * @return The file name.</span>
<span class="source-line-no">191</span><span id="line-191"> */</span>
<span class="source-line-no">192</span><span id="line-192"> public String getFileName() {</span>
<span class="source-line-no">193</span><span id="line-193"> return this.fileName;</span>
<span class="source-line-no">194</span><span id="line-194"> }</span>
<span class="source-line-no">195</span><span id="line-195">}</span>
</pre>
</div>
</main>
</body>
</html>