DESCRIBE AGGREGATE

Print information about user-defined aggregates (UDAs), depending on selected options:

A list of all UDAs in the current keyspace.
A list of all UDAs in the cluster when no keyspace is selected.
One UDA, as an executable CQL statement.

Can be used to verify that a UDA exists.

Synopsis

DESCRIBE AGGREGATES | AGGREGATE [<keyspace_name>.]<uda_name>

Legend
Syntax conventions	Description
UPPERCASE	Literal keyword.
Lowercase	Not literal.
`< >`	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.

DESCRIBE AGGREGATES: Get all aggregates for the current keyspace. If no keyspace is selected, get all aggregates in the cluster.

Requires no other arguments.

The short form is DESC AGGREGATES.
DESCRIBE AGGREGATE: Get one aggregate specified by name.

The short form is DESC AGGREGATE.
<keyspace_name>: Optional. Name of the keyspace containing the aggregate for DESCRIBE AGGREGATE. If not specified, the current keyspace is used.
<uda_name>: Name of the aggregate for DESCRIBE AGGREGATE.

Examples

List all aggregates in a keyspace

Select the keyspace with USE, and then run DESC AGGREGATES with no arguments:

USE cycling;
DESC AGGREGATES;

The output is a list of aggregate signatures (names and argument types).

Get the definition for a specific aggregate

Specify the keyspace (optional) and name of the aggregate to describe:

DESC AGGREGATE cycling.average;

If the aggregate exists, the result is the aggregate definition as an executable CQL statement:

CREATE AGGREGATE cycling.average(int)
    SFUNC avgstate
    STYPE frozen<tuple<int, bigint>>
    FINALFUNC avgfinal
    INITCOND (0, 0);

DESCRIBE AGGREGATE

Synopsis

Examples

Was this helpful?

Give Feedback