DESCRIBE FUNCTION

Print information about user-defined functions (UDFs), depending on selected options:

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

Can be used to verify that a UDF exists.

Synopsis

DESCRIBE FUNCTIONS | FUNCTION [<keyspace_name>.]<udf_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 FUNCTIONS: Get all functions for the current keyspace. If no keyspace is selected, get all functions in the cluster.

Requires no other arguments.

The short form is DESC FUNCTIONS.
DESCRIBE FUNCTION: Get one function specified by name.

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

Examples

List all functions in a keyspace

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

USE cycling;
DESC FUNCTIONS;

The output is a list of function signatures (names and argument types):

flog(double)                              avgfinal(frozen<tuple<int, bigint>>)
avgstate(frozen<tuple<int, bigint>>,int)  left(text,int)

Get the definition for a specific function

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

DESC FUNCTION cycling.flog;

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

CREATE FUNCTION cycling.flog(input double)
    CALLED ON NULL INPUT
    RETURNS double
    LANGUAGE java
    AS $$
      return Double.valueOf(Math.log(input.doubleValue()));
    $$;

DESCRIBE FUNCTION

Synopsis

Examples

Was this helpful?

Give Feedback