ifx_gridquery_skipped_nodes() function

The ifx_gridquery_skipped_nodes() function returns the name of a server that was unavailable during a grid or shard query.

Syntax


1  EXECUTE FUNCTION ifx_gridquery_skipped_nodes ( ) ;

Usage

If you set the GRID_NODE_SKIP option of the SET ENVIRONMENT statement to ’on’, any servers that are unavailable when a grid or shard query is run are skipped. Run the ifx_gridquery_skipped_nodes() function to return the name of a skipped server.

Use the ifx_gridquery_skipped_nodes() function with the ifx_gridquery_skipped_node_count() function. Run the ifx_gridquery_skipped_node_count() function to determine how many servers were skipped, and then run the ifx_gridquery_skipped_nodes() function the same number of times as the number of skipped servers.

Return value

An LVARCHAR string that supplies the name of a skipped server.

A return value of 0 indicates no skipped servers.

Example

The following statement returns the number of skipped nodes in the grid or shard query:

EXECUTE FUNCTION ifx_gridquery_skipped_node_count();

2

The following statements return the names of the two skipped nodes:

EXECUTE FUNCTION ifx_gridquery_skipped_nodes();

server1

EXECUTE FUNCTION ifx_gridquery_skipped_nodes();

server2