# CassAggregateMeta

### struct CassAggregateMeta

### Public Functions

### void cass_aggregate_meta_name(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta, const char \*\*name, size_t \*name_length)

Gets the name of the aggregate.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **aggregate_meta** – **[in]** 
  * **name** – **[out]** 
  * **name_length** – **[out]** 

### void cass_aggregate_meta_full_name(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*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)”.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **aggregate_meta** – **[in]** 
  * **full_name** – **[out]** 
  * **full_name_length** – **[out]** 

### size_t cass_aggregate_meta_argument_count(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta)

Gets the number of arguments this aggregate takes.

**Warning:** This function is not yet implemented.

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  The number of arguments. 

### const [CassDataType](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassDataType.md#_CPPv412CassDataType) \*cass_aggregate_meta_argument_type(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta, size_t index)

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

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **aggregate_meta** – **[in]** 
  * **index** – **[in]** 
* **Returns:**
  The data type for argument. NULL returned if the index is out of range. 

### const [CassDataType](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassDataType.md#_CPPv412CassDataType) \*cass_aggregate_meta_return_type(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta)

Gets the return type of the aggregate.

**Warning:** This function is not yet implemented.

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  The data type returned by the aggregate. 

### const [CassDataType](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassDataType.md#_CPPv412CassDataType) \*cass_aggregate_meta_state_type(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta)

Gets the state type of the aggregate.

**Warning:** This function is not yet implemented.

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  The data type of the aggregate’s state. 

### const [CassFunctionMeta](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassFunctionMeta.md#_CPPv416CassFunctionMeta) \*cass_aggregate_meta_state_func(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta)

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

**Warning:** This function is not yet implemented.

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  The function metadata for the state function. 

### const [CassFunctionMeta](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassFunctionMeta.md#_CPPv416CassFunctionMeta) \*cass_aggregate_meta_final_func(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta)

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

**Warning:** This function is not yet implemented.

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  The function metadata for the final function. 

### const [CassValue](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassValue.md#_CPPv49CassValue) \*cass_aggregate_meta_init_cond(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta)

Gets the initial condition value for the aggregate.

**Warning:** This function is not yet implemented.

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

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  The value of the initial condition. 

### const [CassValue](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassValue.md#_CPPv49CassValue) \*cass_aggregate_meta_field_by_name(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*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.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **aggregate_meta** – **[in]** 
  * **name** – **[in]** 
* **Returns:**
  A metadata field value. NULL if the field does not exist. 

### const [CassValue](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassValue.md#_CPPv49CassValue) \*cass_aggregate_meta_field_by_name_n(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*aggregate_meta, const char \*name, size_t name_length)

Same as [cass_aggregate_meta_field_by_name()](#struct_cass_aggregate_meta_1ae1863371d653b69e8c10376ff7a1dfee), but with lengths for string parameters.

**Warning:** This function is not yet implemented.

#### SEE ALSO
[cass_aggregate_meta_field_by_name()](#struct_cass_aggregate_meta_1ae1863371d653b69e8c10376ff7a1dfee)

* **Parameters:**
  * **aggregate_meta** – **[in]** 
  * **name** – **[in]** 
  * **name_length** – **[in]** 
* **Returns:**
  same as [cass_aggregate_meta_field_by_name()](#struct_cass_aggregate_meta_1ae1863371d653b69e8c10376ff7a1dfee)

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/master/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_fields_from_aggregate_meta(const [CassAggregateMeta](#_CPPv417CassAggregateMeta) \*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.

**Warning:** This function is not yet implemented.

#### SEE ALSO
cass_iterator_get_meta_field() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **aggregate_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.
