| <!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 --> |
| <title>AlterTableOptions</title> |
| <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="AlterTableOptions"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="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="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/kudu/client/AlterTableResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/kudu/client/AlterTableOptions.html" target="_top">Frames</a></li> |
| <li><a href="AlterTableOptions.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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">org.apache.kudu.client</div> |
| <h2 title="Class AlterTableOptions" class="title">Class AlterTableOptions</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.kudu.client.AlterTableOptions</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Unstable |
| public class <span class="typeNameLabel">AlterTableOptions</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">This builder must be used to alter a table. At least one change must be specified.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#AlterTableOptions--">AlterTableOptions</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addColumn-org.apache.kudu.ColumnSchema-">addColumn</a></span>(<a href="../../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a> colSchema)</code> |
| <div class="block">Add a new column.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addColumn-java.lang.String-org.apache.kudu.Type-java.lang.Object-">addColumn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> defaultVal)</code> |
| <div class="block">Add a new column that's not nullable.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addNullableColumn-java.lang.String-org.apache.kudu.Type-">addNullableColumn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type)</code> |
| <div class="block">Add a new column that's nullable and has no default value.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addNullableColumn-java.lang.String-org.apache.kudu.Type-java.lang.Object-">addNullableColumn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> defaultVal)</code> |
| <div class="block">Add a new column that's nullable.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-">addRangePartition</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound)</code> |
| <div class="block">Add a range partition to the table with an inclusive lower bound and an exclusive upper bound.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-org.apache.kudu.client.RangePartitionBound-org.apache.kudu.client.RangePartitionBound-">addRangePartition</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> lowerBoundType, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> upperBoundType)</code> |
| <div class="block">Add a range partition to the table with a lower bound and upper bound.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#addRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-java.lang.String-org.apache.kudu.client.RangePartitionBound-org.apache.kudu.client.RangePartitionBound-">addRangePartition</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dimensionLabel, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> lowerBoundType, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> upperBoundType)</code> |
| <div class="block">Add a range partition to the table with dimension label.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#alterExtraConfigs-java.util.Map-">alterExtraConfigs</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> extraConfig)</code> |
| <div class="block">Change the table's extra configuration properties.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#changeComment-java.lang.String-java.lang.String-">changeComment</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> comment)</code> |
| <div class="block">Change the comment for the column.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#changeCompressionAlgorithm-java.lang.String-org.apache.kudu.ColumnSchema.CompressionAlgorithm-">changeCompressionAlgorithm</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/ColumnSchema.CompressionAlgorithm.html" title="enum in org.apache.kudu">ColumnSchema.CompressionAlgorithm</a> ca)</code> |
| <div class="block">Change the compression used for a column.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#changeDefault-java.lang.String-java.lang.Object-">changeDefault</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newDefault)</code> |
| <div class="block">Change the default value for a column.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#changeDesiredBlockSize-java.lang.String-int-">changeDesiredBlockSize</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| int blockSize)</code> |
| <div class="block">Change the block size of a column's storage.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#changeEncoding-java.lang.String-org.apache.kudu.ColumnSchema.Encoding-">changeEncoding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/ColumnSchema.Encoding.html" title="enum in org.apache.kudu">ColumnSchema.Encoding</a> encoding)</code> |
| <div class="block">Change the encoding used for a column.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#dropColumn-java.lang.String-">dropColumn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Drop a column.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#dropRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-">dropRangePartition</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound)</code> |
| <div class="block">Drop the range partition from the table with the specified inclusive lower bound and exclusive |
| upper bound.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#dropRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-org.apache.kudu.client.RangePartitionBound-org.apache.kudu.client.RangePartitionBound-">dropRangePartition</a></span>(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> lowerBoundType, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> upperBoundType)</code> |
| <div class="block">Drop the range partition from the table with the specified lower bound and upper bound.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#removeDefault-java.lang.String-">removeDefault</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Remove the default value for a column.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#renameColumn-java.lang.String-java.lang.String-">renameColumn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oldName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newName)</code> |
| <div class="block">Change the name of a column.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#renameTable-java.lang.String-">renameTable</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newName)</code> |
| <div class="block">Change a table's name.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/kudu/client/AlterTableOptions.html#setWait-boolean-">setWait</a></span>(boolean wait)</code> |
| <div class="block">Whether to wait for the table to be fully altered before this alter |
| operation is considered to be finished.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AlterTableOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AlterTableOptions</h4> |
| <pre>public AlterTableOptions()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="renameTable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameTable</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> renameTable(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newName)</pre> |
| <div class="block">Change a table's name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newName</code> - new table's name, must be used to check progress</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addColumn-org.apache.kudu.ColumnSchema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumn</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addColumn(<a href="../../../../org/apache/kudu/ColumnSchema.html" title="class in org.apache.kudu">ColumnSchema</a> colSchema)</pre> |
| <div class="block">Add a new column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>colSchema</code> - the schema of the new column</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addColumn-java.lang.String-org.apache.kudu.Type-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumn</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addColumn(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> defaultVal)</pre> |
| <div class="block">Add a new column that's not nullable.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the new column</dd> |
| <dd><code>type</code> - type of the new column</dd> |
| <dd><code>defaultVal</code> - default value used for the currently existing rows</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addNullableColumn-java.lang.String-org.apache.kudu.Type-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addNullableColumn</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addNullableColumn(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type)</pre> |
| <div class="block">Add a new column that's nullable and has no default value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the new column</dd> |
| <dd><code>type</code> - type of the new column</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addNullableColumn-java.lang.String-org.apache.kudu.Type-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addNullableColumn</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addNullableColumn(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/Type.html" title="enum in org.apache.kudu">Type</a> type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> defaultVal)</pre> |
| <div class="block">Add a new column that's nullable.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the new column</dd> |
| <dd><code>type</code> - type of the new column</dd> |
| <dd><code>defaultVal</code> - the default value of the new column</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropColumn-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropColumn</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> dropColumn(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Drop a column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the column</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="renameColumn-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>renameColumn</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> renameColumn(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> oldName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newName)</pre> |
| <div class="block">Change the name of a column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>oldName</code> - old column's name, must exist</dd> |
| <dd><code>newName</code> - new name to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeDefault-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeDefault</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> removeDefault(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Remove the default value for a column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the column</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="changeDefault-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeDefault</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> changeDefault(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> newDefault)</pre> |
| <div class="block">Change the default value for a column. `newDefault` must not be null or |
| else throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the column</dd> |
| <dd><code>newDefault</code> - the new default value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="changeDesiredBlockSize-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeDesiredBlockSize</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> changeDesiredBlockSize(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| int blockSize)</pre> |
| <div class="block">Change the block size of a column's storage. A nonpositive value indicates |
| a server-side default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the column</dd> |
| <dd><code>blockSize</code> - the new block size</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="changeEncoding-java.lang.String-org.apache.kudu.ColumnSchema.Encoding-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeEncoding</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> changeEncoding(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/ColumnSchema.Encoding.html" title="enum in org.apache.kudu">ColumnSchema.Encoding</a> encoding)</pre> |
| <div class="block">Change the encoding used for a column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the column</dd> |
| <dd><code>encoding</code> - the new encoding</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="changeCompressionAlgorithm-java.lang.String-org.apache.kudu.ColumnSchema.CompressionAlgorithm-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeCompressionAlgorithm</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> changeCompressionAlgorithm(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../org/apache/kudu/ColumnSchema.CompressionAlgorithm.html" title="enum in org.apache.kudu">ColumnSchema.CompressionAlgorithm</a> ca)</pre> |
| <div class="block">Change the compression used for a column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the column</dd> |
| <dd><code>ca</code> - the new compression algorithm</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRangePartition</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addRangePartition(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound)</pre> |
| <div class="block">Add a range partition to the table with an inclusive lower bound and an exclusive upper bound. |
| |
| If either row is empty, then that end of the range will be unbounded. If a range column is |
| missing a value, the logical minimum value for that column type will be used as the default. |
| |
| Multiple range partitions may be added as part of a single alter table transaction by calling |
| this method multiple times. Added range partitions must not overlap with each |
| other or any existing range partitions (unless the existing range partitions are dropped as |
| part of the alter transaction first). The lower bound must be less than the upper bound. |
| |
| This client will immediately be able to write and scan the new tablets when the alter table |
| operation returns success, however other existing clients may have to wait for a timeout period |
| to elapse before the tablets become visible. This period is configured by the master's |
| 'table_locations_ttl_ms' flag, and defaults to 5 minutes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lowerBound</code> - inclusive lower bound, may be empty but not null</dd> |
| <dd><code>upperBound</code> - exclusive upper bound, may be empty but not null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-org.apache.kudu.client.RangePartitionBound-org.apache.kudu.client.RangePartitionBound-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRangePartition</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addRangePartition(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> lowerBoundType, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> upperBoundType)</pre> |
| <div class="block">Add a range partition to the table with a lower bound and upper bound. |
| |
| If either row is empty, then that end of the range will be unbounded. If a range column is |
| missing a value, the logical minimum value for that column type will be used as the default. |
| |
| Multiple range partitions may be added as part of a single alter table transaction by calling |
| this method multiple times. Added range partitions must not overlap with each |
| other or any existing range partitions (unless the existing range partitions are dropped as |
| part of the alter transaction first). The lower bound must be less than the upper bound. |
| |
| This client will immediately be able to write and scan the new tablets when the alter table |
| operation returns success, however other existing clients may have to wait for a timeout period |
| to elapse before the tablets become visible. This period is configured by the master's |
| 'table_locations_ttl_ms' flag, and defaults to 5 minutes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lowerBound</code> - lower bound, may be empty but not null</dd> |
| <dd><code>upperBound</code> - upper bound, may be empty but not null</dd> |
| <dd><code>lowerBoundType</code> - the type of the lower bound, either inclusive or exclusive</dd> |
| <dd><code>upperBoundType</code> - the type of the upper bound, either inclusive or exclusive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-java.lang.String-org.apache.kudu.client.RangePartitionBound-org.apache.kudu.client.RangePartitionBound-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRangePartition</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> addRangePartition(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> dimensionLabel, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> lowerBoundType, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> upperBoundType)</pre> |
| <div class="block">Add a range partition to the table with dimension label. |
| |
| If either row is empty, then that end of the range will be unbounded. If a range column is |
| missing a value, the logical minimum value for that column type will be used as the default. |
| |
| Multiple range partitions may be added as part of a single alter table transaction by calling |
| this method multiple times. Added range partitions must not overlap with each |
| other or any existing range partitions (unless the existing range partitions are dropped as |
| part of the alter transaction first). The lower bound must be less than the upper bound. |
| |
| This client will immediately be able to write and scan the new tablets when the alter table |
| operation returns success, however other existing clients may have to wait for a timeout period |
| to elapse before the tablets become visible. This period is configured by the master's |
| 'table_locations_ttl_ms' flag, and defaults to 5 minutes. |
| |
| By default, the master will try to place newly created tablet replicas on tablet |
| servers with a small number of tablet replicas. If the dimension label is provided, |
| newly created replicas will be evenly distributed in the cluster based on the dimension |
| label. In other words, the master will try to place newly created tablet replicas on |
| tablet servers with a small number of tablet replicas belonging to this dimension label.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lowerBound</code> - lower bound, may be empty but not null</dd> |
| <dd><code>upperBound</code> - upper bound, may be empty but not null</dd> |
| <dd><code>dimensionLabel</code> - the dimension label for the tablet to be created</dd> |
| <dd><code>lowerBoundType</code> - the type of the lower bound, either inclusive or exclusive</dd> |
| <dd><code>upperBoundType</code> - the type of the upper bound, either inclusive or exclusive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropRangePartition</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> dropRangePartition(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound)</pre> |
| <div class="block">Drop the range partition from the table with the specified inclusive lower bound and exclusive |
| upper bound. The bounds must match exactly, and may not span multiple range partitions. |
| |
| If either row is empty, then that end of the range will be unbounded. If a range column is |
| missing a value, the logical minimum value for that column type will be used as the default. |
| |
| Multiple range partitions may be dropped as part of a single alter table transaction by calling |
| this method multiple times.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lowerBound</code> - inclusive lower bound, can be empty but not null</dd> |
| <dd><code>upperBound</code> - exclusive upper bound, can be empty but not null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="dropRangePartition-org.apache.kudu.client.PartialRow-org.apache.kudu.client.PartialRow-org.apache.kudu.client.RangePartitionBound-org.apache.kudu.client.RangePartitionBound-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropRangePartition</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> dropRangePartition(<a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> lowerBound, |
| <a href="../../../../org/apache/kudu/client/PartialRow.html" title="class in org.apache.kudu.client">PartialRow</a> upperBound, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> lowerBoundType, |
| <a href="../../../../org/apache/kudu/client/RangePartitionBound.html" title="enum in org.apache.kudu.client">RangePartitionBound</a> upperBoundType)</pre> |
| <div class="block">Drop the range partition from the table with the specified lower bound and upper bound. |
| The bounds must match exactly, and may not span multiple range partitions. |
| |
| If either row is empty, then that end of the range will be unbounded. If a range column is |
| missing a value, the logical minimum value for that column type will be used as the default. |
| |
| Multiple range partitions may be dropped as part of a single alter table transaction by calling |
| this method multiple times.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lowerBound</code> - inclusive lower bound, can be empty but not null</dd> |
| <dd><code>upperBound</code> - exclusive upper bound, can be empty but not null</dd> |
| <dd><code>lowerBoundType</code> - the type of the lower bound, either inclusive or exclusive</dd> |
| <dd><code>upperBoundType</code> - the type of the upper bound, either inclusive or exclusive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="changeComment-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>changeComment</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> changeComment(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> comment)</pre> |
| <div class="block">Change the comment for the column.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name of the column</dd> |
| <dd><code>comment</code> - the new comment for the column, an empty comment means |
| deleting an existing comment.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="alterExtraConfigs-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alterExtraConfigs</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> alterExtraConfigs(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> extraConfig)</pre> |
| <div class="block">Change the table's extra configuration properties. |
| These configuration properties will be merged into existing configuration properties. |
| |
| If the value of the kv pair is empty, the property will be unset.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extraConfig</code> - the table's extra configuration properties</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWait-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setWait</h4> |
| <pre>public <a href="../../../../org/apache/kudu/client/AlterTableOptions.html" title="class in org.apache.kudu.client">AlterTableOptions</a> setWait(boolean wait)</pre> |
| <div class="block">Whether to wait for the table to be fully altered before this alter |
| operation is considered to be finished. |
| <p> |
| If false, the alter will finish quickly, but a subsequent |
| <a href="../../../../org/apache/kudu/client/KuduClient.html#openTable-java.lang.String-"><code>KuduClient.openTable(String)</code></a> may return a <a href="../../../../org/apache/kudu/client/KuduTable.html" title="class in org.apache.kudu.client"><code>KuduTable</code></a> with |
| an out-of-date schema. |
| <p> |
| If true, the alter will take longer, but the very next schema is guaranteed |
| to be up-to-date. |
| <p> |
| If not provided, defaults to true. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>wait</code> - whether to wait for the table to be fully altered</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</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="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="../../../../org/apache/kudu/client/AbstractKuduScannerBuilder.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/kudu/client/AlterTableResponse.html" title="class in org.apache.kudu.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/kudu/client/AlterTableOptions.html" target="_top">Frames</a></li> |
| <li><a href="AlterTableOptions.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
