struct CassFunctionMeta

Requires Apache Cassandra: 2.2+

Functions

void

cass_function_meta_name

( const CassFunctionMeta * function_meta, const char ** name, size_t * name_length )

Gets the name of the function.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
out name const char **
out name_length size_t *
void

cass_function_meta_full_name

( const CassFunctionMeta * function_meta, const char ** full_name, size_t * full_name_length )

Gets the full name of the function. The full name includes the function’s name and the function’s signature: “name(type1 type2.. typeN)”.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
out full_name const char **
out full_name_length size_t *
void

cass_function_meta_body

( const CassFunctionMeta * function_meta, const char ** body, size_t * body_length )

Gets the body of the function.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
out body const char **
out body_length size_t *
void

cass_function_meta_language

( const CassFunctionMeta * function_meta, const char ** language, size_t * language_length )

Gets the language of the function.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
out language const char **
out language_length size_t *
cass_bool_t

cass_function_meta_called_on_null_input

( const CassFunctionMeta * function_meta )

Gets whether a function is called on “null”.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
Returns:
Type Details
cass_bool_t

cass_true if a function is called on null, otherwise cass_false.
size_t

cass_function_meta_argument_count

( const CassFunctionMeta * function_meta )

Gets the number of arguments this function takes.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
Returns:
Type Details
size_t

The number of arguments.
CassError

cass_function_meta_argument

( const CassFunctionMeta * function_meta, size_t index, const char ** name, size_t * name_length, const CassDataType ** type )

Gets the function’s argument name and type for the provided index.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
in index size_t
out name const char **
out name_length size_t *
out type const CassDataType **
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred
const CassDataType *

cass_function_meta_argument_type_by_name

( const CassFunctionMeta * function_meta, const char * name )

Gets the function’s argument and type for the provided name.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
in name const char *
Returns:
Type Details
const CassDataType *

A data type. NULL if the argument does not exist.
const CassDataType *

cass_function_meta_argument_type_by_name_n

( const CassFunctionMeta * function_meta, const char * name, size_t name_length )

Same as CassFunctionMeta::cass_function_meta_argument_type_by_name, but with lengths for string parameters.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
in name const char *
in name_length size_t
Returns:
Type Details
const CassDataType *

same as CassFunctionMeta::cass_function_meta_argument_type_by_name
See Also:
const CassDataType *

cass_function_meta_return_type

( const CassFunctionMeta * function_meta )

Gets the return type of the function.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
Returns:
Type Details
const CassDataType *

The data type returned by the function.
const CassValue *

cass_function_meta_field_by_name

( const CassFunctionMeta * function_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 “functions” metadata table.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
in name const char *
Returns:
Type Details
const CassValue *

A metadata field value. NULL if the field does not exist.
const CassValue *

cass_function_meta_field_by_name_n

( const CassFunctionMeta * function_meta, const char * name, size_t name_length )

Same as CassFunctionMeta::cass_function_meta_field_by_name, but with lengths for string parameters.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
in name const char *
in name_length size_t
Returns:
Type Details
const CassValue *

same as CassFunctionMeta::cass_function_meta_field_by_name
See Also:
CassIterator *

cass_iterator_fields_from_function_meta

( const CassFunctionMeta * function_meta )

Creates a new fields iterator for the specified function metadata. Metadata fields allow direct access to the column data found in the underlying “functions” metadata table. This can be used to iterate those metadata field entries.

Requires Apache Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta const CassFunctionMeta *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also: