4
* Copyright 2017 DataStax, Inc.
6
* Licensed under the Apache License, Version 2.0 (the "License");
7
* you may not use this file except in compliance with the License.
8
* You may obtain a copy of the License at
10
* http://www.apache.org/licenses/LICENSE-2.0
12
* Unless required by applicable law or agreed to in writing, software
13
* distributed under the License is distributed on an "AS IS" BASIS,
14
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
* See the License for the specific language governing permissions and
16
* limitations under the License.
22
* A PHP representation of a table
27
* Returns the name of this table
29
* @return string Name of the table
31
public function name();
34
* Return a table's option by name
36
* @param string $name The name of the option
38
* @return Value Value of an option by name
40
public function option($name);
43
* Returns all the table's options
46
* @return array A dictionary of `string` and `Value` pairs of the
48
public function options();
51
* Description of the table, if any
53
* @return string Table description or null
55
public function comment();
58
* Returns read repair chance
60
* @return float Read repair chance
62
public function readRepairChance();
65
* Returns local read repair chance
67
* @return float Local read repair chance
69
public function localReadRepairChance();
72
* Returns GC grace seconds
74
* @return int GC grace seconds
76
public function gcGraceSeconds();
79
* Returns caching options
81
* @return string Caching options
83
public function caching();
86
* Returns bloom filter FP chance
88
* @return float Bloom filter FP chance
90
public function bloomFilterFPChance();
93
* Returns memtable flush period in milliseconds
95
* @return int Memtable flush period in milliseconds
97
public function memtableFlushPeriodMs();
100
* Returns default TTL.
102
* @return int Default TTL.
104
public function defaultTTL();
107
* Returns speculative retry.
109
* @return string Speculative retry.
111
public function speculativeRetry();
114
* Returns index interval
116
* @return int Index interval
118
public function indexInterval();
121
* Returns compaction strategy class name
123
* @return string Compaction strategy class name
125
public function compactionStrategyClassName();
128
* Returns compaction strategy options
130
* @return Map Compaction strategy options
132
public function compactionStrategyOptions();
135
* Returns compression parameters
137
* @return Map Compression parameters
139
public function compressionParameters();
142
* Returns whether or not the `populate_io_cache_on_flush` is true
144
* @return bool Value of `populate_io_cache_on_flush` or null
146
public function populateIOCacheOnFlush();
149
* Returns whether or not the `replicate_on_write` is true
151
* @return bool Value of `replicate_on_write` or null
153
public function replicateOnWrite();
156
* Returns the value of `max_index_interval`
158
* @return int Value of `max_index_interval` or null
160
public function maxIndexInterval();
163
* Returns the value of `min_index_interval`
165
* @return int Value of `min_index_interval` or null
167
public function minIndexInterval();
170
* Returns column by name
172
* @param string $name Name of the column
174
* @return Column Column instance
176
public function column($name);
179
* Returns all columns in this table
181
* @return array A list of Column instances
183
public function columns();
186
* Returns the partition key columns of the table
188
* @return array A list of of Column instances
190
public function partitionKey();
193
* Returns both the partition and clustering key columns of the table
195
* @return array A list of of Column instances
197
public function primaryKey();
200
* Returns the clustering key columns of the table
202
* @return array A list of of Column instances
204
public function clusteringKey();
207
* @return array A list of cluster column orders ('asc' and 'desc')
209
public function clusteringOrder();