sa_conn_compression_info system procedure

Summarizes communication compression rates.

Syntax
sa_conn_compression_info( [ connidparm ] )
Arguments
  • connidparm   Use this optional INTEGER parameter to specify the ID number of a connection.

Result set
Column name Data type Description
Type VARCHAR(20) A string identifying whether the compression statistics that follow represent either one Connection, or all connections to the Server.
ConnNumber INTEGER An INTEGER representing a connection ID. Returns NULL if the Type is Server.
Compression VARCHAR(10) A string representing whether compression is enabled for the connection. Returns NULL if Type is Server, or ON/OFF if Type is Connection.
TotalBytes INTEGER An INTEGER representing the total number of actual bytes both sent and received.
TotalBytesUnComp INTEGER An INTEGER representing the number of bytes that would have been sent and received if compression was disabled.
CompRate NUMERIC(5,2) A NUMERIC (5,2) representing the overall compression rate. For example, a value of 0 indicates that no compression occurred. A value of 75 indicates that the data was compressed by 75%, or down to one quarter of its original size.
CompRateSent NUMERIC(5,2) A NUMERIC (5,2) representing the compression rate for data sent to the client.
CompRateReceived NUMERIC(5,2) A NUMERIC (5,2) representing the compression rate for data received from the client.
TotalPackets INTEGER An INTEGER representing the total number of actual packets both sent and received.
TotalPacketsUnComp INTEGER An INTEGER representing the total number of packets that would have been sent and received if compression was disabled.
CompPktRate NUMERIC(5,2) A NUMERIC (5,2) representing the overall compression rate of packets.
CompPktRateSent NUMERIC(5,2) A NUMERIC (5,2) representing the compression rate of packets sent to the client.
CompPktRateReceived NUMERIC(5,2) A NUMERIC (5,2) representing the compression rate of packets received from the client.
Remarks

If you specify the connection ID number, the sa_conn_compression_info system procedure returns a result set consisting of compression properties for the supplied connection. If no connection-id is supplied, this system procedure returns information for all current connections to databases on the server.

For information about the properties these values are derived from, see Connection properties.

Permissions

None

Side effects

None

Example

The following example uses the sa_conn_compression_info system procedure to return a result set summarizing compression properties for all connections to the server.

CALL sa_conn_compression_info( );
Type ConnNumber Compression TotalBytes ...
Connection 79 Off 7841 ...
Server (NULL) (NULL) 2737761 ...
... ... ... ... ...