struct DseGraphOptions

Graph options for executing graph queries.

Functions

DseGraphOptions *

dse_graph_options_new

( )

Creates a new instance of graph options.

Returns:
Type Details
DseGraphOptions *

Returns a instance of graph options that must be freed.
See Also:
DseGraphOptions *

dse_graph_options_new_from_existing

( const DseGraphOptions * options )

Creates a new instance of graph options from an existing object.

Parameters:
Name Type Details
options const DseGraphOptions *
Returns:
Type Details
DseGraphOptions *

Returns a instance of graph options that must be freed.
See Also:
void

dse_graph_options_free

( DseGraphOptions * options )

Frees a graph options instance.

Parameters:
Name Type Details
in options DseGraphOptions *
CassError

dse_graph_options_set_graph_language

( DseGraphOptions * options, const char * language )

Set the graph language to be used in graph queries.

Default: gremlin-groovy

Parameters:
Name Type Details
in options DseGraphOptions *
in language const char *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_graph_options_set_graph_language_n

( DseGraphOptions * options, const char * language, size_t language_length )

Same as DseGraphOptions::dse_graph_options_set_graph_language, but with lengths for string parameters.

Parameters:
Name Type Details
in options DseGraphOptions *
in language const char *
in language_length size_t
Returns:
Type Details
CassError

same as DseGraphOptions::dse_graph_options_set_graph_language
CassError

dse_graph_options_set_graph_source

( DseGraphOptions * options, const char * source )

Set the graph traversal source name to be used in graph queries.

Default: default

Parameters:
Name Type Details
in options DseGraphOptions *
in source const char *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_graph_options_set_graph_source_n

( DseGraphOptions * options, const char * source, size_t source_length )

Same as DseGraphOptions::dse_graph_options_set_graph_source, but with lengths for string parameters.

Parameters:
Name Type Details
in options DseGraphOptions *
in source const char *
in source_length size_t
Returns:
Type Details
CassError

same as DseGraphOptions::dse_graph_options_set_graph_source
CassError

dse_graph_options_set_graph_name

( DseGraphOptions * options, const char * name )

Set the graph name to be used in graph queries. This is optional and the name is left unset if this function is not called.

Parameters:
Name Type Details
in options DseGraphOptions *
in name const char *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_graph_options_set_graph_name_n

( DseGraphOptions * options, const char * name, size_t name_length )

Same as DseGraphOptions::dse_graph_options_set_graph_name, but with lengths for string parameters.

Parameters:
Name Type Details
in options DseGraphOptions *
in name const char *
in name_length size_t
Returns:
Type Details
CassError

same as DseGraphOptions::dse_graph_options_set_graph_name
CassError

dse_graph_options_set_read_consistency

( DseGraphOptions * options, CassConsistency consistency )

Set the read consistency used by graph queries.

Parameters:
Name Type Details
in options DseGraphOptions *
in consistency CassConsistency
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_graph_options_set_write_consistency

( DseGraphOptions * options, CassConsistency consistency )

Set the write consistency used by graph queries.

Parameters:
Name Type Details
in options DseGraphOptions *
in consistency CassConsistency
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

dse_graph_options_set_request_timeout

( DseGraphOptions * options, cass_int64_t timeout_ms )

Set the request timeout used by graph queries. Only use this if you want graph queries to wait less than the server’s default timeout (defined in “dse.yaml”)

Default: 0 (wait for the coordinator to response or timeout)

Parameters:
Name Type Details
in options DseGraphOptions *
in timeout_ms cass_int64_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.