mirror of https://github.com/tikv/client-java.git
640 lines
21 KiB
HTML
640 lines
21 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_292) on Wed May 31 08:56:26 UTC 2023 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>BinlogOuterClass.BinlogOrBuilder (TiKV Java Client 3.3.4-SNAPSHOT API)</title>
|
|
<meta name="date" content="2023-05-31">
|
|
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="BinlogOuterClass.BinlogOrBuilder (TiKV Java Client 3.3.4-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/BinlogOuterClass.BinlogOrBuilder.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../index-all.html">Index</a></li>
|
|
<li><a href="../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../binlog/BinlogOuterClass.Binlog.Builder.html" title="class in binlog"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../binlog/BinlogOuterClass.BinlogType.html" title="enum in binlog"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?binlog/BinlogOuterClass.BinlogOrBuilder.html" target="_top">Frames</a></li>
|
|
<li><a href="BinlogOuterClass.BinlogOrBuilder.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">binlog</div>
|
|
<h2 title="Interface BinlogOuterClass.BinlogOrBuilder" class="title">Interface BinlogOuterClass.BinlogOrBuilder</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Superinterfaces:</dt>
|
|
<dd>com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../binlog/BinlogOuterClass.Binlog.html" title="class in binlog">BinlogOuterClass.Binlog</a>, <a href="../binlog/BinlogOuterClass.Binlog.Builder.html" title="class in binlog">BinlogOuterClass.Binlog.Builder</a></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Enclosing class:</dt>
|
|
<dd><a href="../binlog/BinlogOuterClass.html" title="class in binlog">BinlogOuterClass</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public static interface <span class="typeNameLabel">BinlogOuterClass.BinlogOrBuilder</span>
|
|
extends com.google.protobuf.MessageOrBuilder</pre>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getCommitTs--">getCommitTs</a></span>()</code>
|
|
<div class="block">
|
|
commit_ts is used only in binlog type Commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getDdlJobId--">getDdlJobId</a></span>()</code>
|
|
<div class="block">
|
|
ddl_job_id is used for DDL Binlog.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getDdlQuery--">getDdlQuery</a></span>()</code>
|
|
<div class="block">
|
|
ddl_query is the original DDL statement query.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getDdlSchemaState--">getDdlSchemaState</a></span>()</code>
|
|
<div class="block">
|
|
ddl_schema_state is used for DDL Binlog.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getPrewriteKey--">getPrewriteKey</a></span>()</code>
|
|
<div class="block">
|
|
prewrite key is used only in Prewrite binlog type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getPrewriteValue--">getPrewriteValue</a></span>()</code>
|
|
<div class="block">
|
|
prewrite_data is marshalled from PrewriteData type,
|
|
we do not need to unmarshal prewrite data before the binlog have been successfully paired.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getStartTs--">getStartTs</a></span>()</code>
|
|
<div class="block">
|
|
start_ts is used in Prewrite, Commit and Rollback binlog Type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="../binlog/BinlogOuterClass.BinlogType.html" title="enum in binlog">BinlogOuterClass.BinlogType</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#getTp--">getTp</a></span>()</code>
|
|
<div class="block"><code>optional .binlog.BinlogType tp = 1 [(.gogoproto.nullable) = false];</code></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasCommitTs--">hasCommitTs</a></span>()</code>
|
|
<div class="block">
|
|
commit_ts is used only in binlog type Commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasDdlJobId--">hasDdlJobId</a></span>()</code>
|
|
<div class="block">
|
|
ddl_job_id is used for DDL Binlog.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasDdlQuery--">hasDdlQuery</a></span>()</code>
|
|
<div class="block">
|
|
ddl_query is the original DDL statement query.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasDdlSchemaState--">hasDdlSchemaState</a></span>()</code>
|
|
<div class="block">
|
|
ddl_schema_state is used for DDL Binlog.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasPrewriteKey--">hasPrewriteKey</a></span>()</code>
|
|
<div class="block">
|
|
prewrite key is used only in Prewrite binlog type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasPrewriteValue--">hasPrewriteValue</a></span>()</code>
|
|
<div class="block">
|
|
prewrite_data is marshalled from PrewriteData type,
|
|
we do not need to unmarshal prewrite data before the binlog have been successfully paired.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasStartTs--">hasStartTs</a></span>()</code>
|
|
<div class="block">
|
|
start_ts is used in Prewrite, Commit and Rollback binlog Type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../binlog/BinlogOuterClass.BinlogOrBuilder.html#hasTp--">hasTp</a></span>()</code>
|
|
<div class="block"><code>optional .binlog.BinlogType tp = 1 [(.gogoproto.nullable) = false];</code></div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from interface com.google.protobuf.MessageOrBuilder</h3>
|
|
<code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder</h3>
|
|
<code>isInitialized</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="hasTp--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasTp</h4>
|
|
<pre>boolean hasTp()</pre>
|
|
<div class="block"><code>optional .binlog.BinlogType tp = 1 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the tp field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTp--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTp</h4>
|
|
<pre><a href="../binlog/BinlogOuterClass.BinlogType.html" title="enum in binlog">BinlogOuterClass.BinlogType</a> getTp()</pre>
|
|
<div class="block"><code>optional .binlog.BinlogType tp = 1 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The tp.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasStartTs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasStartTs</h4>
|
|
<pre>boolean hasStartTs()</pre>
|
|
<div class="block"><pre>
|
|
start_ts is used in Prewrite, Commit and Rollback binlog Type.
|
|
It is used for pairing prewrite log to commit log or rollback log.
|
|
</pre>
|
|
|
|
<code>optional int64 start_ts = 2 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the startTs field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getStartTs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStartTs</h4>
|
|
<pre>long getStartTs()</pre>
|
|
<div class="block"><pre>
|
|
start_ts is used in Prewrite, Commit and Rollback binlog Type.
|
|
It is used for pairing prewrite log to commit log or rollback log.
|
|
</pre>
|
|
|
|
<code>optional int64 start_ts = 2 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The startTs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasCommitTs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasCommitTs</h4>
|
|
<pre>boolean hasCommitTs()</pre>
|
|
<div class="block"><pre>
|
|
commit_ts is used only in binlog type Commit.
|
|
</pre>
|
|
|
|
<code>optional int64 commit_ts = 3 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the commitTs field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCommitTs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCommitTs</h4>
|
|
<pre>long getCommitTs()</pre>
|
|
<div class="block"><pre>
|
|
commit_ts is used only in binlog type Commit.
|
|
</pre>
|
|
|
|
<code>optional int64 commit_ts = 3 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The commitTs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasPrewriteKey--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasPrewriteKey</h4>
|
|
<pre>boolean hasPrewriteKey()</pre>
|
|
<div class="block"><pre>
|
|
prewrite key is used only in Prewrite binlog type.
|
|
It is the primary key of the transaction, is used to check that the transaction is
|
|
commited or not if it failed to pair to commit log or rollback log within a time window.
|
|
</pre>
|
|
|
|
<code>optional bytes prewrite_key = 4;</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the prewriteKey field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrewriteKey--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrewriteKey</h4>
|
|
<pre>com.google.protobuf.ByteString getPrewriteKey()</pre>
|
|
<div class="block"><pre>
|
|
prewrite key is used only in Prewrite binlog type.
|
|
It is the primary key of the transaction, is used to check that the transaction is
|
|
commited or not if it failed to pair to commit log or rollback log within a time window.
|
|
</pre>
|
|
|
|
<code>optional bytes prewrite_key = 4;</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The prewriteKey.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasPrewriteValue--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasPrewriteValue</h4>
|
|
<pre>boolean hasPrewriteValue()</pre>
|
|
<div class="block"><pre>
|
|
prewrite_data is marshalled from PrewriteData type,
|
|
we do not need to unmarshal prewrite data before the binlog have been successfully paired.
|
|
</pre>
|
|
|
|
<code>optional bytes prewrite_value = 5;</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the prewriteValue field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrewriteValue--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrewriteValue</h4>
|
|
<pre>com.google.protobuf.ByteString getPrewriteValue()</pre>
|
|
<div class="block"><pre>
|
|
prewrite_data is marshalled from PrewriteData type,
|
|
we do not need to unmarshal prewrite data before the binlog have been successfully paired.
|
|
</pre>
|
|
|
|
<code>optional bytes prewrite_value = 5;</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The prewriteValue.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasDdlQuery--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasDdlQuery</h4>
|
|
<pre>boolean hasDdlQuery()</pre>
|
|
<div class="block"><pre>
|
|
ddl_query is the original DDL statement query.
|
|
</pre>
|
|
|
|
<code>optional bytes ddl_query = 6;</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the ddlQuery field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDdlQuery--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDdlQuery</h4>
|
|
<pre>com.google.protobuf.ByteString getDdlQuery()</pre>
|
|
<div class="block"><pre>
|
|
ddl_query is the original DDL statement query.
|
|
</pre>
|
|
|
|
<code>optional bytes ddl_query = 6;</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The ddlQuery.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasDdlJobId--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasDdlJobId</h4>
|
|
<pre>boolean hasDdlJobId()</pre>
|
|
<div class="block"><pre>
|
|
ddl_job_id is used for DDL Binlog.
|
|
If ddl_job_id is setted, this is a DDL Binlog and ddl_query contains the DDL query, we can query the informations about this job from TiKV.
|
|
</pre>
|
|
|
|
<code>optional int64 ddl_job_id = 7 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the ddlJobId field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDdlJobId--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDdlJobId</h4>
|
|
<pre>long getDdlJobId()</pre>
|
|
<div class="block"><pre>
|
|
ddl_job_id is used for DDL Binlog.
|
|
If ddl_job_id is setted, this is a DDL Binlog and ddl_query contains the DDL query, we can query the informations about this job from TiKV.
|
|
</pre>
|
|
|
|
<code>optional int64 ddl_job_id = 7 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The ddlJobId.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="hasDdlSchemaState--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>hasDdlSchemaState</h4>
|
|
<pre>boolean hasDdlSchemaState()</pre>
|
|
<div class="block"><pre>
|
|
ddl_schema_state is used for DDL Binlog.
|
|
</pre>
|
|
|
|
<code>optional int32 ddl_schema_state = 8 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the ddlSchemaState field is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDdlSchemaState--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getDdlSchemaState</h4>
|
|
<pre>int getDdlSchemaState()</pre>
|
|
<div class="block"><pre>
|
|
ddl_schema_state is used for DDL Binlog.
|
|
</pre>
|
|
|
|
<code>optional int32 ddl_schema_state = 8 [(.gogoproto.nullable) = false];</code></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The ddlSchemaState.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/BinlogOuterClass.BinlogOrBuilder.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../index-all.html">Index</a></li>
|
|
<li><a href="../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../binlog/BinlogOuterClass.Binlog.Builder.html" title="class in binlog"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../binlog/BinlogOuterClass.BinlogType.html" title="enum in binlog"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../index.html?binlog/BinlogOuterClass.BinlogOrBuilder.html" target="_top">Frames</a></li>
|
|
<li><a href="BinlogOuterClass.BinlogOrBuilder.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright © 2023 PingCAP. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|