[Cassandra Wiki] Update of "API07" by zznate

[Apache Wiki <wi...@apache.org>]

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Cassandra Wiki" for change notification.

The "API07" page has been changed by zznate.
http://wiki.apache.org/cassandra/API07?action=diff&rev1=6&rev2=7

--------------------------------------------------

  
  
  === IndexOperator ===
- An enum that details the type of operator to use in an `IndexExpression`. Currently, on `EQ` is supported.
+ An enum that details the type of operator to use in an `IndexExpression`. Currently, on `EQ` is supported for configuring a `ColumnFamily`, but the other operators may be used in conjunction with and `EQ` operator on other non-indexed columns.
  ||'''Operator'''||'''Description'''||
  ||`EQ`|| Equality ||
  ||`GTE`||Greater than or equal to||
@@ -159, +159 @@

  A struct that defines the `IndexOperator` to use against a column for a lookup value. Used only by the `IndexClause` in the `get_indexed_slices` method.
  ||'''Attribute''' ||'''Type''' ||'''Default''' ||'''Required''' ||'''Description''' ||
  ||`column_name` ||`binary` ||n/a ||Y ||The column name to against which the operator and value will be applied ||
- ||`op` ||`IndexOperator` ||n/a ||Y || The `IndexOperator` to use (currently only `EQ` is supported) ||
+ ||`op` ||`IndexOperator` ||n/a ||Y || The `IndexOperator` to use. Currently only `EQ` is supported for direct queries, but other `IndexExpression` structs may be created and passed to `IndexClause` ||
  ||`value` ||`binary` ||n/a ||Y ||The value for which to the column ||
  
  === IndexClause ===
- Defines one or more `IndexExpression`s for `get_indexed_slices`
+ Defines one or more `IndexExpression`s for `get_indexed_slices`. An `IndexExpression` containing an `EQ` `IndexOperator` must be present.
  ||'''Attribute''' ||'''Type''' ||'''Default''' ||'''Required''' ||'''Description''' ||
- ||`expressions` ||`list<IndexExpression>` ||n/a ||Y ||The column name to against which the operator and value will be applied ||
+ ||`expressions` ||`list<IndexExpression>` ||n/a ||Y ||The list of `IndexExpression` objects which must contain one `EQ` `IndexOperator` among the expressions ||
  ||`start_key` ||`binary` ||n/a ||Y || Start the index query at the specified key - can be set to `''`, i.e., an empty byte array, to start with the first key ||
  ||`count` ||`integer` ||100 ||Y ||The number of results to which the index query will be constrained ||
  
@@ -249, +249 @@

  === get_indexed_slices ===
   . `list<KeySlice> get_indexed_slices(column_parent, index_clause, predicate, consistency_level)`
  
- Like `get_range_slices`, returns a list of slices, but uses `IndexClause` instead of `KeyRange`. To use this method, the underlying `ColumnFamily` of the `ColumnParent` must have been configured with a column_metadata attribute, specifying at least the name and index_type attributes. See `CfDef` and `ColumnDef` above for the list of attributes. 
+ Like `get_range_slices`, returns a list of slices, but uses `IndexClause` instead of `KeyRange`. To use this method, the underlying `ColumnFamily` of the `ColumnParent` must have been configured with a column_metadata attribute, specifying at least the name and index_type attributes. See `CfDef` and `ColumnDef` above for the list of attributes. Note: the `IndexClause` must contain one `IndexExpression` with an `EQ` operator on a configured index column. Other `IndexExpression` structs may be added to the `IndexClause` for non-indexed columns to further refine the results of the `EQ` expression.  
  
  === insert ===
   . `insert(key, column_path, value, timestamp, consistency_level)`