1. interface
  2. Cassandra
  3. \
  4. Keyspace

Keyspace

interface Keyspace (View source)

A PHP representation of a keyspace

Methods

string
name()

Returns keyspace name

string
replicationClassName()

Returns replication class name

Map
replicationOptions()

Returns replication options

string
hasDurableWrites()

Returns whether the keyspace has durable writes enabled

Table|null
table(string $name)

Returns a table by name

array
tables()

Returns all tables defined in this keyspace

UserType|null
userType(string $name)

Get user type by name

array
userTypes()

Get all user types

MaterializedView|null
materializedView(string $name)

Get materialized view by name

array
materializedViews()

Gets all materialized views

Function_|null
function_(string $name, string|Type ...$params)

Get a function by name and signature

array
functions()

Get all functions

Aggregate|null
aggregate(string $name, string|Type ...$params)

Get an aggregate by name and signature

array
aggregates()

Get all aggregates

Details

at line 1189
string name()

Returns keyspace name

Return Value

string Name

at line 1197
string replicationClassName()

Returns replication class name

Return Value

string

Replication class

at line 1205
Map replicationOptions()

Returns replication options

Return Value

Map

Replication options

at line 1213
string hasDurableWrites()

Returns whether the keyspace has durable writes enabled

Return Value

string

Whether durable writes are enabled

at line 1223
Table|null table(string $name)

Returns a table by name

Parameters

string $name

Table name

Return Value

Table|null

Table instance or null

at line 1231
array tables()

Returns all tables defined in this keyspace

Return Value

array

An array of Table instances

at line 1241
UserType|null userType(string $name)

Get user type by name

Parameters

string $name

User type name

Return Value

UserType|null

A user type or null

at line 1249
array userTypes()

Get all user types

Return Value

array

An array of user types

at line 1259
MaterializedView|null materializedView(string $name)

Get materialized view by name

Parameters

string $name

Materialized view name

Return Value

MaterializedView|null

A materialized view or null

at line 1267
array materializedViews()

Gets all materialized views

Return Value

array

An array of materialized views

at line 1278
Function_|null function_(string $name, string|Type ...$params)

Get a function by name and signature

Parameters

string $name

Function name
string|Type ...$params

Function arguments

Return Value

Function_|null

A function or null

at line 1286
array functions()

Get all functions

Return Value

array

An array of functions

at line 1297
Aggregate|null aggregate(string $name, string|Type ...$params)

Get an aggregate by name and signature

Parameters

string $name

Aggregate name
string|Type ...$params

Aggregate arguments

Return Value

Aggregate|null

An aggregate or null

at line 1305
array aggregates()

Get all aggregates

Return Value

array

An array of aggregates