Class: DataCollection

(abstract) metadata~DataCollection(name)

Describes a table or a view

Constructor

(abstract) new DataCollection(name)

Creates a new instance of DataCollection

Parameters:
Name Type Description
name String

Name of the data object.

Source:

Members

bloomFilterFalsePositiveChance :number

False-positive probability for SSTable Bloom filters.

Type:
  • number
Source:

caching :String

Level of caching: all, keys_only, rows_only, none

Type:
  • String
Source:

clusteringKeys :Array

Array describing the columns that form the clustering key.

Type:
  • Array
Source:

clusteringOrder :Array

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

Type:
  • Array
Source:

columns :Array

Array describing the table columns.

Type:
  • Array
Source:

columnsByName :Object

An associative Array of columns by name.

Type:
  • Object
Source:

comment :String

A human readable comment describing the table.

Type:
  • String
Source:

compactionClass :String

Compaction strategy class used for the table.

Type:
  • String
Source:

compactionOptions :Object

Associative-array containing the compaction options keys and values.

Type:
  • Object
Source:

compression :Object

Associative-array containing the compression options.

Type:
  • Object
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
Source:

defaultTtl :Number

Returns the default TTL for this table.

Type:
  • Number
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
Source:

gcGraceSeconds :number

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

Type:
  • number
Source:

localReadRepairChance :number

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

Type:
  • number
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
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
Source:

name :String

Name of the object

Type:
  • String
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
Source:

partitionKeys :Array

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

Type:
  • Array
Source:

populateCacheOnFlush :Boolean

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

Type:
  • Boolean
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
Source:

speculativeRetry :String

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