Menu

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:

  • name:

  • name_length:

cass_bool_t cass_keyspace_meta_is_virtual(const CassKeyspaceMeta *keyspace_meta)

Determine if the keyspace is a virtual keyspace.

Return

cass_true is the keyspace is virtual, otherwise cass_false

Parameters
  • keyspace_meta:

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

Gets the table metadata for the provided table name.

Return

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

Parameters
  • keyspace_meta:

  • table:

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.

Return

same as cass_keyspace_meta_table_by_name()

See

cass_keyspace_meta_table_by_name()

Parameters
  • keyspace_meta:

  • table:

  • table_length:

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+

Return

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

Parameters
  • keyspace_meta:

  • view:

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+

Return

same as cass_keyspace_meta_materialized_view_by_name()

See

cass_keyspace_meta_materialized_view_by_name()

Parameters
  • keyspace_meta:

  • view:

  • view_length:

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+

Return

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

Parameters
  • keyspace_meta:

  • type:

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+

Return

same as cass_keyspace_meta_type_by_name()

See

cass_keyspace_meta_type_by_name()

Parameters
  • keyspace_meta:

  • type:

  • type_length:

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+

Return

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

Parameters
  • keyspace_meta:

  • name:

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

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+

Return

same as cass_keyspace_meta_function_by_name()

See

cass_keyspace_meta_function_by_name()

Parameters
  • keyspace_meta:

  • name:

  • name_length:

  • arguments:

  • arguments_length:

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+

Return

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

Parameters
  • keyspace_meta:

  • name:

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

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+

Return

same as cass_keyspace_meta_aggregate_by_name()

See

cass_keyspace_meta_aggregate_by_name()

Parameters
  • keyspace_meta:

  • name:

  • name_length:

  • arguments:

  • arguments_length:

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.

Return

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

Parameters
  • keyspace_meta:

  • name:

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.

Return

same as cass_keyspace_meta_field_by_name()

See

cass_keyspace_meta_field_by_name()

Parameters
  • keyspace_meta:

  • name:

  • name_length:

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.

Return

A new iterator that must be freed.

See

cass_iterator_get_table_meta()

See

cass_iterator_free()

Parameters
  • keyspace_meta:

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+

Return

A new iterator that must be freed.

See

cass_iterator_get_materialized_view_meta()

See

cass_iterator_free()

Parameters
  • keyspace_meta:

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+

Return

A new iterator that must be freed.

See

cass_iterator_get_user_type()

See

cass_iterator_free()

Parameters
  • keyspace_meta:

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+

Return

A new iterator that must be freed.

See

cass_iterator_get_function_meta()

See

cass_iterator_free()

Parameters
  • keyspace_meta:

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+

Return

A new iterator that must be freed.

See

cass_iterator_get_aggregate_meta()

See

cass_iterator_free()

Parameters
  • keyspace_meta:

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.

Return

A new iterator that must be freed.

See

cass_iterator_get_meta_field_name()

See

cass_iterator_get_meta_field_value()

See

cass_iterator_free()

Parameters
  • keyspace_meta: