Lists all user-defined aggregates (UDAs) or shows the CQL definition for a specific UDA.

Shows this output depending on the options selected:

  • All user-defined aggregates (UDAs) in the current keyspace.
  • All UDAs in the cluster when no keyspace is selected.
  • Definition as an executable CQL statement for a specific UDA.


DESCRIBE AGGREGATES | AGGREGATE [keyspace_name.]uda_name
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a user-defined value.
[] Optional. Square brackets ( [] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key : value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement; End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[--] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrConfig files.
All aggregates.
One aggregate.
Name of the keyspace.

Name of the user-defined aggregate.


List all cycling aggregates:
Show the definition of the cycling average aggregate:
DESC AGGREGATE cycling.average
The result is an executable CQL statement:
CREATE AGGREGATE cycling.average(int)
    SFUNC avgstate
    STYPE frozen<tuple<int, bigint>>
    FINALFUNC avgfinal
    INITCOND (0, 0);