struct CassTableMeta

Table metadata

Functions

void

cass_table_meta_name

( const CassTableMeta * table_meta, const char ** name, size_t * name_length )

Gets the name of the table.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
out name const char **
out name_length size_t *
cass_bool_t

cass_table_meta_is_virtual

( const CassTableMeta * table_meta )

Determine if the table is a virtual table.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
cass_bool_t

cass_true is the table is virtual, otherwise cass_false
const CassColumnMeta *

cass_table_meta_column_by_name

( const CassTableMeta * table_meta, const char * column )

Gets the column metadata for the provided column name.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in column const char *
Returns:
Type Details
const CassColumnMeta *

The metadata for a column. NULL if column does not exist.
const CassColumnMeta *

cass_table_meta_column_by_name_n

( const CassTableMeta * table_meta, const char * column, size_t column_length )

Same as CassTableMeta::cass_table_meta_column_by_name, but with lengths for string parameters.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in column const char *
in column_length size_t
Returns:
Type Details
const CassColumnMeta *

same as CassTableMeta::cass_table_meta_column_by_name
See Also:
size_t

cass_table_meta_column_count

( const CassTableMeta * table_meta )

Gets the total number of columns for the table.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
size_t

The total column count.
const CassColumnMeta *

cass_table_meta_column

( const CassTableMeta * table_meta, size_t index )

Gets the column metadata for the provided index.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index size_t
Returns:
Type Details
const CassColumnMeta *

The metadata for a column. NULL returned if the index is out of range.
const CassIndexMeta *

cass_table_meta_index_by_name

( const CassTableMeta * table_meta, const char * index )

Gets the index metadata for the provided index name.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index const char *
Returns:
Type Details
const CassIndexMeta *

The metadata for a index. NULL if index does not exist.
const CassIndexMeta *

cass_table_meta_index_by_name_n

( const CassTableMeta * table_meta, const char * index, size_t index_length )

Same as CassTableMeta::cass_table_meta_index_by_name, but with lengths for string parameters.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index const char *
in index_length size_t
Returns:
Type Details
const CassIndexMeta *

same as CassTableMeta::cass_table_meta_index_by_name
See Also:
size_t

cass_table_meta_index_count

( const CassTableMeta * table_meta )

Gets the total number of indexes for the table.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
size_t

The total index count.
const CassIndexMeta *

cass_table_meta_index

( const CassTableMeta * table_meta, size_t index )

Gets the index metadata for the provided index.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index size_t
Returns:
Type Details
const CassIndexMeta *

The metadata for a index. NULL returned if the index is out of range.
const CassMaterializedViewMeta *

cass_table_meta_materialized_view_by_name

( const CassTableMeta * table_meta, const char * view )

Gets the materialized view metadata for the provided view name.

Requires Apache Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in view const char *
Returns:
Type Details
const CassMaterializedViewMeta *

The metadata for a view. NULL if view does not exist.
const CassMaterializedViewMeta *

cass_table_meta_materialized_view_by_name_n

( const CassTableMeta * table_meta, const char * view, size_t view_length )

Same as CassTableMeta::cass_table_meta_materialized_view_by_name, but with lengths for string parameters.

Requires Apache Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in view const char *
in view_length size_t
Returns:
Type Details
const CassMaterializedViewMeta *

same as CassTableMeta::cass_table_meta_materialized_view_by_name
See Also:
size_t

cass_table_meta_materialized_view_count

( const CassTableMeta * table_meta )

Gets the total number of views for the table.

Requires Apache Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
size_t

The total view count.
const CassMaterializedViewMeta *

cass_table_meta_materialized_view

( const CassTableMeta * table_meta, size_t index )

Gets the materialized view metadata for the provided index.

Requires Apache Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index size_t
Returns:
Type Details
const CassMaterializedViewMeta *

The metadata for a view. NULL returned if the index is out of range.
size_t

cass_table_meta_partition_key_count

( const CassTableMeta * table_meta )

Gets the number of columns for the table’s partition key.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
size_t

The count for the number of columns in the partition key.
const CassColumnMeta *

cass_table_meta_partition_key

( const CassTableMeta * table_meta, size_t index )

Gets the partition key column metadata for the provided index.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index size_t
Returns:
Type Details
const CassColumnMeta *

The metadata for a column. NULL returned if the index is out of range.
See Also:
size_t

cass_table_meta_clustering_key_count

( const CassTableMeta * table_meta )

Gets the number of columns for the table’s clustering key.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
size_t

The count for the number of columns in the clustering key.
const CassColumnMeta *

cass_table_meta_clustering_key

( const CassTableMeta * table_meta, size_t index )

Gets the clustering key column metadata for the provided index.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index size_t
Returns:
Type Details
const CassColumnMeta *

The metadata for a column. NULL returned if the index is out of range.
See Also:
CassClusteringOrder

cass_table_meta_clustering_key_order

( const CassTableMeta * table_meta, size_t index )

Gets the clustering order column metadata for the provided index.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in index size_t
Returns:
Type Details
CassClusteringOrder

The clustering order for a column. CASS_CLUSTERING_ORDER_NONE returned if the index is out of range.
See Also:
const CassValue *

cass_table_meta_field_by_name

( const CassTableMeta * table_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 “tables” metadata table.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in name const char *
Returns:
Type Details
const CassValue *

A metadata field value. NULL if the field does not exist.
const CassValue *

cass_table_meta_field_by_name_n

( const CassTableMeta * table_meta, const char * name, size_t name_length )

Same as CassTableMeta::cass_table_meta_field_by_name, but with lengths for string parameters.

Parameters:
Name Type Details
in table_meta const CassTableMeta *
in name const char *
in name_length size_t
Returns:
Type Details
const CassValue *

same as CassTableMeta::cass_table_meta_field_by_name
See Also:
CassIterator *

cass_iterator_columns_from_table_meta

( const CassTableMeta * table_meta )

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

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also:
CassIterator *

cass_iterator_indexes_from_table_meta

( const CassTableMeta * table_meta )

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

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also:
CassIterator *

cass_iterator_materialized_views_from_table_meta

( const CassTableMeta * table_meta )

Creates a new iterator for the specified materialized view metadata. This can be used to iterate over columns.

Requires Apache Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also:
CassIterator *

cass_iterator_fields_from_table_meta

( const CassTableMeta * table_meta )

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

Parameters:
Name Type Details
in table_meta const CassTableMeta *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also: