CassTableMeta¶

struct CassTableMeta¶

Table metadata

Public Functions

void cass_table_meta_name(const CassTableMeta *table_meta, const char **name, size_t *name_length)¶

Gets the name of the table.

Parameters

• table_meta:

• name:

• name_length:

cass_bool_t cass_table_meta_is_virtual(const CassTableMeta *table_meta)¶

Determine if the table is a virtual table.

Return

cass_true is the table is virtual, otherwise cass_false

Parameters

• table_meta:

const CassColumnMeta *cass_table_meta_column_by_name(const CassTableMeta *table_meta, const char *column)¶

Gets the column metadata for the provided column name.

Return

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

Parameters

• table_meta:

• column:

const CassColumnMeta *cass_table_meta_column_by_name_n(const CassTableMeta *table_meta, const char *column, size_t column_length)¶

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

Return

same as cass_table_meta_column_by_name()

See

cass_table_meta_column_by_name()

Parameters

• table_meta:

• column:

• column_length:

size_t cass_table_meta_column_count(const CassTableMeta *table_meta)¶

Gets the total number of columns for the table.

Return

The total column count.

Parameters

• table_meta:

const CassColumnMeta *cass_table_meta_column(const CassTableMeta *table_meta, size_t index)¶

Gets the column metadata for the provided index.

Return

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

Parameters

• table_meta:

• index:

const CassIndexMeta *cass_table_meta_index_by_name(const CassTableMeta *table_meta, const char *index)¶

Gets the index metadata for the provided index name.

Return

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

Parameters

• table_meta:

• index:

const CassIndexMeta *cass_table_meta_index_by_name_n(const CassTableMeta *table_meta, const char *index, size_t index_length)¶

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

Return

same as cass_table_meta_index_by_name()

See

cass_table_meta_index_by_name()

Parameters

• table_meta:

• index:

• index_length:

size_t cass_table_meta_index_count(const CassTableMeta *table_meta)¶

Gets the total number of indexes for the table.

Return

The total index count.

Parameters

• table_meta:

const CassIndexMeta *cass_table_meta_index(const CassTableMeta *table_meta, size_t index)¶

Gets the index metadata for the provided index.

Return

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

Parameters

• table_meta:

• index:

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+

Return

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

Parameters

• table_meta:

• view:

const CassMaterializedViewMeta *cass_table_meta_materialized_view_by_name_n(const CassTableMeta *table_meta, const char *view, size_t view_length)¶

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

Requires Apache Cassandra: 3.0+

Return

same as cass_table_meta_materialized_view_by_name()

See

cass_table_meta_materialized_view_by_name()

Parameters

• table_meta:

• view:

• view_length:

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+

Return

The total view count.

Parameters

• table_meta:

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+

Return

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

Parameters

• table_meta:

• index:

size_t cass_table_meta_partition_key_count(const CassTableMeta *table_meta)¶

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

Return

The count for the number of columns in the partition key.

Parameters

• table_meta:

const CassColumnMeta *cass_table_meta_partition_key(const CassTableMeta *table_meta, size_t index)¶

Gets the partition key column metadata for the provided index.

Return

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

See

cass_table_meta_partition_key_count()

Parameters

• table_meta:

• index:

size_t cass_table_meta_clustering_key_count(const CassTableMeta *table_meta)¶

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

Return

The count for the number of columns in the clustering key.

Parameters

• table_meta:

const CassColumnMeta *cass_table_meta_clustering_key(const CassTableMeta *table_meta, size_t index)¶

Gets the clustering key column metadata for the provided index.

Return

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

See

cass_table_meta_clustering_key_count()

Parameters

• table_meta:

• index:

CassClusteringOrder cass_table_meta_clustering_key_order(const CassTableMeta *table_meta, size_t index)¶

Gets the clustering order column metadata for the provided index.

Return

The clustering order for a column. CASS_CLUSTERING_ORDER_NONE returned if the index is out of range.

See

cass_table_meta_clustering_key_count()

Parameters

• table_meta:

• index:

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.

Return

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

Parameters

• table_meta:

• name:

const CassValue *cass_table_meta_field_by_name_n(const CassTableMeta *table_meta, const char *name, size_t name_length)¶

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

Return

same as cass_table_meta_field_by_name()

See

cass_table_meta_field_by_name()

Parameters

• table_meta:

• name:

• name_length:

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.

Return

A new iterator that must be freed.

See

cass_iterator_get_column_meta()

See

cass_iterator_free()

Parameters

• table_meta:

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.

Return

A new iterator that must be freed.

See

cass_iterator_get_index_meta()

See

cass_iterator_free()

Parameters

• table_meta:

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+

Return

A new iterator that must be freed.

See

cass_iterator_get_materialized_view_meta()

See

cass_iterator_free()

Parameters

• table_meta:

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.

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

• table_meta: