struct CassTableMeta

Table metadata

Functions

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:
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 *
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.
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.
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.
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_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: