~ubuntu-branches/debian/sid/php-cassandra/sid

« back to all changes in this revision

Viewing changes to cassandra-1.3.0/doc/Cassandra/DefaultTable.php

  • Committer: Package Import Robot
  • Author(s): Ondřej Surý
  • Date: 2017-04-18 17:16:30 UTC
  • Revision ID: package-import@ubuntu.com-20170418171630-fw8udixss0879s32
Tags: upstream-1.3.0
Import upstream version 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?php
 
2
 
 
3
/**
 
4
 * Copyright 2017 DataStax, Inc.
 
5
 *
 
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
 
9
 *
 
10
 * http://www.apache.org/licenses/LICENSE-2.0
 
11
 *
 
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.
 
17
 */
 
18
 
 
19
namespace Cassandra;
 
20
 
 
21
/**
 
22
 * A PHP representation of a table
 
23
 */
 
24
final class DefaultTable implements Table {
 
25
 
 
26
    /**
 
27
     * {@inheritDoc}
 
28
     *
 
29
     * @return string Name of the table
 
30
     */
 
31
    public function name() { }
 
32
 
 
33
    /**
 
34
     * {@inheritDoc}
 
35
     *
 
36
     * @param string $name {@inheritDoc}
 
37
     *
 
38
     * @return Value Value of an option by name
 
39
     */
 
40
    public function option($name) { }
 
41
 
 
42
    /**
 
43
     * {@inheritDoc}
 
44
     *
 
45
     * @return array A dictionary of `string` and `Value` pairs of the
 
46
     */
 
47
    public function options() { }
 
48
 
 
49
    /**
 
50
     * {@inheritDoc}
 
51
     *
 
52
     * @return string Table description or null
 
53
     */
 
54
    public function comment() { }
 
55
 
 
56
    /**
 
57
     * {@inheritDoc}
 
58
     *
 
59
     * @return float Read repair chance
 
60
     */
 
61
    public function readRepairChance() { }
 
62
 
 
63
    /**
 
64
     * {@inheritDoc}
 
65
     *
 
66
     * @return float Local read repair chance
 
67
     */
 
68
    public function localReadRepairChance() { }
 
69
 
 
70
    /**
 
71
     * {@inheritDoc}
 
72
     *
 
73
     * @return int GC grace seconds
 
74
     */
 
75
    public function gcGraceSeconds() { }
 
76
 
 
77
    /**
 
78
     * {@inheritDoc}
 
79
     *
 
80
     * @return string Caching options
 
81
     */
 
82
    public function caching() { }
 
83
 
 
84
    /**
 
85
     * {@inheritDoc}
 
86
     *
 
87
     * @return float Bloom filter FP chance
 
88
     */
 
89
    public function bloomFilterFPChance() { }
 
90
 
 
91
    /**
 
92
     * {@inheritDoc}
 
93
     *
 
94
     * @return int Memtable flush period in milliseconds
 
95
     */
 
96
    public function memtableFlushPeriodMs() { }
 
97
 
 
98
    /**
 
99
     * {@inheritDoc}
 
100
     *
 
101
     * @return int Default TTL.
 
102
     */
 
103
    public function defaultTTL() { }
 
104
 
 
105
    /**
 
106
     * {@inheritDoc}
 
107
     *
 
108
     * @return string Speculative retry.
 
109
     */
 
110
    public function speculativeRetry() { }
 
111
 
 
112
    /**
 
113
     * {@inheritDoc}
 
114
     *
 
115
     * @return int Index interval
 
116
     */
 
117
    public function indexInterval() { }
 
118
 
 
119
    /**
 
120
     * {@inheritDoc}
 
121
     *
 
122
     * @return string Compaction strategy class name
 
123
     */
 
124
    public function compactionStrategyClassName() { }
 
125
 
 
126
    /**
 
127
     * {@inheritDoc}
 
128
     *
 
129
     * @return Map Compaction strategy options
 
130
     */
 
131
    public function compactionStrategyOptions() { }
 
132
 
 
133
    /**
 
134
     * {@inheritDoc}
 
135
     *
 
136
     * @return Map Compression parameters
 
137
     */
 
138
    public function compressionParameters() { }
 
139
 
 
140
    /**
 
141
     * {@inheritDoc}
 
142
     *
 
143
     * @return bool Value of `populate_io_cache_on_flush` or null
 
144
     */
 
145
    public function populateIOCacheOnFlush() { }
 
146
 
 
147
    /**
 
148
     * {@inheritDoc}
 
149
     *
 
150
     * @return bool Value of `replicate_on_write` or null
 
151
     */
 
152
    public function replicateOnWrite() { }
 
153
 
 
154
    /**
 
155
     * {@inheritDoc}
 
156
     *
 
157
     * @return int Value of `max_index_interval` or null
 
158
     */
 
159
    public function maxIndexInterval() { }
 
160
 
 
161
    /**
 
162
     * {@inheritDoc}
 
163
     *
 
164
     * @return int Value of `min_index_interval` or null
 
165
     */
 
166
    public function minIndexInterval() { }
 
167
 
 
168
    /**
 
169
     * {@inheritDoc}
 
170
     *
 
171
     * @param string $name Name of the column
 
172
     *
 
173
     * @return Column Column instance
 
174
     */
 
175
    public function column($name) { }
 
176
 
 
177
    /**
 
178
     * {@inheritDoc}
 
179
     *
 
180
     * @return array A list of `Column` instances
 
181
     */
 
182
    public function columns() { }
 
183
 
 
184
    /**
 
185
     * {@inheritDoc}
 
186
     *
 
187
     * @return array A list of of `Column` instance
 
188
     */
 
189
    public function partitionKey() { }
 
190
 
 
191
    /**
 
192
     * {@inheritDoc}
 
193
     *
 
194
     * @return array A list of of `Column` instance
 
195
     */
 
196
    public function primaryKey() { }
 
197
 
 
198
    /**
 
199
     * {@inheritDoc}
 
200
     *
 
201
     * @return array A list of of `Column` instances
 
202
     */
 
203
    public function clusteringKey() { }
 
204
 
 
205
    /**
 
206
     * {@inheritDoc}
 
207
     *
 
208
     * @return array A list of cluster column orders ('asc' and 'desc')
 
209
     */
 
210
    public function clusteringOrder() { }
 
211
 
 
212
    /**
 
213
     * Get an index by name
 
214
     *
 
215
     * @param string $name Index name
 
216
     *
 
217
     * @return Index|null An index or null
 
218
     */
 
219
    public function index($name) { }
 
220
 
 
221
    /**
 
222
     * Gets all indexes
 
223
     *
 
224
     * @return array An array of indexes
 
225
     */
 
226
    public function indexes() { }
 
227
 
 
228
    /**
 
229
     * Get materialized view by name
 
230
     *
 
231
     * @param string $name Materialized view name
 
232
     *
 
233
     * @return MaterizedView|null A materialized view or null
 
234
     */
 
235
    public function materializedView($name) { }
 
236
 
 
237
    /**
 
238
     * Gets all materialized views
 
239
     *
 
240
     * @return array An array of materialized views
 
241
     */
 
242
    public function materializedViews() { }
 
243
 
 
244
}