TableMetadata (apache-cassandra API)

java.lang.Object
- org.apache.cassandra.schema.TableMetadata

public final class TableMetadata
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TableMetadata.Builder

static class TableMetadata.Flag

static class TableMetadata.Kind

Nested Classes
Modifier and Type	Class and Description
`static class`	`TableMetadata.Builder`
`static class`	`TableMetadata.Flag`
`static class`	`TableMetadata.Kind`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPACT_STORAGE_HALT_MESSAGE`
`ColumnMetadata`	`compactValueColumn`
`ClusteringComparator`	`comparator`
`com.google.common.collect.ImmutableMap<java.nio.ByteBuffer,DroppedColumn>`	`droppedColumns`
`com.google.common.collect.ImmutableSet<TableMetadata.Flag>`	`flags`
`TableId`	`id`
`Indexes`	`indexes`
`java.lang.String`	`keyspace`
`TableMetadata.Kind`	`kind`
`java.lang.String`	`name`
`TableParams`	`params`
`IPartitioner`	`partitioner`
`AbstractType<?>`	`partitionKeyType`
`DataResource`	`resource`
`Triggers`	`triggers`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Iterator<ColumnMetadata>`	`allColumnsInSelectOrder()`
`static TableMetadata.Builder`	`builder(java.lang.String keyspace, java.lang.String table)`
`static TableMetadata.Builder`	`builder(java.lang.String keyspace, java.lang.String table, TableId id)`
`com.google.common.collect.ImmutableList<ColumnMetadata>`	`clusteringColumns()`
`AbstractType<?>`	`columnDefinitionNameComparator(ColumnMetadata.Kind kind)`
`com.google.common.collect.ImmutableCollection<ColumnMetadata>`	`columns()`
`boolean`	`enforceStrictLiveness()` A table with strict liveness filters/ignores rows without PK liveness info, effectively tying the row liveness to its primary key liveness.
`boolean`	`equals(java.lang.Object o)`
`ColumnMetadata`	`getColumn(java.nio.ByteBuffer name)`
`ColumnMetadata`	`getColumn(ColumnIdentifier name)` Returns the ColumnMetadata for `name`.
`ColumnMetadata`	`getDroppedColumn(java.nio.ByteBuffer name)`
`ColumnMetadata`	`getDroppedColumn(java.nio.ByteBuffer name, boolean isStatic)` Returns a "fake" ColumnMetadata corresponding to the dropped column `name` of `null` if there is no such dropped column.
`int`	`hashCode()`
`boolean`	`hasStaticColumns()`
`java.util.Optional<java.lang.String>`	`indexName()`
`java.lang.String`	`indexTableName(IndexMetadata info)` Generate a table name for an index corresponding to the given column.
`boolean`	`isCompactTable()`
`boolean`	`isCompound()`
`boolean`	`isCounter()`
`boolean`	`isCQLTable()`
`boolean`	`isDense()`
`boolean`	`isIndex()`
`boolean`	`isStaticCompactTable()`
`boolean`	`isSuper()`
`boolean`	`isView()`
`boolean`	`isVirtual()`
`static TableMetadata`	`minimal(java.lang.String keyspace, java.lang.String name)` There is a couple of places in the code where we need a TableMetadata object and don't have one readily available and know that only the keyspace and name matter.
`ClusteringComparator`	`partitionKeyAsClusteringComparator()`
`com.google.common.collect.ImmutableList<ColumnMetadata>`	`partitionKeyColumns()`
`java.lang.Iterable<ColumnMetadata>`	`primaryKeyColumns()`
`RegularAndStaticColumns`	`regularAndStaticColumns()`
`Columns`	`regularColumns()`
`Columns`	`staticColumns()`
`java.lang.String`	`toDebugString()`
`java.lang.String`	`toString()`
`TableMetadata.Builder`	`unbuild()`
`TableMetadata`	`updateIndexTableMetadata(TableParams baseTableParams)`
`void`	`validate()`
`TableMetadata`	`withSwapped(Indexes indexes)`
`TableMetadata`	`withSwapped(TableParams params)`
`TableMetadata`	`withSwapped(Triggers triggers)`
`TableMetadata`	`withUpdatedUserType(UserType udt)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMPACT_STORAGE_HALT_MESSAGE

public static final java.lang.String COMPACT_STORAGE_HALT_MESSAGE

See Also:: Constant Field Values

keyspace
```
public final java.lang.String keyspace
```

name
```
public final java.lang.String name
```

id
```
public final TableId id
```

partitioner
```
public final IPartitioner partitioner
```

kind
```
public final TableMetadata.Kind kind
```

params
```
public final TableParams params
```

flags

public final com.google.common.collect.ImmutableSet<TableMetadata.Flag> flags

droppedColumns

public final com.google.common.collect.ImmutableMap<java.nio.ByteBuffer,DroppedColumn> droppedColumns

indexes
```
public final Indexes indexes
```

triggers
```
public final Triggers triggers
```

partitionKeyType

public final AbstractType<?> partitionKeyType

comparator

public final ClusteringComparator comparator

compactValueColumn

public final ColumnMetadata compactValueColumn

resource
```
public final DataResource resource
```

Method Detail

builder

public static TableMetadata.Builder builder(java.lang.String keyspace,
                                            java.lang.String table)

builder

public static TableMetadata.Builder builder(java.lang.String keyspace,
                                            java.lang.String table,
                                            TableId id)

unbuild

public TableMetadata.Builder unbuild()

isIndex
```
public boolean isIndex()
```

withSwapped

public TableMetadata withSwapped(TableParams params)

withSwapped

public TableMetadata withSwapped(Triggers triggers)

withSwapped

public TableMetadata withSwapped(Indexes indexes)

isView
```
public boolean isView()
```

isVirtual
```
public boolean isVirtual()
```

indexName

public java.util.Optional<java.lang.String> indexName()

isDense
```
public boolean isDense()
```

isCompound
```
public boolean isCompound()
```

isSuper
```
public boolean isSuper()
```

isCounter
```
public boolean isCounter()
```

isCQLTable
```
public boolean isCQLTable()
```

isCompactTable
```
public boolean isCompactTable()
```

isStaticCompactTable
```
public boolean isStaticCompactTable()
```

columns

public com.google.common.collect.ImmutableCollection<ColumnMetadata> columns()

primaryKeyColumns

public java.lang.Iterable<ColumnMetadata> primaryKeyColumns()

partitionKeyColumns

public com.google.common.collect.ImmutableList<ColumnMetadata> partitionKeyColumns()

clusteringColumns

public com.google.common.collect.ImmutableList<ColumnMetadata> clusteringColumns()

regularAndStaticColumns

public RegularAndStaticColumns regularAndStaticColumns()

regularColumns
```
public Columns regularColumns()
```

staticColumns
```
public Columns staticColumns()
```

allColumnsInSelectOrder

public java.util.Iterator<ColumnMetadata> allColumnsInSelectOrder()

getColumn

public ColumnMetadata getColumn(ColumnIdentifier name)

Returns the ColumnMetadata for name.

getColumn

public ColumnMetadata getColumn(java.nio.ByteBuffer name)

getDroppedColumn

public ColumnMetadata getDroppedColumn(java.nio.ByteBuffer name)

getDroppedColumn
```
public ColumnMetadata getDroppedColumn(java.nio.ByteBuffer name,
                                       boolean isStatic)
```
Returns a "fake" ColumnMetadata corresponding to the dropped column name of null if there is no such dropped column.

Parameters:

name - - the column name

isStatic - - whether the column was a static column, if known

hasStaticColumns
```
public boolean hasStaticColumns()
```

validate
```
public void validate()
```

partitionKeyAsClusteringComparator

public ClusteringComparator partitionKeyAsClusteringComparator()

columnDefinitionNameComparator

public AbstractType<?> columnDefinitionNameComparator(ColumnMetadata.Kind kind)

indexTableName
```
public java.lang.String indexTableName(IndexMetadata info)
```
Generate a table name for an index corresponding to the given column. This is NOT the same as the index's name! This is only used in sstable filenames and is not exposed to users.

Parameters:

info - A definition of the column with index

Returns:

name of the index table

minimal
```
public static TableMetadata minimal(java.lang.String keyspace,
                                    java.lang.String name)
```
There is a couple of places in the code where we need a TableMetadata object and don't have one readily available and know that only the keyspace and name matter. This creates such "fake" metadata. Use only if you know what you're doing.

updateIndexTableMetadata

public TableMetadata updateIndexTableMetadata(TableParams baseTableParams)

withUpdatedUserType

public TableMetadata withUpdatedUserType(UserType udt)

equals
```
public boolean equals(java.lang.Object o)
```
Overrides:

equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

toDebugString

public java.lang.String toDebugString()

enforceStrictLiveness
```
public boolean enforceStrictLiveness()
```
A table with strict liveness filters/ignores rows without PK liveness info, effectively tying the row liveness to its primary key liveness. Currently this is only used by views with normal base column as PK column so updates to other columns do not make the row live when the base column is not live. See CASSANDRA-11500. TODO: does not belong here, should be gone

Class TableMetadata

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPACT_STORAGE_HALT_MESSAGE

keyspace

name

id

partitioner

kind

params

flags

droppedColumns

indexes

triggers

partitionKeyType

comparator

compactValueColumn

resource

Method Detail

builder

builder

unbuild

isIndex

withSwapped

withSwapped

withSwapped

isView

isVirtual

indexName

isDense

isCompound

isSuper

isCounter

isCQLTable

isCompactTable

isStaticCompactTable

columns

primaryKeyColumns

partitionKeyColumns

clusteringColumns

regularAndStaticColumns

regularColumns

staticColumns

allColumnsInSelectOrder

getColumn

getColumn

getDroppedColumn

getDroppedColumn

hasStaticColumns

validate

partitionKeyAsClusteringComparator

columnDefinitionNameComparator

indexTableName

minimal

updateIndexTableMetadata

withUpdatedUserType

equals

hashCode

toString

toDebugString

enforceStrictLiveness