1. class
  2. Cassandra
  3. \
  4. DefaultIndex

DefaultIndex

final class DefaultIndex implements Index (View source)

A PHP representation of an index

Methods

string
name()

Returns the name of the index

string
kind()

Returns the kind of index

string
target()

Returns the target column of the index

Value
option(string $name)

Return a column's option by name

array
options()

Returns all the index's options

string
className()

Returns the class name of the index

bool
isCustom()

Determines if the index is a custom index.

Details

at line 2716
string name()

Returns the name of the index

Return Value

string

Name of the index

at line 2724
string kind()

Returns the kind of index

Return Value

string

Kind of the index

at line 2732
string target()

Returns the target column of the index

Return Value

string

Target column name of the index

at line 2742
Value option(string $name)

Return a column's option by name

Parameters

string $name

The name of the option

Return Value

Value

Value of an option by name

at line 2750
array options()

Returns all the index's options

Return Value

array

A dictionary of string and Value pairs of the index's options.

at line 2758
string className()

Returns the class name of the index

Return Value

string

Class name of a custom index

at line 2766
bool isCustom()

Determines if the index is a custom index.

Return Value

bool

true if a custom index