| <!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.master, interface: ClusterSchema"> |
| <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.master;</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.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.NamespaceDescriptor;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ServiceNotRunningException;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.master.procedure.ProcedurePrepareLatch;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.NonceKey;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * View and edit the current cluster schema. Use this API making any modification to namespaces,</span> |
| <span class="source-line-no">030</span><span id="line-30"> * tables, etc.</span> |
| <span class="source-line-no">031</span><span id="line-31"> * <h2>Implementation Notes</h2> Nonces are for when operation is non-idempotent to ensure once-only</span> |
| <span class="source-line-no">032</span><span id="line-32"> * semantic, even across process failures.</span> |
| <span class="source-line-no">033</span><span id="line-33"> */</span> |
| <span class="source-line-no">034</span><span id="line-34">// ClusterSchema is introduced to encapsulate schema modification. Currently the different aspects</span> |
| <span class="source-line-no">035</span><span id="line-35">// are spread about the code base. This effort is about cleanup, shutting down access, and</span> |
| <span class="source-line-no">036</span><span id="line-36">// coalescing common code. In particular, we'd contain filesystem modification. Other</span> |
| <span class="source-line-no">037</span><span id="line-37">// benefits are to make all schema modification work the same way (one way to do an operation only</span> |
| <span class="source-line-no">038</span><span id="line-38">// rather than the current approach where how an operation is done varies with context) and to make</span> |
| <span class="source-line-no">039</span><span id="line-39">// it so clusterschema modification can stand apart from Master to faciliate standalone</span> |
| <span class="source-line-no">040</span><span id="line-40">// testing. It is part of the filesystem refactor project that undoes the dependency on a</span> |
| <span class="source-line-no">041</span><span id="line-41">// layout in HDFS that mimics our model of tables have regions have column families have files.</span> |
| <span class="source-line-no">042</span><span id="line-42">// With this Interface in place, with all modifications going via this route where no filesystem</span> |
| <span class="source-line-no">043</span><span id="line-43">// particulars are exposed, redoing our internals will take less effort.</span> |
| <span class="source-line-no">044</span><span id="line-44">//</span> |
| <span class="source-line-no">045</span><span id="line-45">// Currently ClusterSchema Interface will include namespace and table manipulation. Ideally a</span> |
| <span class="source-line-no">046</span><span id="line-46">// form of this Interface will go all the ways down to the file manipulation level but currently</span> |
| <span class="source-line-no">047</span><span id="line-47">// TBD.</span> |
| <span class="source-line-no">048</span><span id="line-48">//</span> |
| <span class="source-line-no">049</span><span id="line-49">// ClusterSchema is private to the Master; only the Master knows current cluster state and has</span> |
| <span class="source-line-no">050</span><span id="line-50">// means of editing/altering it.</span> |
| <span class="source-line-no">051</span><span id="line-51">//</span> |
| <span class="source-line-no">052</span><span id="line-52">// TODO: Remove Server argument when MasterServices are passed.</span> |
| <span class="source-line-no">053</span><span id="line-53">// TODO: We return Future<ProcedureInfo> in the below from most methods. It may change to return</span> |
| <span class="source-line-no">054</span><span id="line-54">// a ProcedureFuture subsequently.</span> |
| <span class="source-line-no">055</span><span id="line-55">@InterfaceAudience.Private</span> |
| <span class="source-line-no">056</span><span id="line-56">public interface ClusterSchema {</span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * Timeout for cluster operations in milliseconds.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> public static final String HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT_KEY =</span> |
| <span class="source-line-no">061</span><span id="line-61"> "hbase.master.cluster.schema.operation.timeout";</span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Default operation timeout in milliseconds.</span> |
| <span class="source-line-no">064</span><span id="line-64"> */</span> |
| <span class="source-line-no">065</span><span id="line-65"> public static final int DEFAULT_HBASE_MASTER_CLUSTER_SCHEMA_OPERATION_TIMEOUT = 5 * 60 * 1000;</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> /**</span> |
| <span class="source-line-no">068</span><span id="line-68"> * For internals use only. Do not use! Provisionally part of this Interface. Prefer the high-level</span> |
| <span class="source-line-no">069</span><span id="line-69"> * APIs available elsewhere in this API.</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @return Instance of {@link TableNamespaceManager}</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> // TODO: Remove from here. Keep internal. This Interface is too high-level to host this accessor.</span> |
| <span class="source-line-no">073</span><span id="line-73"> TableNamespaceManager getTableNamespaceManager();</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * Create a new Namespace.</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param namespaceDescriptor descriptor for new Namespace</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @param nonceKey A unique identifier for this operation from the client or process.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param latch A latch to block on for precondition validation</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @return procedure id</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @throws IOException if service is not running see {@link ServiceNotRunningException}</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> long createNamespace(NamespaceDescriptor namespaceDescriptor, NonceKey nonceKey,</span> |
| <span class="source-line-no">084</span><span id="line-84"> ProcedurePrepareLatch latch) throws IOException;</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Modify an existing Namespace.</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @param nonceKey A unique identifier for this operation from the client or process.</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param latch A latch to block on for precondition validation</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @return procedure id</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @throws IOException if service is not running see {@link ServiceNotRunningException}</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> long modifyNamespace(NamespaceDescriptor descriptor, NonceKey nonceKey,</span> |
| <span class="source-line-no">094</span><span id="line-94"> ProcedurePrepareLatch latch) throws IOException;</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Delete an existing Namespace. Only empty Namespaces (no tables) can be removed.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @param nonceKey A unique identifier for this operation from the client or process.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @param latch A latch to block on for precondition validation</span> |
| <span class="source-line-no">100</span><span id="line-100"> * @return procedure id</span> |
| <span class="source-line-no">101</span><span id="line-101"> * @throws IOException if service is not running see {@link ServiceNotRunningException}</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> long deleteNamespace(String name, NonceKey nonceKey, ProcedurePrepareLatch latch)</span> |
| <span class="source-line-no">104</span><span id="line-104"> throws IOException;</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> /**</span> |
| <span class="source-line-no">107</span><span id="line-107"> * Get a Namespace</span> |
| <span class="source-line-no">108</span><span id="line-108"> * @param name Name of the Namespace</span> |
| <span class="source-line-no">109</span><span id="line-109"> * @return Namespace descriptor for <code>name</code></span> |
| <span class="source-line-no">110</span><span id="line-110"> * @throws IOException if namespace does not exist</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> // No Future here because presumption is that the request will go against cached metadata so</span> |
| <span class="source-line-no">113</span><span id="line-113"> // return immediately -- no need of running a Procedure.</span> |
| <span class="source-line-no">114</span><span id="line-114"> NamespaceDescriptor getNamespace(String name) throws IOException;</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> /**</span> |
| <span class="source-line-no">117</span><span id="line-117"> * Get all Namespaces</span> |
| <span class="source-line-no">118</span><span id="line-118"> * @return All Namespace descriptors</span> |
| <span class="source-line-no">119</span><span id="line-119"> */</span> |
| <span class="source-line-no">120</span><span id="line-120"> List<NamespaceDescriptor> getNamespaces() throws IOException;</span> |
| <span class="source-line-no">121</span><span id="line-121">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
