struct CassTableMeta
Table metadata
Functions
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 *
- See Also:
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
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.
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.
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.
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 *
- 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_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: