Class: TableMetadata

metadata~TableMetadata(name)

Describes a table

Constructor

new TableMetadata(name)

Creates a new instance of TableMetadata

Extends:
Parameters:
Name Type Description
name String

Name of the Table

Source:

Extends

Members

bloomFilterFalsePositiveChance :number

False-positive probability for SSTable Bloom filters.

Type:
  • number
Inherited From:
Source:

caching :String

Level of caching: all, keys_only, rows_only, none

Type:
  • String
Inherited From:
Source:

cdc :Boolean|null

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

Type:
  • Boolean | null
Source:

clusteringKeys :Array

Array describing the columns that form the clustering key.

Type:
  • Array
Inherited From:
Source:

clusteringOrder :Array

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

Type:
  • Array
Inherited From:
Source:

columns :Array

Array describing the table columns.

Type:
  • Array
Inherited From:
Source:

columnsByName :Object

An associative Array of columns by name.

Type:
  • Object
Inherited From:
Source:

comment :String

A human readable comment describing the table.

Type:
  • String
Inherited From:
Source:

compactionClass :String

Compaction strategy class used for the table.

Type:
  • String
Inherited From:
Source:

compactionOptions :Object

Associative-array containing the compaction options keys and values.

Type:
  • Object
Inherited From:
Source:

compression :Object

Associative-array containing the compression options.

Type:
  • Object
Inherited From:
Source:

crcCheckChance :Number|null

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.

Type:
  • Number | null
Inherited From:
Source:

defaultTtl :Number

Returns the default TTL for this table.

Type:
  • Number
Inherited From:
Source:

extensions :Object

An associative Array containing extra metadata for the table.

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

Type:
  • Object
Inherited From:
Source:

gcGraceSeconds :number

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

Type:
  • number
Inherited From:
Source:

indexInterval :Number|null

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.

Type:
  • Number | null
Source:

indexes :Array.<Index>

Type:
  • Array.<Index>
Source:

isCompact :Boolean

Determines whether the table uses the COMPACT STORAGE option.

Type:
  • Boolean
Source:

localReadRepairChance :number

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

Type:
  • number
Inherited From:
Source:

maxIndexInterval :Number|null

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.

Type:
  • Number | null
Inherited From:
Source:

memtableFlushPeriod :Number

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

Type:
  • Number
Source:

minIndexInterval :Number|null

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.

Type:
  • Number | null
Inherited From:
Source:

name :String

Name of the object

Type:
  • String
Inherited From:
Source:

nodesync :Object

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}.

Type:
  • Object
Inherited From:
Source:

partitionKeys :Array

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

Type:
  • Array
Inherited From:
Source:

populateCacheOnFlush :Boolean

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

Type:
  • Boolean
Inherited From:
Source:

readRepairChance :number

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

Type:
  • number
Inherited From:
Source:

replicateOnWrite :Boolean

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.

Type:
  • Boolean
Source:

speculativeRetry :String

  • Returns the speculative retry option for this table.
Type:
  • String
Inherited From:
Source:

virtual :Boolean

Determines whether the table is a virtual table or not.

Type:
  • Boolean
Source: