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

« back to all changes in this revision

Viewing changes to cassandra-1.3.0/doc/Cassandra/Table.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
interface Table {
 
25
 
 
26
    /**
 
27
     * Returns the name of this table
 
28
     *
 
29
     * @return string Name of the table
 
30
     */
 
31
    public function name();
 
32
 
 
33
    /**
 
34
     * Return a table's option by name
 
35
     *
 
36
     * @param string $name The name of the option
 
37
     *
 
38
     * @return Value Value of an option by name
 
39
     */
 
40
    public function option($name);
 
41
 
 
42
    /**
 
43
     * Returns all the table's options
 
44
     *               view's options.
 
45
     *
 
46
     * @return array A dictionary of `string` and `Value` pairs of the
 
47
     */
 
48
    public function options();
 
49
 
 
50
    /**
 
51
     * Description of the table, if any
 
52
     *
 
53
     * @return string Table description or null
 
54
     */
 
55
    public function comment();
 
56
 
 
57
    /**
 
58
     * Returns read repair chance
 
59
     *
 
60
     * @return float Read repair chance
 
61
     */
 
62
    public function readRepairChance();
 
63
 
 
64
    /**
 
65
     * Returns local read repair chance
 
66
     *
 
67
     * @return float Local read repair chance
 
68
     */
 
69
    public function localReadRepairChance();
 
70
 
 
71
    /**
 
72
     * Returns GC grace seconds
 
73
     *
 
74
     * @return int GC grace seconds
 
75
     */
 
76
    public function gcGraceSeconds();
 
77
 
 
78
    /**
 
79
     * Returns caching options
 
80
     *
 
81
     * @return string Caching options
 
82
     */
 
83
    public function caching();
 
84
 
 
85
    /**
 
86
     * Returns bloom filter FP chance
 
87
     *
 
88
     * @return float Bloom filter FP chance
 
89
     */
 
90
    public function bloomFilterFPChance();
 
91
 
 
92
    /**
 
93
     * Returns memtable flush period in milliseconds
 
94
     *
 
95
     * @return int Memtable flush period in milliseconds
 
96
     */
 
97
    public function memtableFlushPeriodMs();
 
98
 
 
99
    /**
 
100
     * Returns default TTL.
 
101
     *
 
102
     * @return int Default TTL.
 
103
     */
 
104
    public function defaultTTL();
 
105
 
 
106
    /**
 
107
     * Returns speculative retry.
 
108
     *
 
109
     * @return string Speculative retry.
 
110
     */
 
111
    public function speculativeRetry();
 
112
 
 
113
    /**
 
114
     * Returns index interval
 
115
     *
 
116
     * @return int Index interval
 
117
     */
 
118
    public function indexInterval();
 
119
 
 
120
    /**
 
121
     * Returns compaction strategy class name
 
122
     *
 
123
     * @return string Compaction strategy class name
 
124
     */
 
125
    public function compactionStrategyClassName();
 
126
 
 
127
    /**
 
128
     * Returns compaction strategy options
 
129
     *
 
130
     * @return Map Compaction strategy options
 
131
     */
 
132
    public function compactionStrategyOptions();
 
133
 
 
134
    /**
 
135
     * Returns compression parameters
 
136
     *
 
137
     * @return Map Compression parameters
 
138
     */
 
139
    public function compressionParameters();
 
140
 
 
141
    /**
 
142
     * Returns whether or not the `populate_io_cache_on_flush` is true
 
143
     *
 
144
     * @return bool Value of `populate_io_cache_on_flush` or null
 
145
     */
 
146
    public function populateIOCacheOnFlush();
 
147
 
 
148
    /**
 
149
     * Returns whether or not the `replicate_on_write` is true
 
150
     *
 
151
     * @return bool Value of `replicate_on_write` or null
 
152
     */
 
153
    public function replicateOnWrite();
 
154
 
 
155
    /**
 
156
     * Returns the value of `max_index_interval`
 
157
     *
 
158
     * @return int Value of `max_index_interval` or null
 
159
     */
 
160
    public function maxIndexInterval();
 
161
 
 
162
    /**
 
163
     * Returns the value of `min_index_interval`
 
164
     *
 
165
     * @return int Value of `min_index_interval` or null
 
166
     */
 
167
    public function minIndexInterval();
 
168
 
 
169
    /**
 
170
     * Returns column by name
 
171
     *
 
172
     * @param string $name Name of the column
 
173
     *
 
174
     * @return Column Column instance
 
175
     */
 
176
    public function column($name);
 
177
 
 
178
    /**
 
179
     * Returns all columns in this table
 
180
     *
 
181
     * @return array A list of Column instances
 
182
     */
 
183
    public function columns();
 
184
 
 
185
    /**
 
186
     * Returns the partition key columns of the table
 
187
     *
 
188
     * @return array A list of of Column instances
 
189
     */
 
190
    public function partitionKey();
 
191
 
 
192
    /**
 
193
     * Returns both the partition and clustering key columns of the table
 
194
     *
 
195
     * @return array A list of of Column instances
 
196
     */
 
197
    public function primaryKey();
 
198
 
 
199
    /**
 
200
     * Returns the clustering key columns of the table
 
201
     *
 
202
     * @return array A list of of Column instances
 
203
     */
 
204
    public function clusteringKey();
 
205
 
 
206
    /**
 
207
     * @return array A list of cluster column orders ('asc' and 'desc')
 
208
     */
 
209
    public function clusteringOrder();
 
210
 
 
211
}