Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassTableMeta

Table metadata

Functions

void

cass_table_meta_name

( table_meta, name, name_length )

Gets the name of the table.

Parameters:
Name Type Details
in table_meta
out name
out name_length
const CassColumnMeta *

cass_table_meta_column_by_name

( table_meta, column )

Gets the column metadata for the provided column name.

Parameters:
Name Type Details
in table_meta
in column
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

( table_meta, column, column_length )

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

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

same as CassTableMeta::cass_table_meta_column_by_name
See Also:
size_t

cass_table_meta_column_count

( table_meta )

Gets the total number of columns for the table.

Parameters:
Name Type Details
in table_meta
Returns:
Type Details
size_t

The total column count.
const CassColumnMeta *

cass_table_meta_column

( table_meta, index )

Gets the column metadata for the provided index.

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta, index )

Gets the index metadata for the provided index name.

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta, index, index_length )

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

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

same as CassTableMeta::cass_table_meta_index_by_name
See Also:
size_t

cass_table_meta_index_count

( table_meta )

Gets the total number of indexes for the table.

Parameters:
Name Type Details
in table_meta
Returns:
Type Details
size_t

The total index count.
const CassIndexMeta *

cass_table_meta_index

( table_meta, index )

Gets the index metadata for the provided index.

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta, view )

Gets the materialized view metadata for the provided view name.

Requires Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta
in view
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

( table_meta, view, view_length )

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

Requires Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta
in view
in view_length
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

( table_meta )

Gets the total number of views for the table.

Requires Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta
Returns:
Type Details
size_t

The total view count.
const CassMaterializedViewMeta *

cass_table_meta_materialized_view

( table_meta, index )

Gets the materialized view metadata for the provided index.

Requires Cassandra: 3.0+

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta )

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

Parameters:
Name Type Details
in table_meta
Returns:
Type Details
size_t

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

cass_table_meta_partition_key

( table_meta, index )

Gets the partition key column metadata for the provided index.

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta )

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

Parameters:
Name Type Details
in table_meta
Returns:
Type Details
size_t

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

cass_table_meta_clustering_key

( table_meta, index )

Gets the clustering key column metadata for the provided index.

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta, index )

Gets the clustering order column metadata for the provided index.

Parameters:
Name Type Details
in table_meta
in index
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

( table_meta, 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
in name
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

( table_meta, name, name_length )

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

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

same as CassTableMeta::cass_table_meta_field_by_name
See Also:
CassIterator *

cass_iterator_columns_from_table_meta

( 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
Returns:
Type Details
CassIterator *

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

cass_iterator_indexes_from_table_meta

( 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
Returns:
Type Details
CassIterator *

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

cass_iterator_materialized_views_from_table_meta

( table_meta )

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

Requires Cassandra: 3.0+

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

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

cass_iterator_fields_from_table_meta

( 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
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also: