blob: 192bb860baeec8d9ec9e55b8dd84c350ef525575 [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.master.procedure, interface: TableProcedureInterface">
<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.procedure;</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.TableName;</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"> * Procedures that operates on a specific Table (e.g. create, delete, snapshot, ...) must implement</span>
<span class="source-line-no">025</span><span id="line-25"> * this interface to allow the system handle the lock/concurrency problems.</span>
<span class="source-line-no">026</span><span id="line-26"> */</span>
<span class="source-line-no">027</span><span id="line-27">@InterfaceAudience.Private</span>
<span class="source-line-no">028</span><span id="line-28">public interface TableProcedureInterface {</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30"> /**</span>
<span class="source-line-no">031</span><span id="line-31"> * Used for acquire/release lock for namespace related operations, just a place holder as we do</span>
<span class="source-line-no">032</span><span id="line-32"> * not have namespace table any more.</span>
<span class="source-line-no">033</span><span id="line-33"> */</span>
<span class="source-line-no">034</span><span id="line-34"> public static final TableName DUMMY_NAMESPACE_TABLE_NAME = TableName.NAMESPACE_TABLE_NAME;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36"> public enum TableOperationType {</span>
<span class="source-line-no">037</span><span id="line-37"> CREATE,</span>
<span class="source-line-no">038</span><span id="line-38"> DELETE,</span>
<span class="source-line-no">039</span><span id="line-39"> DISABLE,</span>
<span class="source-line-no">040</span><span id="line-40"> EDIT,</span>
<span class="source-line-no">041</span><span id="line-41"> ENABLE,</span>
<span class="source-line-no">042</span><span id="line-42"> READ,</span>
<span class="source-line-no">043</span><span id="line-43"> SNAPSHOT,</span>
<span class="source-line-no">044</span><span id="line-44"> REGION_SNAPSHOT,</span>
<span class="source-line-no">045</span><span id="line-45"> FLUSH,</span>
<span class="source-line-no">046</span><span id="line-46"> REGION_EDIT,</span>
<span class="source-line-no">047</span><span id="line-47"> REGION_SPLIT,</span>
<span class="source-line-no">048</span><span id="line-48"> REGION_MERGE,</span>
<span class="source-line-no">049</span><span id="line-49"> REGION_ASSIGN,</span>
<span class="source-line-no">050</span><span id="line-50"> REGION_UNASSIGN,</span>
<span class="source-line-no">051</span><span id="line-51"> REGION_GC,</span>
<span class="source-line-no">052</span><span id="line-52"> MERGED_REGIONS_GC/* region operations */,</span>
<span class="source-line-no">053</span><span id="line-53"> REGION_TRUNCATE,</span>
<span class="source-line-no">054</span><span id="line-54"> RESTORE_BACKUP_SYSTEM_TABLE</span>
<span class="source-line-no">055</span><span id="line-55"> }</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> /** Returns the name of the table the procedure is operating on */</span>
<span class="source-line-no">058</span><span id="line-58"> TableName getTableName();</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> /**</span>
<span class="source-line-no">061</span><span id="line-61"> * Given an operation type we can take decisions about what to do with pending operations. e.g. if</span>
<span class="source-line-no">062</span><span id="line-62"> * we get a delete and we have some table operation pending (e.g. add column) we can abort those</span>
<span class="source-line-no">063</span><span id="line-63"> * operations.</span>
<span class="source-line-no">064</span><span id="line-64"> * @return the operation type that the procedure is executing.</span>
<span class="source-line-no">065</span><span id="line-65"> */</span>
<span class="source-line-no">066</span><span id="line-66"> TableOperationType getTableOperationType();</span>
<span class="source-line-no">067</span><span id="line-67">}</span>
</pre>
</div>
</main>
</body>
</html>