|
| 1 | +<?php |
| 2 | + |
| 3 | +/** |
| 4 | + * Copyright 2015 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 column |
| 23 | + */ |
| 24 | +interface Column |
| 25 | +{ |
| 26 | + /** |
| 27 | + * Returns the name of the column. |
| 28 | + * @return string|null Name of the column or null |
| 29 | + */ |
| 30 | + function name(); |
| 31 | + |
| 32 | + /** |
| 33 | + * Returns the type of the column. |
| 34 | + * @return Cassandra\Type Type of the column |
| 35 | + */ |
| 36 | + function type(); |
| 37 | + |
| 38 | + /** |
| 39 | + * Returns whether the column is in descending or ascending order. |
| 40 | + * @return boolean Whether the column is stored in descending order. |
| 41 | + */ |
| 42 | + function isReversed(); |
| 43 | + |
| 44 | + /** |
| 45 | + * Returns true for static columns. |
| 46 | + * @return boolean Whether the column is static |
| 47 | + */ |
| 48 | + function isStatic(); |
| 49 | + |
| 50 | + /** |
| 51 | + * Returns true for frozen columns. |
| 52 | + * @return boolean Whether the column is frozen |
| 53 | + */ |
| 54 | + function isFrozen(); |
| 55 | + |
| 56 | + /** |
| 57 | + * Returns name of the index if defined. |
| 58 | + * @return string|null Name of the index if defined |
| 59 | + */ |
| 60 | + function indexName(); |
| 61 | + |
| 62 | + /** |
| 63 | + * Returns index options if present. |
| 64 | + * @return string|null Index options if present |
| 65 | + */ |
| 66 | + function indexOptions(); |
| 67 | +} |
0 commit comments