final class DefaultTable implements Table (View source)

A PHP representation of a table

Methods

string
name()

Returns the name of this table

option(string $name)

Return a table's option by name

array
options()

Returns all the table's options

string
comment()

Description of the table, if any

float
readRepairChance()

Returns read repair chance

float
localReadRepairChance()

Returns local read repair chance

int
gcGraceSeconds()

Returns GC grace seconds

string
caching()

Returns caching options

float
bloomFilterFPChance()

Returns bloom filter FP chance

int
memtableFlushPeriodMs()

Returns memtable flush period in milliseconds

int
defaultTTL()

Returns default TTL.

string
speculativeRetry()

Returns speculative retry.

int
indexInterval()

Returns index interval

string
compactionStrategyClassName()

Returns compaction strategy class name

Map
compactionStrategyOptions()

Returns compaction strategy options

Map
compressionParameters()

Returns compression parameters

bool
populateIOCacheOnFlush()

Returns whether or not the populate_io_cache_on_flush is true

bool
replicateOnWrite()

Returns whether or not the replicate_on_write is true

int
maxIndexInterval()

Returns the value of max_index_interval

int
minIndexInterval()

Returns the value of min_index_interval

column(string $name)

Returns column by name

array
columns()

Returns all columns in this table

array
partitionKey()

Returns the partition key columns of the table

array
primaryKey()

Returns both the partition and clustering key columns of the table

array
clusteringKey()

Returns the clustering key columns of the table

array
clusteringOrder()

No description

Index|null
index(string $name)

Get an index by name

array
indexes()

Gets all indexes

materializedView(string $name)

Get materialized view by name

array
materializedViews()

Gets all materialized views

Details

string name()

Returns the name of this table

Return Value

string

Name of the table

Value option(string $name)

Return a table's option by name

Parameters

string $name

The name of the option

Return Value

Value

Value of an option by name

array options()

Returns all the table's options

Return Value

array

A dictionary of string and Value pairs of the table's options.

string comment()

Description of the table, if any

Return Value

string

Table description or null

float readRepairChance()

Returns read repair chance

Return Value

float

Read repair chance

float localReadRepairChance()

Returns local read repair chance

Return Value

float

Local read repair chance

int gcGraceSeconds()

Returns GC grace seconds

Return Value

int

GC grace seconds

string caching()

Returns caching options

Return Value

string

Caching options

float bloomFilterFPChance()

Returns bloom filter FP chance

Return Value

float

Bloom filter FP chance

int memtableFlushPeriodMs()

Returns memtable flush period in milliseconds

Return Value

int

Memtable flush period in milliseconds

int defaultTTL()

Returns default TTL.

Return Value

int

Default TTL.

string speculativeRetry()

Returns speculative retry.

Return Value

string

Speculative retry.

int indexInterval()

Returns index interval

Return Value

int

Index interval

string compactionStrategyClassName()

Returns compaction strategy class name

Return Value

string

Compaction strategy class name

Map compactionStrategyOptions()

Returns compaction strategy options

Return Value

Map

Compaction strategy options

Map compressionParameters()

Returns compression parameters

Return Value

Map

Compression parameters

bool populateIOCacheOnFlush()

Returns whether or not the populate_io_cache_on_flush is true

Return Value

bool

Value of populate_io_cache_on_flush or null

bool replicateOnWrite()

Returns whether or not the replicate_on_write is true

Return Value

bool

Value of replicate_on_write or null

int maxIndexInterval()

Returns the value of max_index_interval

Return Value

int

Value of max_index_interval or null

int minIndexInterval()

Returns the value of min_index_interval

Return Value

int

Value of min_index_interval or null

Column column(string $name)

Returns column by name

Parameters

string $name

Name of the column

Return Value

Column

Column instance

array columns()

Returns all columns in this table

Return Value

array

A list of Column instances

array partitionKey()

Returns the partition key columns of the table

Return Value

array

A list of Column instances

array primaryKey()

Returns both the partition and clustering key columns of the table

Return Value

array

A list of Column instances

array clusteringKey()

Returns the clustering key columns of the table

Return Value

array

A list of Column instances

array clusteringOrder()

No description

Return Value

array

A list of cluster column orders ('asc' and 'desc')

Index|null index(string $name)

Get an index by name

Parameters

string $name

Index name

Return Value

Index|null

An index or null

array indexes()

Gets all indexes

Return Value

array

An array of indexes

MaterializedView|null materializedView(string $name)

Get materialized view by name

Parameters

string $name

Materialized view name

Return Value

MaterializedView|null

A materialized view or null

array materializedViews()

Gets all materialized views

Return Value

array

An array of materialized views