Class: TableMetadata

metadata~ TableMetadata

Describes a table

Constructor

new TableMetadata(name)

Creates a new instance of TableMetadata
Extends:
Parameters:
Name Type Description
name String Name of the Table

Extends

Members

bloomFilterFalsePositiveChance :number

False-positive probability for SSTable Bloom filters.
Type:
  • number
Inherited From:
Overrides:

caching :String

Level of caching: all, keys_only, rows_only, none
Type:
  • String
Inherited From:
Overrides:

clusteringKeys :Array

Array describing the columns that form the clustering key.
Type:
  • Array
Inherited From:
Overrides:

clusteringOrder :Array

Array describing the clustering order of the columns in the same order as the clusteringKeys.
Type:
  • Array
Inherited From:
Overrides:

columns :Array

Array describing the table columns.
Type:
  • Array
Inherited From:
Overrides:

columnsByName :Object

An associative Array of columns by name.
Type:
  • Object
Inherited From:
Overrides:

comment :String

A human readable comment describing the table.
Type:
  • String
Inherited From:
Overrides:

compactionClass :String

Compaction strategy class used for the table.
Type:
  • String
Inherited From:
Overrides:

compactionOptions :Object

Associative-array containing the compaction options keys and values.
Type:
  • Object
Inherited From:
Overrides:

compression :Object

Associative-array containing the compression options.
Type:
  • Object
Inherited From:
Overrides:

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 Cassandra versions prior to 3.0.0, this method always returns {@code null}.

Type:
  • Number | null
Inherited From:
Overrides:

defaultTtl :Number

Returns the default TTL for this table.

Note: this option is not available in Cassandra 1.2 and will return 0 (no default TTL) when connected to 1.2 nodes.

Type:
  • Number
Inherited From:
Overrides:

extensions :Object

An associative Array containing extra metadata for the table.

For Cassandra versions prior to 3.0.0, this method always returns {@code null}.

Type:
  • Object
Inherited From:
Overrides:

gcGraceSeconds :number

Specifies the time to wait before garbage collecting tombstones (deletion markers)
Type:
  • number
Inherited From:
Overrides:

indexes :Array.<Index>

Type:
  • Array.<Index>

indexInterval :Number|null

Returns the index interval option for this table.

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

Type:
  • Number | null

isCompact :Boolean

Determines whether the table uses the COMPACT STORAGE option.
Type:
  • Boolean

localReadRepairChance :number

Specifies the probability of read repairs being invoked over all replicas in the current data center.
Type:
  • number
Inherited From:
Overrides:

maxIndexInterval :Number|null

Returns the maximum index interval option for this table.

Note: this option is available in Cassandra 2.1 and above, and will return {@code null} for earlier versions.

Type:
  • Number | null
Inherited From:
Overrides:

memtableFlushPeriod :Number

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

Note: this option is available only on Cassandra 2.x and will return 0 (no periodic flush) when connected to 1.2 nodes.

Type:
  • Number

minIndexInterval :Number|null

Returns the minimum index interval option for this table.

Note: this option is available in Cassandra 2.1 and above, and will return {@code null} for earlier versions.

Type:
  • Number | null
Inherited From:
Overrides:

name :String

Name of the object
Type:
  • String
Inherited From:
Overrides:

partitionKeys :Array

Array describing the columns that are part of the partition key.
Type:
  • Array
Inherited From:
Overrides:

populateCacheOnFlush :Boolean

Whether the populate I/O cache on flush is set on this table.
Type:
  • Boolean
Inherited From:
Overrides:

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:
Overrides:

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

speculativeRetry :String

* Returns the speculative retry option for this table.

Note: this option is not available in Cassandra 1.2 and will return "NONE" (no speculative retry) when connected to 1.2 nodes.

Type:
  • String
Inherited From:
Overrides: