com.datastax.driver.core

Class TableMetadata

java.lang.Object

com.datastax.driver.core.AbstractTableMetadata

com.datastax.driver.core.TableMetadata

public class TableMetadata
extends AbstractTableMetadata

Describes a Table.

Field Summary

Fields inherited from class com.datastax.driver.core.AbstractTableMetadata

cassandraVersion, clusteringColumns, clusteringOrder, columns, id, keyspace, name, options, partitionKey

Method Summary

Modifier and Type	Method and Description
String	asCQLQuery() Returns a single CQL statement representing this table.
protected String	asCQLQuery(boolean formatted)
boolean	equals(Object other)
String	exportAsString() Returns a String containing CQL statements representing this table and all of its derived resources, such as secondary indexes or materialized views.
IndexMetadata	getIndex(String name) Returns metadata on a index of this table.
Collection<IndexMetadata>	getIndexes() Returns all indexes based on this table.
MaterializedViewMetadata	getView(String name) Returns metadata on a view of this table.
Collection<MaterializedViewMetadata>	getViews() Returns all views based on this table.
int	hashCode()

Methods inherited from class com.datastax.driver.core.AbstractTableMetadata

appendOptions, getClusteringColumns, getClusteringOrder, getColumn, getColumns, getId, getKeyspace, getName, getOptions, getPartitionKey, getPrimaryKey, isVirtual, toString

Methods inherited from class java.lang.Object

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

Method Detail

getIndex

public IndexMetadata getIndex(String name)

Returns metadata on a index of this table.

Parameters:

name - the name of the index 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 index if it exists, or null otherwise.

getIndexes

public Collection<IndexMetadata> getIndexes()

Returns all indexes based on this table.

Returns:

all indexes based on this table.

getView

public MaterializedViewMetadata getView(String name)

Returns metadata on a view of this table.

Parameters:

name - the name of the view 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 view if it exists, or null otherwise.

getViews

public Collection<MaterializedViewMetadata> getViews()

Returns all views based on this table.

Returns:

all views based on this table.

exportAsString

public String exportAsString()

Returns a String containing CQL statements representing this table and all of its derived resources, such as secondary indexes or materialized views.

In other words, this method returns the statements that would allow you to recreate the complete schema of this table, along with the secondary indexes and materialized views defined on it, if any.

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

Overrides:

exportAsString in class AbstractTableMetadata

Returns:

the CQL statements representing this table as a String.

See Also:

asCQLQuery()

asCQLQuery

public String asCQLQuery()

Returns a single CQL statement representing this table.

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

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

Overrides:

asCQLQuery in class AbstractTableMetadata

Returns:

the CREATE TABLE statement corresponding to this table.

See Also:

exportAsString()

asCQLQuery

protected String asCQLQuery(boolean formatted)

Specified by:

asCQLQuery in class AbstractTableMetadata

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object