blob: 3051cceb51b1fc420ef58eacb8feb6c7f5ba0ac9 [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, interface: TableDescriptors">
<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;</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 java.io.Closeable;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.client.TableDescriptor;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">025</span><span id="line-25"></span>
<span class="source-line-no">026</span><span id="line-26">/**</span>
<span class="source-line-no">027</span><span id="line-27"> * Get, remove and modify table descriptors.</span>
<span class="source-line-no">028</span><span id="line-28"> */</span>
<span class="source-line-no">029</span><span id="line-29">@InterfaceAudience.Private</span>
<span class="source-line-no">030</span><span id="line-30">public interface TableDescriptors extends Closeable {</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32"> /**</span>
<span class="source-line-no">033</span><span id="line-33"> * Test whether a given table exists, i.e, has a table descriptor.</span>
<span class="source-line-no">034</span><span id="line-34"> */</span>
<span class="source-line-no">035</span><span id="line-35"> default boolean exists(TableName tableName) throws IOException {</span>
<span class="source-line-no">036</span><span id="line-36"> return get(tableName) != null;</span>
<span class="source-line-no">037</span><span id="line-37"> }</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> @Override</span>
<span class="source-line-no">040</span><span id="line-40"> default void close() throws IOException {</span>
<span class="source-line-no">041</span><span id="line-41"> // do nothing by default</span>
<span class="source-line-no">042</span><span id="line-42"> }</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> /** Returns TableDescriptor for tablename */</span>
<span class="source-line-no">045</span><span id="line-45"> TableDescriptor get(TableName tableName) throws IOException;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> /**</span>
<span class="source-line-no">048</span><span id="line-48"> * Get Map of all NamespaceDescriptors for a given namespace.</span>
<span class="source-line-no">049</span><span id="line-49"> * @return Map of all descriptors.</span>
<span class="source-line-no">050</span><span id="line-50"> */</span>
<span class="source-line-no">051</span><span id="line-51"> Map&lt;String, TableDescriptor&gt; getByNamespace(String name) throws IOException;</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"> * Get Map of all TableDescriptors. Populates the descriptor cache as a side effect.</span>
<span class="source-line-no">055</span><span id="line-55"> * &lt;/p&gt;</span>
<span class="source-line-no">056</span><span id="line-56"> * Notice: the key of map is the table name which contains namespace. It was generated by</span>
<span class="source-line-no">057</span><span id="line-57"> * {@link TableName#getNameWithNamespaceInclAsString()}.</span>
<span class="source-line-no">058</span><span id="line-58"> * @return Map of all descriptors.</span>
<span class="source-line-no">059</span><span id="line-59"> */</span>
<span class="source-line-no">060</span><span id="line-60"> Map&lt;String, TableDescriptor&gt; getAll() throws IOException;</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> /**</span>
<span class="source-line-no">063</span><span id="line-63"> * Add or update descriptor. Just call {@link #update(TableDescriptor, boolean)} with</span>
<span class="source-line-no">064</span><span id="line-64"> * {@code cacheOnly} as {@code false}.</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66"> default void update(TableDescriptor htd) throws IOException {</span>
<span class="source-line-no">067</span><span id="line-67"> update(htd, false);</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"> /**</span>
<span class="source-line-no">071</span><span id="line-71"> * Add or update descriptor</span>
<span class="source-line-no">072</span><span id="line-72"> * @param htd Descriptor to set into TableDescriptors</span>
<span class="source-line-no">073</span><span id="line-73"> * @param cacheOnly only add the given {@code htd} to cache, without updating the storage. For</span>
<span class="source-line-no">074</span><span id="line-74"> * example, when creating table, we will write the descriptor to fs when creating</span>
<span class="source-line-no">075</span><span id="line-75"> * the fs layout, so we do not need to update the fs again.</span>
<span class="source-line-no">076</span><span id="line-76"> */</span>
<span class="source-line-no">077</span><span id="line-77"> void update(TableDescriptor htd, boolean cacheOnly) throws IOException;</span>
<span class="source-line-no">078</span><span id="line-78"></span>
<span class="source-line-no">079</span><span id="line-79"> /** Returns Instance of table descriptor or null if none found. */</span>
<span class="source-line-no">080</span><span id="line-80"> TableDescriptor remove(TableName tablename) throws IOException;</span>
<span class="source-line-no">081</span><span id="line-81">}</span>
</pre>
</div>
</main>
</body>
</html>