| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CreateTableOptions (Kudu 0.6.0 API)</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="CreateTableOptions (Kudu 0.6.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="class-use/CreateTableOptions.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="../../../org/kududb/client/ConnectionResetException.html" title="class in org.kududb.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/kududb/client/Delete.html" title="class in org.kududb.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/kududb/client/CreateTableOptions.html" target="_top">Frames</a></li> |
| <li><a href="CreateTableOptions.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.kududb.client</div> |
| <h2 title="Class CreateTableOptions" class="title">Class CreateTableOptions</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/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.kududb.client.CreateTableOptions</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public class <span class="typeNameLabel">CreateTableOptions</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">This is a builder class for all the options that can be provided while creating a table.</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/kududb/client/CreateTableOptions.html#CreateTableOptions--">CreateTableOptions</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/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kududb/client/CreateTableOptions.html#addHashPartitions-java.util.List-int-">addHashPartitions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> columns, |
| int buckets)</code> |
| <div class="block">Add a set of hash partitions to the table.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kududb/client/CreateTableOptions.html#addHashPartitions-java.util.List-int-int-">addHashPartitions</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> columns, |
| int buckets, |
| int seed)</code> |
| <div class="block">Add a set of hash partitions to the table.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kududb/client/CreateTableOptions.html#addSplitRow-org.kududb.client.PartialRow-">addSplitRow</a></span>(<a href="../../../org/kududb/client/PartialRow.html" title="class in org.kududb.client">PartialRow</a> row)</code> |
| <div class="block">Add a split point for the table.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kududb/client/CreateTableOptions.html#setNumReplicas-int-">setNumReplicas</a></span>(int numReplicas)</code> |
| <div class="block">Sets the number of replicas that each tablet will have.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kududb/client/CreateTableOptions.html#setRangePartitionColumns-java.util.List-">setRangePartitionColumns</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> columns)</code> |
| <div class="block">Set the columns on which the table will be range-partitioned.</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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="CreateTableOptions--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CreateTableOptions</h4> |
| <pre>public CreateTableOptions()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addSplitRow-org.kududb.client.PartialRow-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSplitRow</h4> |
| <pre>public <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> addSplitRow(<a href="../../../org/kududb/client/PartialRow.html" title="class in org.kududb.client">PartialRow</a> row)</pre> |
| <div class="block">Add a split point for the table. The table in the end will have splits + 1 tablets. |
| The row may be reused or modified safely after this call without changing the split point.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>row</code> - a key row for the split point</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addHashPartitions-java.util.List-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHashPartitions</h4> |
| <pre>public <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> addHashPartitions(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> columns, |
| int buckets)</pre> |
| <div class="block">Add a set of hash partitions to the table. |
| |
| Each column must be a part of the table's primary key, and an individual |
| column may only appear in a single hash component. |
| |
| For each set of hash partitions added to the table, the total number of |
| table partitions is multiplied by the number of buckets. For example, if a |
| table is created with 3 split rows, and two hash partitions with 4 and 5 |
| buckets respectively, the total number of table partitions will be 80 |
| (4 range partitions * 4 hash buckets * 5 hash buckets).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columns</code> - the columns to hash</dd> |
| <dd><code>buckets</code> - the number of buckets to hash into</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addHashPartitions-java.util.List-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHashPartitions</h4> |
| <pre>public <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> addHashPartitions(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> columns, |
| int buckets, |
| int seed)</pre> |
| <div class="block">Add a set of hash partitions to the table. |
| |
| This constructor takes a seed value, which can be used to randomize the |
| mapping of rows to hash buckets. Setting the seed may provide some |
| amount of protection against denial of service attacks when the hashed |
| columns contain user provided values.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columns</code> - the columns to hash</dd> |
| <dd><code>buckets</code> - the number of buckets to hash into</dd> |
| <dd><code>seed</code> - a hash seed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRangePartitionColumns-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRangePartitionColumns</h4> |
| <pre>public <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> setRangePartitionColumns(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> columns)</pre> |
| <div class="block">Set the columns on which the table will be range-partitioned. |
| |
| Every column must be a part of the table's primary key. If not set, the |
| table will be created with the primary-key columns as the range-partition |
| columns. If called with an empty vector, the table will be created without |
| range partitioning.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columns</code> - the range partitioned columns</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setNumReplicas-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setNumReplicas</h4> |
| <pre>public <a href="../../../org/kududb/client/CreateTableOptions.html" title="class in org.kududb.client">CreateTableOptions</a> setNumReplicas(int numReplicas)</pre> |
| <div class="block">Sets the number of replicas that each tablet will have. If not specified, it defaults to 1 |
| replica which isn't safe for production usage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numReplicas</code> - the number of replicas to use</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="class-use/CreateTableOptions.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="../../../org/kududb/client/ConnectionResetException.html" title="class in org.kududb.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/kududb/client/Delete.html" title="class in org.kududb.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/kududb/client/CreateTableOptions.html" target="_top">Frames</a></li> |
| <li><a href="CreateTableOptions.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2015. All rights reserved.</small></p> |
| </body> |
| </html> |