Describes a table

Augments

Members

number

bloomFilterFalsePositiveChance

False-positive probability for SSTable Bloom filters.

String

caching

Level of caching: all, keys_only, rows_only, none

Boolean or null

cdc

Determines whether the Change Data Capture (CDC) flag is set for the table.

Array

clusteringKeys

Array describing the columns that form the clustering key.

Array

clusteringOrder

Array describing the clustering order of the columns in the same order as the clusteringKeys.

Array

columns

Array describing the table columns.

Object

columnsByName

An associative Array of columns by name.

String

comment

A human readable comment describing the table.

String

compactionClass

Compaction strategy class used for the table.

Object

compactionOptions

Associative-array containing the compaction options keys and values.

Object

compression

Associative-array containing the compression options.

Number or null

crcCheckChance

When compression is enabled, this option defines the probability with which checksums for compressed blocks are checked during reads. The default value for this options is 1.0 (always check).

For Apache Cassandra versions prior to 3.0.0, this method always returns null.

Number

defaultTtl

Returns the default TTL for this table.

Object

extensions

An associative Array containing extra metadata for the table.

For Apache Cassandra versions prior to 3.0.0, this method always returns null.

number

gcGraceSeconds

Specifies the time to wait before garbage collecting tombstones (deletion markers)

Number or null

indexInterval

Returns the index interval option for this table.

Note: this option is only available in Apache Cassandra 2.0. It is deprecated in Apache Cassandra 2.1 and above, and will therefore return null for 2.1 nodes.

Array<Index>

indexes

Boolean

isCompact

Determines whether the table uses the COMPACT STORAGE option.

number

localReadRepairChance

Specifies the probability of read repairs being invoked over all replicas in the current data center.

Number or null

maxIndexInterval

Returns the maximum index interval option for this table.

Note: this option is available in Apache Cassandra 2.1 and above, and will return null for earlier versions.

Number

memtableFlushPeriod

Returns the memtable flush period (in milliseconds) option for this table.

Number or null

minIndexInterval

Returns the minimum index interval option for this table.

Note: this option is available in Apache Cassandra 2.1 and above, and will return null for earlier versions.

String

name

Name of the object

Object

nodesync

An associative Array containing nodesync options for this table.

For DSE versions prior to 6.0.0, this method always returns {@code null}. If nodesync was not explicitly configured for this table this method will also return {@code null}.

Array

partitionKeys

Array describing the columns that are part of the partition key.

Boolean

populateCacheOnFlush

Whether the populate I/O cache on flush is set on this table.

number

readRepairChance

Specifies the probability with which read repairs should be invoked on non-quorum reads. The value must be between 0 and 1.

Boolean

replicateOnWrite

Applies only to counter tables. When set to true, replicates writes to all affected replicas regardless of the consistency level specified by the client for a write request. For counter tables, this should always be set to true.

String

speculativeRetry

  • Returns the speculative retry option for this table.
Boolean

virtual

Determines whether the table is a virtual table or not.

Constructor

new

TableMetadata

(String name)

Creates a new instance of TableMetadata

Parameters:
Name Type Description
name String

Name of the Table