CassKeyspaceMeta¶

struct CassKeyspaceMeta¶

Keyspace metadata

Public Functions

void cass_keyspace_meta_name(const CassKeyspaceMeta *keyspace_meta, const char **name, size_t *name_length)¶

Gets the name of the keyspace.

Parameters:

• keyspace_meta – [in]

• name – [out]

• name_length – [out]

cass_bool_t cass_keyspace_meta_is_virtual(const CassKeyspaceMeta *keyspace_meta)¶

Determine if the keyspace is a virtual keyspace.

Parameters:

keyspace_meta – [in]

Returns:

cass_true is the keyspace is virtual, otherwise cass_false

const CassTableMeta *cass_keyspace_meta_table_by_name(const CassKeyspaceMeta *keyspace_meta, const char *table)¶

Gets the table metadata for the provided table name.

Parameters:

• keyspace_meta – [in]

• table – [in]

Returns:

The metadata for a table. NULL if table does not exist.

const CassTableMeta *cass_keyspace_meta_table_by_name_n(const CassKeyspaceMeta *keyspace_meta, const char *table, size_t table_length)¶

Same as cass_keyspace_meta_table_by_name(), but with lengths for string parameters.

See also

cass_keyspace_meta_table_by_name()

Parameters:

• keyspace_meta – [in]

• table – [in]

• table_length – [in]

Returns:

same as cass_keyspace_meta_table_by_name()

const CassMaterializedViewMeta *cass_keyspace_meta_materialized_view_by_name(const CassKeyspaceMeta *keyspace_meta, const char *view)¶

Gets the materialized view metadata for the provided view name.

Requires Apache Cassandra: 3.0+

Parameters:

• keyspace_meta – [in]

• view – [in]

Returns:

The metadata for a view. NULL if view does not exist.

const CassMaterializedViewMeta *cass_keyspace_meta_materialized_view_by_name_n(const CassKeyspaceMeta *keyspace_meta, const char *view, size_t view_length)¶

Same as cass_keyspace_meta_materialized_view_by_name(), but with lengths for string parameters.

Requires Apache Cassandra: 3.0+

See also

cass_keyspace_meta_materialized_view_by_name()

Parameters:

• keyspace_meta – [in]

• view – [in]

• view_length – [in]

Returns:

same as cass_keyspace_meta_materialized_view_by_name()

const CassDataType *cass_keyspace_meta_user_type_by_name(const CassKeyspaceMeta *keyspace_meta, const char *type)¶

Gets the data type for the provided type name.

Requires Apache Cassandra: 2.1+

Parameters:

• keyspace_meta – [in]

• type – [in]

Returns:

The data type for a user defined type. NULL if type does not exist.

const CassDataType *cass_keyspace_meta_user_type_by_name_n(const CassKeyspaceMeta *keyspace_meta, const char *type, size_t type_length)¶

Same as cass_keyspace_meta_type_by_name(), but with lengths for string parameters.

Requires Apache Cassandra: 2.1+

See also

cass_keyspace_meta_type_by_name()

Parameters:

• keyspace_meta – [in]

• type – [in]

• type_length – [in]

Returns:

same as cass_keyspace_meta_type_by_name()

const CassFunctionMeta *cass_keyspace_meta_function_by_name(const CassKeyspaceMeta *keyspace_meta, const char *name, const char *arguments)¶

Gets the function metadata for the provided function name.

Requires Apache Cassandra: 2.2+

Parameters:

• keyspace_meta – [in]

• name – [in]

• arguments – [in] A comma delimited list of CQL types (e.g “text,int,…”) describing the function’s signature.

Returns:

The data function for a user defined function. NULL if function does not exist.

const CassFunctionMeta *cass_keyspace_meta_function_by_name_n(const CassKeyspaceMeta *keyspace_meta, const char *name, size_t name_length, const char *arguments, size_t arguments_length)¶

Same as cass_keyspace_meta_function_by_name(), but with lengths for string parameters.

Requires Apache Cassandra: 2.2+

See also

cass_keyspace_meta_function_by_name()

Parameters:

• keyspace_meta – [in]

• name – [in]

• name_length – [in]

• arguments – [in]

• arguments_length – [in]

Returns:

same as cass_keyspace_meta_function_by_name()

const CassAggregateMeta *cass_keyspace_meta_aggregate_by_name(const CassKeyspaceMeta *keyspace_meta, const char *name, const char *arguments)¶

Gets the aggregate metadata for the provided aggregate name.

Requires Apache Cassandra: 2.2+

Parameters:

• keyspace_meta – [in]

• name – [in]

• arguments – [in] A comma delimited list of CQL types (e.g “text,int,…”) describing the aggregate’s signature.

Returns:

The data aggregate for a user defined aggregate. NULL if aggregate does not exist.

const CassAggregateMeta *cass_keyspace_meta_aggregate_by_name_n(const CassKeyspaceMeta *keyspace_meta, const char *name, size_t name_length, const char *arguments, size_t arguments_length)¶

Same as cass_keyspace_meta_aggregate_by_name(), but with lengths for string parameters.

Requires Apache Cassandra: 2.2+

See also

cass_keyspace_meta_aggregate_by_name()

Parameters:

• keyspace_meta – [in]

• name – [in]

• name_length – [in]

• arguments – [in]

• arguments_length – [in]

Returns:

same as cass_keyspace_meta_aggregate_by_name()

const CassValue *cass_keyspace_meta_field_by_name(const CassKeyspaceMeta *keyspace_meta, const char *name)¶

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying “keyspaces” metadata table.

Parameters:

• keyspace_meta – [in]

• name – [in]

Returns:

A metadata field value. NULL if the field does not exist.

const CassValue *cass_keyspace_meta_field_by_name_n(const CassKeyspaceMeta *keyspace_meta, const char *name, size_t name_length)¶

Same as cass_keyspace_meta_field_by_name(), but with lengths for string parameters.

See also

cass_keyspace_meta_field_by_name()

Parameters:

• keyspace_meta – [in]

• name – [in]

• name_length – [in]

Returns:

same as cass_keyspace_meta_field_by_name()

CassIterator *cass_iterator_tables_from_keyspace_meta(const CassKeyspaceMeta *keyspace_meta)¶

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over tables.

See also

cass_iterator_get_table_meta()

See also

cass_iterator_free()

Parameters:

keyspace_meta – [in]

Returns:

A new iterator that must be freed.

CassIterator *cass_iterator_materialized_views_from_keyspace_meta(const CassKeyspaceMeta *keyspace_meta)¶

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over views.

Requires Apache Cassandra: 3.0+

See also

cass_iterator_get_materialized_view_meta()

See also

cass_iterator_free()

Parameters:

keyspace_meta – [in]

Returns:

A new iterator that must be freed.

CassIterator *cass_iterator_user_types_from_keyspace_meta(const CassKeyspaceMeta *keyspace_meta)¶

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over types.

Requires Apache Cassandra: 2.1+

See also

cass_iterator_get_user_type()

See also

cass_iterator_free()

Parameters:

keyspace_meta – [in]

Returns:

A new iterator that must be freed.

CassIterator *cass_iterator_functions_from_keyspace_meta(const CassKeyspaceMeta *keyspace_meta)¶

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over functions.

Requires Apache Cassandra: 2.2+

See also

cass_iterator_get_function_meta()

See also

cass_iterator_free()

Parameters:

keyspace_meta – [in]

Returns:

A new iterator that must be freed.

CassIterator *cass_iterator_aggregates_from_keyspace_meta(const CassKeyspaceMeta *keyspace_meta)¶

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over aggregates.

Requires Apache Cassandra: 2.2+

See also

cass_iterator_get_aggregate_meta()

See also

cass_iterator_free()

Parameters:

keyspace_meta – [in]

Returns:

A new iterator that must be freed.

CassIterator *cass_iterator_fields_from_keyspace_meta(const CassKeyspaceMeta *keyspace_meta)¶

Creates a new fields iterator for the specified keyspace metadata. Metadata fields allow direct access to the column data found in the underlying “keyspaces” metadata table. This can be used to iterate those metadata field entries.

See also

cass_iterator_get_meta_field_name()

See also

cass_iterator_get_meta_field_value()

See also

cass_iterator_free()

Parameters:

keyspace_meta – [in]

Returns:

A new iterator that must be freed.