com.datastax.driver.core

Class TableMetadata

java.lang.Object

com.datastax.driver.core.TableMetadata

public class TableMetadata
extends Object

Describes a Table.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableMetadata.Options
static class	TableMetadata.Order Clustering orders.

Method Summary

Modifier and Type	Method and Description
String	asCQLQuery() Returns a CQL query representing this table.
boolean	equals(Object o)
String	exportAsString() Returns a String containing CQL queries representing this table and the index on it.
List<ColumnMetadata>	getClusteringColumns() Returns the list of clustering columns for this table.
List<TableMetadata.Order>	getClusteringOrder() Returns the clustering order for this table.
ColumnMetadata	getColumn(String name) Returns metadata on a column of this table.
List<ColumnMetadata>	getColumns() Returns a list containing all the columns of this table.
UUID	getId() Returns the unique id of this table.
KeyspaceMetadata	getKeyspace() Returns the keyspace this table belong to.
String	getName() Returns the name of this table.
TableMetadata.Options	getOptions() Returns the options for this table.
List<ColumnMetadata>	getPartitionKey() Returns the list of columns composing the partition key for this table.
List<ColumnMetadata>	getPrimaryKey() Returns the list of columns composing the primary key for this table.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

Returns the name of this table.

Returns:

the name of this CQL table.

getId

public UUID getId()

Returns the unique id of this table.

Note: this id is available in Cassandra 2.1 and above. It will be null for earlier versions.

Returns:

the unique id of the table.

getKeyspace

public KeyspaceMetadata getKeyspace()

Returns the keyspace this table belong to.

Returns:

the keyspace metadata of the keyspace this table belong to.

getColumn

public ColumnMetadata getColumn(String name)

Returns metadata on a column of this table.

Parameters:

name - the name of the column to retrieve (name will be interpreted as a case-insensitive identifier unless enclosed in double-quotes, see Metadata.quote(java.lang.String)).

Returns:

the metadata for the name column if it exists, or null otherwise.

getColumns

public List<ColumnMetadata> getColumns()

Returns a list containing all the columns of this table.

The order of the columns in the list is consistent with the order of the columns returned by a SELECT * FROM thisTable: the first column is the partition key, next are the clustering columns in their defined order, and then the rest of the columns follow in alphabetic order.

Returns:

a list containing the metadata for the columns of this table.

getPrimaryKey

public List<ColumnMetadata> getPrimaryKey()

Returns the list of columns composing the primary key for this table.

A table will always at least have a partition key (that may itself be one or more columns), so the returned list at least has one element.

Returns:

the list of columns composing the primary key for this table.

getPartitionKey

public List<ColumnMetadata> getPartitionKey()

Returns the list of columns composing the partition key for this table.

A table always has a partition key so the returned list has at least one element.

Returns:

the list of columns composing the partition key for this table.

getClusteringColumns

public List<ColumnMetadata> getClusteringColumns()

Returns the list of clustering columns for this table.

Returns:

the list of clustering columns for this table. If there is no clustering columns, an empty list is returned.

getClusteringOrder

public List<TableMetadata.Order> getClusteringOrder()

Returns the clustering order for this table.

The returned contains the clustering order of each clustering column. The ith element of the result correspond to the order (ascending or descending) of the ith clustering column (see getClusteringColumns()). Note that a table defined without any particular clustering order is equivalent to one for which all the clustering key are in ascending order.

Returns:

a list with the clustering order for each clustering column.

getOptions

public TableMetadata.Options getOptions()

Returns the options for this table.

Returns:

the options for this table.

exportAsString

public String exportAsString()

Returns a String containing CQL queries representing this table and the index on it.

In other words, this method returns the queries that would allow you to recreate the schema of this table, along with the index defined on columns of this table.

Note that the returned String is formatted to be human readable (for some definition of human readable at least).

Returns:

the CQL queries representing this table schema as a {code String}.

asCQLQuery

public String asCQLQuery()

Returns a CQL query representing this table.

This method returns a single 'CREATE TABLE' query with the options corresponding to this table definition.

Note that the returned string is a single line; the returned query is not formatted in any way.

Returns:

the 'CREATE TABLE' query corresponding to this table.

See Also:

exportAsString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object