PHP Interface Cassandra\Index

Show file Open project: datastax/php-driver

Public Methods

Method	Description
className ( ) : string	Returns the class name of the index
isCustom ( ) : boolean	Returns true if this is a custom index
kind ( ) : string	Returns the kind of index
name ( ) : string	Returns the name of the index
option ( $name ) : Cassandra\Value	Return a column's option by name
options ( ) : array	Returns all the index's options
target ( ) : string	Returns the target column of the index

Returns the class name of the index

public className ( ) : string
return	string	Class name of a custom index

Returns true if this is a custom index

public isCustom ( ) : boolean
return	boolean

Returns the kind of index

public kind ( ) : string
return	string	Kind of the index

Returns the name of the index

public name ( ) : string
return	string	Name of the index

Return a column's option by name

public option ( $name ) : Cassandra\Value
return	Cassandra\Value	Value of an option by name

Returns all the index's options

public options ( ) : array
return	array	A dictionary of `string` and `Cassandra\Value pairs of the index's options.

Returns the target column of the index

public target ( ) : string
return	string	Target column name of the index