struct CassKeyspaceMeta
Keyspace metadata
Functions
void
cass_keyspace_meta_name
( keyspace_meta, name, name_length )Gets the name of the keyspace.
- Parameters:
Name Type Details in keyspace_meta out name out name_length
const CassTableMeta *
cass_keyspace_meta_table_by_name
( keyspace_meta, table )Gets the table metadata for the provided table name.
- Parameters:
Name Type Details in keyspace_meta in table - Returns:
Type Details const CassTableMeta *
The metadata for a table. NULL if table does not exist.
const CassTableMeta *
cass_keyspace_meta_table_by_name_n
( keyspace_meta, table, table_length )Same as CassKeyspaceMeta::cass_keyspace_meta_table_by_name
, but with lengths for string parameters.
- Parameters:
Name Type Details in keyspace_meta in table in table_length - Returns:
Type Details const CassTableMeta *
- See Also:
const CassMaterializedViewMeta *
cass_keyspace_meta_materialized_view_by_name
( keyspace_meta, view )Gets the materialized view metadata for the provided view name.
Requires Cassandra: 3.0+
- Parameters:
Name Type Details in keyspace_meta in view - Returns:
Type Details const CassMaterializedViewMeta *
The metadata for a view. NULL if view does not exist.
const CassMaterializedViewMeta *
cass_keyspace_meta_materialized_view_by_name_n
( keyspace_meta, view, view_length )Same as CassKeyspaceMeta::cass_keyspace_meta_materialized_view_by_name
, but with lengths for string parameters.
Requires Cassandra: 3.0+
- Parameters:
Name Type Details in keyspace_meta in view in view_length - Returns:
Type Details const CassMaterializedViewMeta *
same as
CassKeyspaceMeta::cass_keyspace_meta_materialized_view_by_name
- See Also:
const CassDataType *
cass_keyspace_meta_user_type_by_name
( keyspace_meta, type )Gets the data type for the provided type name.
Requires Cassandra: 2.1+
- Parameters:
Name Type Details in keyspace_meta in type - Returns:
Type Details const CassDataType *
The data type for a user defined type. NULL if type does not exist.
const CassDataType *
cass_keyspace_meta_user_type_by_name_n
( keyspace_meta, type, type_length )Same as cass_keyspace_meta_type_by_name(), but with lengths for string parameters.
Requires Cassandra: 2.1+
- Parameters:
Name Type Details in keyspace_meta in type in type_length - Returns:
Type Details const CassDataType *
same as cass_keyspace_meta_type_by_name()
- See Also:
- cass_keyspace_meta_type_by_name()
const CassFunctionMeta *
cass_keyspace_meta_function_by_name
( keyspace_meta, name, arguments )Gets the function metadata for the provided function name.
Requires Cassandra: 2.2+
- Parameters:
Name Type Details in keyspace_meta in name in arguments A comma delimited list of CQL types (e.g "text,int,...") describing the function’s signature.
- Returns:
Type Details const CassFunctionMeta *
The data function for a user defined function. NULL if function does not exist.
const CassFunctionMeta *
cass_keyspace_meta_function_by_name_n
( keyspace_meta, name, name_length, arguments, arguments_length )Same as CassKeyspaceMeta::cass_keyspace_meta_function_by_name
, but with lengths for string parameters.
Requires Cassandra: 2.2+
- Parameters:
Name Type Details in keyspace_meta in name in name_length in arguments in arguments_length - Returns:
Type Details const CassFunctionMeta *
same as
CassKeyspaceMeta::cass_keyspace_meta_function_by_name
- See Also:
const CassAggregateMeta *
cass_keyspace_meta_aggregate_by_name
( keyspace_meta, name, arguments )Gets the aggregate metadata for the provided aggregate name.
Requires Cassandra: 2.2+
- Parameters:
Name Type Details in keyspace_meta in name in arguments A comma delimited list of CQL types (e.g "text,int,...") describing the aggregate’s signature.
- Returns:
Type Details const CassAggregateMeta *
The data aggregate for a user defined aggregate. NULL if aggregate does not exist.
const CassAggregateMeta *
cass_keyspace_meta_aggregate_by_name_n
( keyspace_meta, name, name_length, arguments, arguments_length )Same as CassKeyspaceMeta::cass_keyspace_meta_aggregate_by_name
, but with lengths for string parameters.
Requires Cassandra: 2.2+
- Parameters:
Name Type Details in keyspace_meta in name in name_length in arguments in arguments_length - Returns:
Type Details const CassAggregateMeta *
same as
CassKeyspaceMeta::cass_keyspace_meta_aggregate_by_name
- See Also:
const CassValue *
cass_keyspace_meta_field_by_name
( keyspace_meta, 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:
Name Type Details in keyspace_meta in name - Returns:
Type Details const CassValue *
A metadata field value. NULL if the field does not exist.
const CassValue *
cass_keyspace_meta_field_by_name_n
( keyspace_meta, name, name_length )Same as CassKeyspaceMeta::cass_keyspace_meta_field_by_name
, but with lengths for string parameters.
- Parameters:
Name Type Details in keyspace_meta in name in name_length - Returns:
Type Details const CassValue *
- See Also:
CassIterator *
cass_iterator_tables_from_keyspace_meta
( keyspace_meta )Creates a new iterator for the specified keyspace metadata. This can be used to iterate over tables.
- Parameters:
Name Type Details in keyspace_meta - Returns:
Type Details CassIterator *
A new iterator that must be freed.
- See Also:
CassIterator *
cass_iterator_materialized_views_from_keyspace_meta
( keyspace_meta )Creates a new iterator for the specified keyspace metadata. This can be used to iterate over views.
Requires Cassandra: 3.0+
- Parameters:
Name Type Details in keyspace_meta - Returns:
Type Details CassIterator *
A new iterator that must be freed.
- See Also:
CassIterator *
cass_iterator_user_types_from_keyspace_meta
( keyspace_meta )Creates a new iterator for the specified keyspace metadata. This can be used to iterate over types.
Requires Cassandra: 2.1+
- Parameters:
Name Type Details in keyspace_meta - Returns:
Type Details CassIterator *
A new iterator that must be freed.
- See Also:
CassIterator *
cass_iterator_functions_from_keyspace_meta
( keyspace_meta )Creates a new iterator for the specified keyspace metadata. This can be used to iterate over functions.
Requires Cassandra: 2.2+
- Parameters:
Name Type Details in keyspace_meta - Returns:
Type Details CassIterator *
A new iterator that must be freed.
- See Also:
CassIterator *
cass_iterator_aggregates_from_keyspace_meta
( keyspace_meta )Creates a new iterator for the specified keyspace metadata. This can be used to iterate over aggregates.
Requires Cassandra: 2.2+
- Parameters:
Name Type Details in keyspace_meta - Returns:
Type Details CassIterator *
A new iterator that must be freed.
- See Also:
CassIterator *
cass_iterator_fields_from_keyspace_meta
( 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.
- Parameters:
Name Type Details in keyspace_meta - Returns:
Type Details CassIterator *
A new iterator that must be freed.
- See Also: