PHP Interface Cassandra\Table

Show file Open project: datastax/php-driver

Public Methods

Method Description
bloomFilterFPChance ( ) : float Returns bloom filter FP chance
caching ( ) : string Returns caching options
clusteringKey ( ) : array Returns the clustering key columns of the table
clusteringOrder ( ) : array
column ( string $name ) : Cassandra\Column Returns column by name
columns ( ) : array Returns all columns in this table
comment ( ) : string Description of the table, if any
compactionStrategyClassName ( ) : string Returns compaction strategy class name
compactionStrategyOptions ( ) : Cassandra\Map Returns compaction strategy options
compressionParameters ( ) : Cassandra\Map Returns compression parameters
defaultTTL ( ) : integer Returns default TTL.
gcGraceSeconds ( ) : integer Returns GC grace seconds
indexInterval ( ) : integer Returns index interval
localReadRepairChance ( ) : float Returns local read repair chance
maxIndexInterval ( ) : integer Returns the value of max_index_interval
memtableFlushPeriodMs ( ) : integer Returns memtable flush period in milliseconds
minIndexInterval ( ) : integer Returns the value of min_index_interval
name ( ) : string Returns the name of this table
option ( $name ) : Cassandra\Value Return a table's option by name
options ( ) : array Returns all the table's options
partitionKey ( ) : array Returns the partition key columns of the table
populateIOCacheOnFlush ( ) : boolean Returns whether or not the populate_io_cache_on_flush is true
primaryKey ( ) : array Returns both the partition and clustering key columns of the table
readRepairChance ( ) : float Returns read repair chance
replicateOnWrite ( ) : boolean Returns whether or not the replicate_on_write is true
speculativeRetry ( ) : string Returns speculative retry.

Method Details

bloomFilterFPChance() public method

Returns bloom filter FP chance
public bloomFilterFPChance ( ) : float
return float Bloom filter FP chance

caching() public method

Returns caching options
public caching ( ) : string
return string Caching options

clusteringKey() public method

Returns the clustering key columns of the table
public clusteringKey ( ) : array
return array A list of of `Cassandra\Column` instances

clusteringOrder() public method

public clusteringOrder ( ) : array
return array A list of cluster column orders ('asc' and 'desc')

column() public method

Returns column by name
public column ( string $name ) : Cassandra\Column
$name string Name of the column
return Cassandra\Column Column instance

columns() public method

Returns all columns in this table
public columns ( ) : array
return array A list of `Cassandra\Column` instances

comment() public method

Description of the table, if any
public comment ( ) : string
return string Table description or null

compactionStrategyClassName() public method

Returns compaction strategy class name
public compactionStrategyClassName ( ) : string
return string Compaction strategy class name

compactionStrategyOptions() public method

Returns compaction strategy options
public compactionStrategyOptions ( ) : Cassandra\Map
return Cassandra\Map Compaction strategy options

compressionParameters() public method

Returns compression parameters
public compressionParameters ( ) : Cassandra\Map
return Cassandra\Map Compression parameters

defaultTTL() public method

Returns default TTL.
public defaultTTL ( ) : integer
return integer Default TTL.

gcGraceSeconds() public method

Returns GC grace seconds
public gcGraceSeconds ( ) : integer
return integer GC grace seconds

indexInterval() public method

Returns index interval
public indexInterval ( ) : integer
return integer Index interval

localReadRepairChance() public method

Returns local read repair chance
public localReadRepairChance ( ) : float
return float Local read repair chance

maxIndexInterval() public method

Returns the value of max_index_interval
public maxIndexInterval ( ) : integer
return integer Value of `max_index_interval` or null

memtableFlushPeriodMs() public method

Returns memtable flush period in milliseconds
public memtableFlushPeriodMs ( ) : integer
return integer Memtable flush period in milliseconds

minIndexInterval() public method

Returns the value of min_index_interval
public minIndexInterval ( ) : integer
return integer Value of `min_index_interval` or null

name() public method

Returns the name of this table
public name ( ) : string
return string Name of the table

option() public method

Return a table's option by name
public option ( $name ) : Cassandra\Value
return Cassandra\Value Value of an option by name

options() public method

Returns all the table's options
public options ( ) : array
return array A dictionary of `string` and `Cassandra\Value pairs of the view's options.

partitionKey() public method

Returns the partition key columns of the table
public partitionKey ( ) : array
return array A list of of `Cassandra\Column` instances

populateIOCacheOnFlush() public method

Returns whether or not the populate_io_cache_on_flush is true
public populateIOCacheOnFlush ( ) : boolean
return boolean Value of `populate_io_cache_on_flush` or null

primaryKey() public method

Returns both the partition and clustering key columns of the table
public primaryKey ( ) : array
return array A list of of `Cassandra\Column` instances

readRepairChance() public method

Returns read repair chance
public readRepairChance ( ) : float
return float Read repair chance

replicateOnWrite() public method

Returns whether or not the replicate_on_write is true
public replicateOnWrite ( ) : boolean
return boolean Value of `replicate_on_write` or null

speculativeRetry() public method

Returns speculative retry.
public speculativeRetry ( ) : string
return string Speculative retry.