Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassFunctionMeta

Requires Cassandra: 2.2+

Functions

void

cass_function_meta_name

( function_meta, name, name_length )

Gets the name of the function.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
out name
out name_length
void

cass_function_meta_full_name

( function_meta, full_name, 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 Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
out full_name
out full_name_length
void

cass_function_meta_body

( function_meta, body, body_length )

Gets the body of the function.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
out body
out body_length
void

cass_function_meta_language

( function_meta, language, language_length )

Gets the language of the function.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
out language
out language_length
cass_bool_t

cass_function_meta_called_on_null_input

( function_meta )

Gets whether a function is called on “null”.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
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

( function_meta )

Gets the number of arguments this function takes.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
Returns:
Type Details
size_t

The number of arguments.
CassError

cass_function_meta_argument

( function_meta, index, name, name_length, type )

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

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
in index
out name
out name_length
out type
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred
const CassDataType *

cass_function_meta_argument_type_by_name

( function_meta, name )

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

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
in name
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

( function_meta, name, name_length )

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

Requires Cassandra: 2.2+

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

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

cass_function_meta_return_type

( function_meta )

Gets the return type of the function.

Requires Cassandra: 2.2+

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

The data type returned by the function.
const CassValue *

cass_function_meta_field_by_name

( function_meta, 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 Cassandra: 2.2+

Parameters:
Name Type Details
in function_meta
in name
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

( function_meta, name, name_length )

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

Requires Cassandra: 2.2+

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

same as CassFunctionMeta::cass_function_meta_field_by_name
See Also:
CassIterator *

cass_iterator_fields_from_function_meta

( 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 Cassandra: 2.2+

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

A new iterator that must be freed.
See Also: