Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassAggregateMeta

Requires Cassandra: 2.2+

Functions

void

cass_aggregate_meta_name

( aggregate_meta, name, name_length )

Gets the name of the aggregate.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
out name
out name_length
void

cass_aggregate_meta_full_name

( aggregate_meta, full_name, full_name_length )

Gets the full name of the aggregate. The full name includes the aggregate’s name and the aggregate’s signature: “name(type1 type2.. typeN)”.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
out full_name
out full_name_length
size_t

cass_aggregate_meta_argument_count

( aggregate_meta )

Gets the number of arguments this aggregate takes.

Requires Cassandra: 2.2+

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

The number of arguments.
const CassDataType *

cass_aggregate_meta_argument_type

( aggregate_meta, index )

Gets the aggregate’s argument type for the provided index.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
in index
Returns:
Type Details
const CassDataType *

The data type for argument. NULL returned if the index is out of range.
const CassDataType *

cass_aggregate_meta_return_type

( aggregate_meta )

Gets the return type of the aggregate.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
Returns:
Type Details
const CassDataType *

The data type returned by the aggregate.
const CassDataType *

cass_aggregate_meta_state_type

( aggregate_meta )

Gets the state type of the aggregate.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
Returns:
Type Details
const CassDataType *

The data type of the aggregate’s state.
const CassFunctionMeta *

cass_aggregate_meta_state_func

( aggregate_meta )

Gets the function metadata for the aggregate’s state function.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
Returns:
Type Details
const CassFunctionMeta *

The function metadata for the state function.
const CassFunctionMeta *

cass_aggregate_meta_final_func

( aggregate_meta )

Gets the function metadata for the aggregates’s final function.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
Returns:
Type Details
const CassFunctionMeta *

The function metadata for the final function.
const CassValue *

cass_aggregate_meta_init_cond

( aggregate_meta )

Gets the initial condition value for the aggregate.

Requires Cassandra: 2.2+

Note: The value of the initial condition will always be a “varchar” type for Cassandra 3.0+.

Parameters:
Name Type Details
in aggregate_meta
Returns:
Type Details
const CassValue *

The value of the initial condition.
const CassValue *

cass_aggregate_meta_field_by_name

( aggregate_meta, name )

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying “aggregates” metadata table.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in aggregate_meta
in name
Returns:
Type Details
const CassValue *

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

cass_aggregate_meta_field_by_name_n

( aggregate_meta, name, name_length )

Same as CassAggregateMeta::cass_aggregate_meta_field_by_name, but with lengths for string parameters.

Requires Cassandra: 2.2+

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

same as CassAggregateMeta::cass_aggregate_meta_field_by_name
See Also:
CassIterator *

cass_iterator_fields_from_aggregate_meta

( aggregate_meta )

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

Requires Cassandra: 2.2+

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

A new iterator that must be freed.
See Also: