Menu

CassAggregateMeta

struct CassAggregateMeta

Requires Apache Cassandra: 2.2+

Public Functions

void cass_aggregate_meta_name(const CassAggregateMeta *aggregate_meta, const char **name, size_t *name_length)

Gets the name of the aggregate.

Requires Apache Cassandra: 2.2+

Parameters
  • aggregate_meta:

  • name:

  • name_length:

void cass_aggregate_meta_full_name(const CassAggregateMeta *aggregate_meta, const char **full_name, size_t *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 Apache Cassandra: 2.2+

Parameters
  • aggregate_meta:

  • full_name:

  • full_name_length:

size_t cass_aggregate_meta_argument_count(const CassAggregateMeta *aggregate_meta)

Gets the number of arguments this aggregate takes.

Requires Apache Cassandra: 2.2+

Return

The number of arguments.

Parameters
  • aggregate_meta:

const CassDataType *cass_aggregate_meta_argument_type(const CassAggregateMeta *aggregate_meta, size_t index)

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

Requires Apache Cassandra: 2.2+

Return

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

Parameters
  • aggregate_meta:

  • index:

const CassDataType *cass_aggregate_meta_return_type(const CassAggregateMeta *aggregate_meta)

Gets the return type of the aggregate.

Requires Apache Cassandra: 2.2+

Return

The data type returned by the aggregate.

Parameters
  • aggregate_meta:

const CassDataType *cass_aggregate_meta_state_type(const CassAggregateMeta *aggregate_meta)

Gets the state type of the aggregate.

Requires Apache Cassandra: 2.2+

Return

The data type of the aggregate’s state.

Parameters
  • aggregate_meta:

const CassFunctionMeta *cass_aggregate_meta_state_func(const CassAggregateMeta *aggregate_meta)

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

Requires Apache Cassandra: 2.2+

Return

The function metadata for the state function.

Parameters
  • aggregate_meta:

const CassFunctionMeta *cass_aggregate_meta_final_func(const CassAggregateMeta *aggregate_meta)

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

Requires Apache Cassandra: 2.2+

Return

The function metadata for the final function.

Parameters
  • aggregate_meta:

const CassValue *cass_aggregate_meta_init_cond(const CassAggregateMeta *aggregate_meta)

Gets the initial condition value for the aggregate.

Requires Apache Cassandra: 2.2+

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

Return

The value of the initial condition.

Parameters
  • aggregate_meta:

const CassValue *cass_aggregate_meta_field_by_name(const CassAggregateMeta *aggregate_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 “aggregates” metadata table.

Requires Apache Cassandra: 2.2+

Return

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

Parameters
  • aggregate_meta:

  • name:

const CassValue *cass_aggregate_meta_field_by_name_n(const CassAggregateMeta *aggregate_meta, const char *name, size_t name_length)

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

Requires Apache Cassandra: 2.2+

Return

same as cass_aggregate_meta_field_by_name()

See

cass_aggregate_meta_field_by_name()

Parameters
  • aggregate_meta:

  • name:

  • name_length:

CassIterator *cass_iterator_fields_from_aggregate_meta(const CassAggregateMeta *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 Apache Cassandra: 2.2+

Return

A new iterator that must be freed.

See

cass_iterator_get_meta_field()

See

cass_iterator_free()

Parameters
  • aggregate_meta: