cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>Schema (apache-cassandra API)</title> <meta name="date" content="2014-09-07"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <div class="topNav"><a name="navbar_top">  </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Schema.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/apache/cassandra/config/RequestSchedulerOptions.html" title="class in org.apache.cassandra.config"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/config/SeedProviderDef.html" title="class in org.apache.cassandra.config"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/config/Schema.html" target="_top">Frames</a></li> <li><a href="Schema.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.config</div> <h2 title="Class Schema" class="title">Class Schema</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.config.Schema</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">Schema</span> extends java.lang.Object</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.util.UUID</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#emptyVersion">emptyVersion</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/config/Schema.html" title="class in org.apache.cassandra.config">Schema</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#instance">instance</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#NAME_LENGTH">NAME_LENGTH</a></strong></code> <div class="block">longest permissible KS or CF name.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static com.google.common.collect.ImmutableSet<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#systemKeyspaceNames">systemKeyspaceNames</a></strong></code> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_summary">  </a> <h3>Constructor Summary</h3> <table class="overviewSummary" 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><strong><a href="../../../../org/apache/cassandra/config/Schema.html#Schema()">Schema</a></strong>()</code> <div class="block">Initialize empty schema object</div> </td> </tr> </table> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_summary">  </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#clear()">clear</a></strong>()</code> <div class="block">Clear all KS/CF metadata and reset version.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#clearKeyspaceDefinition(org.apache.cassandra.config.KSMetaData)">clearKeyspaceDefinition</a></strong>(<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> ksm)</code> <div class="block">Remove keyspace definition from system</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.lang.String,java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getCF(java.util.UUID)">getCF</a></strong>(java.util.UUID cfId)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getCFMetaData(org.apache.cassandra.io.sstable.Descriptor)">getCFMetaData</a></strong>(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> descriptor)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getCFMetaData(java.lang.String,%20java.lang.String)">getCFMetaData</a></strong>(java.lang.String keyspaceName, java.lang.String cfName)</code> <div class="block">Given a keyspace name & column family name, get the column family meta data.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getCFMetaData(java.util.UUID)">getCFMetaData</a></strong>(java.util.UUID cfId)</code> <div class="block">Get ColumnFamily metadata by its identifier</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getColumnFamilyStoreInstance(java.util.UUID)">getColumnFamilyStoreInstance</a></strong>(java.util.UUID cfId)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/ColumnFamilyType.html" title="enum in org.apache.cassandra.db">ColumnFamilyType</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getColumnFamilyType(java.lang.String,%20java.lang.String)">getColumnFamilyType</a></strong>(java.lang.String ksName, java.lang.String cfName)</code> <div class="block">Get type of the ColumnFamily but it's keyspace/name</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.UUID</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getId(java.lang.String,%20java.lang.String)">getId</a></strong>(java.lang.String ksName, java.lang.String cfName)</code> <div class="block">Lookup keyspace/ColumnFamily identifier</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Collection<<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getKeyspaceDefinitions()">getKeyspaceDefinitions</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getKeyspaceInstance(java.lang.String)">getKeyspaceInstance</a></strong>(java.lang.String keyspaceName)</code> <div class="block">Get keyspace instance by name</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getKeyspaceMetaData(java.lang.String)">getKeyspaceMetaData</a></strong>(java.lang.String keyspaceName)</code> <div class="block">Get metadata about keyspace inner ColumnFamilies</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getKeyspaces()">getKeyspaces</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getKSMetaData(java.lang.String)">getKSMetaData</a></strong>(java.lang.String keyspaceName)</code> <div class="block">Get metadata about keyspace by its name</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getNonSystemKeyspaces()">getNonSystemKeyspaces</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.UUID</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#getVersion()">getVersion</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#ignoredSchemaRow(org.apache.cassandra.db.Row)">ignoredSchemaRow</a></strong>(<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> row)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#invalidSchemaRow(org.apache.cassandra.db.Row)">invalidSchemaRow</a></strong>(<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> row)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#load(org.apache.cassandra.config.CFMetaData)">load</a></strong>(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm)</code> <div class="block">Load individual ColumnFamily Definition to the schema (to make ColumnFamily lookup faster)</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/Schema.html" title="class in org.apache.cassandra.config">Schema</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#load(java.util.Collection)">load</a></strong>(java.util.Collection<<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a>> keyspaceDefs)</code> <div class="block">Load up non-system keyspaces</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/config/Schema.html" title="class in org.apache.cassandra.config">Schema</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#load(org.apache.cassandra.config.KSMetaData)">load</a></strong>(<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> keyspaceDef)</code> <div class="block">Load specific keyspace into Schema</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#purge(org.apache.cassandra.config.CFMetaData)">purge</a></strong>(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm)</code> <div class="block">Used for ColumnFamily data eviction out from the schema</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#removeKeyspaceInstance(java.lang.String)">removeKeyspaceInstance</a></strong>(java.lang.String keyspaceName)</code> <div class="block">Remove keyspace from schema</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#setKeyspaceDefinition(org.apache.cassandra.config.KSMetaData)">setKeyspaceDefinition</a></strong>(<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> ksm)</code> <div class="block">Update (or insert) new keyspace definition</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#storeKeyspaceInstance(org.apache.cassandra.db.Keyspace)">storeKeyspaceInstance</a></strong>(<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace)</code> <div class="block">Store given Keyspace instance to the schema</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#updateVersion()">updateVersion</a></strong>()</code> <div class="block">Read schema from system keyspace and calculate MD5 digest of every row, resulting digest will be converted into UUID which would act as content-based version of the schema.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/config/Schema.html#updateVersionAndAnnounce()">updateVersionAndAnnounce</a></strong>()</code> </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.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="instance">  </a> <ul class="blockList"> <li class="blockList"> <h4>instance</h4> <pre>public static final <a href="../../../../org/apache/cassandra/config/Schema.html" title="class in org.apache.cassandra.config">Schema</a> instance</pre> </li> </ul> <a name="NAME_LENGTH">  </a> <ul class="blockList"> <li class="blockList"> <h4>NAME_LENGTH</h4> <pre>public static final int NAME_LENGTH</pre> <div class="block">longest permissible KS or CF name. Our main concern is that filename not be more than 255 characters; the filename will contain both the KS and CF names. Since non-schema-name components only take up ~64 characters, we could allow longer names than this, but on Windows, the entire path should be not greater than 255 characters, so a lower limit here helps avoid problems. See CASSANDRA-4110.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.cassandra.config.Schema.NAME_LENGTH">Constant Field Values</a></dd></dl> </li> </ul> <a name="emptyVersion">  </a> <ul class="blockList"> <li class="blockList"> <h4>emptyVersion</h4> <pre>public static final java.util.UUID emptyVersion</pre> </li> </ul> <a name="systemKeyspaceNames">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>systemKeyspaceNames</h4> <pre>public static final com.google.common.collect.ImmutableSet<java.lang.String> systemKeyspaceNames</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="Schema()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>Schema</h4> <pre>public Schema()</pre> <div class="block">Initialize empty schema object</div> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="load(java.util.Collection)">  </a> <ul class="blockList"> <li class="blockList"> <h4>load</h4> <pre>public <a href="../../../../org/apache/cassandra/config/Schema.html" title="class in org.apache.cassandra.config">Schema</a> load(java.util.Collection<<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a>> keyspaceDefs)</pre> <div class="block">Load up non-system keyspaces</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceDefs</code> - The non-system keyspace definitions</dd> <dt><span class="strong">Returns:</span></dt><dd>self to support chaining calls</dd></dl> </li> </ul> <a name="load(org.apache.cassandra.config.KSMetaData)">  </a> <ul class="blockList"> <li class="blockList"> <h4>load</h4> <pre>public <a href="../../../../org/apache/cassandra/config/Schema.html" title="class in org.apache.cassandra.config">Schema</a> load(<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> keyspaceDef)</pre> <div class="block">Load specific keyspace into Schema</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceDef</code> - The keyspace to load up</dd> <dt><span class="strong">Returns:</span></dt><dd>self to support chaining calls</dd></dl> </li> </ul> <a name="getKeyspaceInstance(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyspaceInstance</h4> <pre>public <a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> getKeyspaceInstance(java.lang.String keyspaceName)</pre> <div class="block">Get keyspace instance by name</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceName</code> - The name of the keyspace</dd> <dt><span class="strong">Returns:</span></dt><dd>Keyspace object or null if keyspace was not found</dd></dl> </li> </ul> <a name="getColumnFamilyStoreInstance(java.util.UUID)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getColumnFamilyStoreInstance</h4> <pre>public <a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> getColumnFamilyStoreInstance(java.util.UUID cfId)</pre> </li> </ul> <a name="storeKeyspaceInstance(org.apache.cassandra.db.Keyspace)">  </a> <ul class="blockList"> <li class="blockList"> <h4>storeKeyspaceInstance</h4> <pre>public void storeKeyspaceInstance(<a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> keyspace)</pre> <div class="block">Store given Keyspace instance to the schema</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspace</code> - The Keyspace instance to store</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.IllegalArgumentException</code> - if Keyspace is already stored</dd></dl> </li> </ul> <a name="removeKeyspaceInstance(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>removeKeyspaceInstance</h4> <pre>public <a href="../../../../org/apache/cassandra/db/Keyspace.html" title="class in org.apache.cassandra.db">Keyspace</a> removeKeyspaceInstance(java.lang.String keyspaceName)</pre> <div class="block">Remove keyspace from schema</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceName</code> - The name of the keyspace to remove</dd> <dt><span class="strong">Returns:</span></dt><dd>removed keyspace instance or null if it wasn't found</dd></dl> </li> </ul> <a name="clearKeyspaceDefinition(org.apache.cassandra.config.KSMetaData)">  </a> <ul class="blockList"> <li class="blockList"> <h4>clearKeyspaceDefinition</h4> <pre>public void clearKeyspaceDefinition(<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> ksm)</pre> <div class="block">Remove keyspace definition from system</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ksm</code> - The keyspace definition to remove</dd></dl> </li> </ul> <a name="getCFMetaData(java.lang.String, java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCFMetaData</h4> <pre>public <a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> getCFMetaData(java.lang.String keyspaceName, java.lang.String cfName)</pre> <div class="block">Given a keyspace name & column family name, get the column family meta data. If the keyspace name or column family name is not valid this function returns null.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceName</code> - The keyspace name</dd><dd><code>cfName</code> - The ColumnFamily name</dd> <dt><span class="strong">Returns:</span></dt><dd>ColumnFamily Metadata object or null if it wasn't found</dd></dl> </li> </ul> <a name="getCFMetaData(java.util.UUID)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCFMetaData</h4> <pre>public <a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> getCFMetaData(java.util.UUID cfId)</pre> <div class="block">Get ColumnFamily metadata by its identifier</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfId</code> - The ColumnFamily identifier</dd> <dt><span class="strong">Returns:</span></dt><dd>metadata about ColumnFamily</dd></dl> </li> </ul> <a name="getCFMetaData(org.apache.cassandra.io.sstable.Descriptor)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCFMetaData</h4> <pre>public <a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> getCFMetaData(<a href="../../../../org/apache/cassandra/io/sstable/Descriptor.html" title="class in org.apache.cassandra.io.sstable">Descriptor</a> descriptor)</pre> </li> </ul> <a name="getColumnFamilyType(java.lang.String, java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getColumnFamilyType</h4> <pre>public <a href="../../../../org/apache/cassandra/db/ColumnFamilyType.html" title="enum in org.apache.cassandra.db">ColumnFamilyType</a> getColumnFamilyType(java.lang.String ksName, java.lang.String cfName)</pre> <div class="block">Get type of the ColumnFamily but it's keyspace/name</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ksName</code> - The keyspace name</dd><dd><code>cfName</code> - The ColumnFamily name</dd> <dt><span class="strong">Returns:</span></dt><dd>The type of the ColumnFamily</dd></dl> </li> </ul> <a name="getKSMetaData(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKSMetaData</h4> <pre>public <a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> getKSMetaData(java.lang.String keyspaceName)</pre> <div class="block">Get metadata about keyspace by its name</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceName</code> - The name of the keyspace</dd> <dt><span class="strong">Returns:</span></dt><dd>The keyspace metadata or null if it wasn't found</dd></dl> </li> </ul> <a name="getNonSystemKeyspaces()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getNonSystemKeyspaces</h4> <pre>public java.util.List<java.lang.String> getNonSystemKeyspaces()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>collection of the non-system keyspaces</dd></dl> </li> </ul> <a name="getKeyspaceMetaData(java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyspaceMetaData</h4> <pre>public java.util.Map<java.lang.String,<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>> getKeyspaceMetaData(java.lang.String keyspaceName)</pre> <div class="block">Get metadata about keyspace inner ColumnFamilies</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>keyspaceName</code> - The name of the keyspace</dd> <dt><span class="strong">Returns:</span></dt><dd>metadata about ColumnFamilies the belong to the given keyspace</dd></dl> </li> </ul> <a name="getKeyspaces()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyspaces</h4> <pre>public java.util.Set<java.lang.String> getKeyspaces()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>collection of the all keyspace names registered in the system (system and non-system)</dd></dl> </li> </ul> <a name="getKeyspaceDefinitions()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyspaceDefinitions</h4> <pre>public java.util.Collection<<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a>> getKeyspaceDefinitions()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>collection of the metadata about all keyspaces registered in the system (system and non-system)</dd></dl> </li> </ul> <a name="setKeyspaceDefinition(org.apache.cassandra.config.KSMetaData)">  </a> <ul class="blockList"> <li class="blockList"> <h4>setKeyspaceDefinition</h4> <pre>public void setKeyspaceDefinition(<a href="../../../../org/apache/cassandra/config/KSMetaData.html" title="class in org.apache.cassandra.config">KSMetaData</a> ksm)</pre> <div class="block">Update (or insert) new keyspace definition</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ksm</code> - The metadata about keyspace</dd></dl> </li> </ul> <a name="getCF(java.util.UUID)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCF</h4> <pre>public <a href="../../../../org/apache/cassandra/utils/Pair.html" title="class in org.apache.cassandra.utils">Pair</a><java.lang.String,java.lang.String> getCF(java.util.UUID cfId)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfId</code> - The identifier of the ColumnFamily to lookup</dd> <dt><span class="strong">Returns:</span></dt><dd>The (ksname,cfname) pair for the given id, or null if it has been dropped.</dd></dl> </li> </ul> <a name="getId(java.lang.String, java.lang.String)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getId</h4> <pre>public java.util.UUID getId(java.lang.String ksName, java.lang.String cfName)</pre> <div class="block">Lookup keyspace/ColumnFamily identifier</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>ksName</code> - The keyspace name</dd><dd><code>cfName</code> - The ColumnFamily name</dd> <dt><span class="strong">Returns:</span></dt><dd>The id for the given (ksname,cfname) pair, or null if it has been dropped.</dd></dl> </li> </ul> <a name="load(org.apache.cassandra.config.CFMetaData)">  </a> <ul class="blockList"> <li class="blockList"> <h4>load</h4> <pre>public void load(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm)</pre> <div class="block">Load individual ColumnFamily Definition to the schema (to make ColumnFamily lookup faster)</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfm</code> - The ColumnFamily definition to load</dd></dl> </li> </ul> <a name="purge(org.apache.cassandra.config.CFMetaData)">  </a> <ul class="blockList"> <li class="blockList"> <h4>purge</h4> <pre>public void purge(<a href="../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm)</pre> <div class="block">Used for ColumnFamily data eviction out from the schema</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfm</code> - The ColumnFamily Definition to evict</dd></dl> </li> </ul> <a name="getVersion()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getVersion</h4> <pre>public java.util.UUID getVersion()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>current schema version</dd></dl> </li> </ul> <a name="updateVersion()">  </a> <ul class="blockList"> <li class="blockList"> <h4>updateVersion</h4> <pre>public void updateVersion()</pre> <div class="block">Read schema from system keyspace and calculate MD5 digest of every row, resulting digest will be converted into UUID which would act as content-based version of the schema.</div> </li> </ul> <a name="updateVersionAndAnnounce()">  </a> <ul class="blockList"> <li class="blockList"> <h4>updateVersionAndAnnounce</h4> <pre>public void updateVersionAndAnnounce()</pre> </li> </ul> <a name="clear()">  </a> <ul class="blockList"> <li class="blockList"> <h4>clear</h4> <pre>public void clear()</pre> <div class="block">Clear all KS/CF metadata and reset version.</div> </li> </ul> <a name="invalidSchemaRow(org.apache.cassandra.db.Row)">  </a> <ul class="blockList"> <li class="blockList"> <h4>invalidSchemaRow</h4> <pre>public static boolean invalidSchemaRow(<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> row)</pre> </li> </ul> <a name="ignoredSchemaRow(org.apache.cassandra.db.Row)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>ignoredSchemaRow</h4> <pre>public static boolean ignoredSchemaRow(<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> row)</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <div class="bottomNav"><a name="navbar_bottom">  </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Schema.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/apache/cassandra/config/RequestSchedulerOptions.html" title="class in org.apache.cassandra.config"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/config/SeedProviderDef.html" title="class in org.apache.cassandra.config"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/config/Schema.html" target="_top">Frames</a></li> <li><a href="Schema.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>