Package net.snowflake.client.jdbc

Class SnowflakeSQLLoggedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.sql.SQLException

net.snowflake.client.jdbc.SnowflakeSQLException

net.snowflake.client.jdbc.SnowflakeSQLLoggedException

All Implemented Interfaces:

Serializable, Iterable<Throwable>

public class SnowflakeSQLLoggedException
extends SnowflakeSQLException

This SnowflakeSQLLoggedException class extends the SnowflakeSQLException class to add OOB telemetry data for sql exceptions. Not all sql exceptions require OOB telemetry logging so the exceptions in this class should only be thrown if there is a need for logging the exception with OOB telemetry.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SnowflakeSQLLoggedException(String queryId, SFBaseSession session, int vendorCode, String SQLState)
SnowflakeSQLLoggedException(String queryId, SFBaseSession session, int vendorCode, String SQLState, Object... params)
SnowflakeSQLLoggedException(String queryId, SFBaseSession session, String reason)
SnowflakeSQLLoggedException(String queryId, SFBaseSession session, String SQLState, int vendorCode, Throwable ex, Object... params)
SnowflakeSQLLoggedException(String queryId, SFBaseSession session, String SQLState, String reason)
SnowflakeSQLLoggedException(String queryId, SFBaseSession session, ErrorCode errorCode, Object... params)
SnowflakeSQLLoggedException(String queryID, SFSession session, String sqlState, String message, Exception cause)
SnowflakeSQLLoggedException(SFBaseSession session, int vendorCode, String SQLState)
SnowflakeSQLLoggedException(SFBaseSession session, int vendorCode, String SQLState, Object... params)
SnowflakeSQLLoggedException(SFBaseSession session, String reason)	Deprecated.
SnowflakeSQLLoggedException(SFBaseSession session, String SQLState, int vendorCode, Throwable ex, Object... params)
SnowflakeSQLLoggedException(SFBaseSession session, String SQLState, String reason)	Deprecated.
SnowflakeSQLLoggedException(SFBaseSession session, String reason, String SQLState, int vendorCode, String queryId)
SnowflakeSQLLoggedException(SFBaseSession session, SFException e)
SnowflakeSQLLoggedException(SFBaseSession session, ErrorCode errorCode, Object... params)	Deprecated.
SnowflakeSQLLoggedException(SFBaseSession session, ErrorCode errorCode, Throwable ex, Object... params)

Method Summary

Modifier and Type	Method	Description
static void	sendTelemetryData(String queryId, String SQLState, int vendorCode, SFBaseSession session, SQLException ex)	Function to construct log data based on possible exception inputs and send data through in-band telemetry, or oob if in-band does not work

Methods inherited from class net.snowflake.client.jdbc.SnowflakeSQLException

getElapsedSeconds, getQueryId, getRetryCount, issocketTimeoutNoBackoff

Methods inherited from class java.sql.SQLException

getErrorCode, getNextException, getSQLState, iterator, setNextException

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryID,
                                   SFSession session,
                                   String sqlState,
                                   String message,
                                   Exception cause)

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(SFBaseSession session,
                                   String reason,
                                   String SQLState,
                                   int vendorCode,
                                   String queryId)

Parameters:

session - SFBaseSession

reason - exception reason

SQLState - the SQL state

vendorCode - the vendor code

queryId - the query ID

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(SFBaseSession session,
                                   int vendorCode,
                                   String SQLState)

Parameters:

session - SFBaseSession

vendorCode - the vendor code

SQLState - the SQL state

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryId,
                                   SFBaseSession session,
                                   int vendorCode,
                                   String SQLState)

Parameters:

queryId - the query ID

session - SFBaseSession

vendorCode - the vendor code

SQLState - the SQL state

SnowflakeSQLLoggedException

@Deprecated
public SnowflakeSQLLoggedException(SFBaseSession session,
                                   String SQLState,
                                   String reason)

Deprecated.

use SnowflakeSQLLoggedException(String, SFBaseSession, String, String)

Parameters:

session - SFBaseSession

SQLState - the SQL state

reason - exception reason

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryId,
                                   SFBaseSession session,
                                   String SQLState,
                                   String reason)

Parameters:

queryId - the query ID

session - SFBaseSession

SQLState - the SQL state

reason - the exception reason

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(SFBaseSession session,
                                   int vendorCode,
                                   String SQLState,
                                   Object... params)

Parameters:

session - SFBaseSession

vendorCode - the vendor code

SQLState - the SQL state

params - additional parameters

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryId,
                                   SFBaseSession session,
                                   int vendorCode,
                                   String SQLState,
                                   Object... params)

Parameters:

queryId - the query ID

session - SFBaseSession

vendorCode - the vendor code

SQLState - the SQL state

params - additional parameters

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(SFBaseSession session,
                                   ErrorCode errorCode,
                                   Throwable ex,
                                   Object... params)

Parameters:

session - SFBaseSession

errorCode - the error code

ex - Throwable exception

params - additional parameters

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(SFBaseSession session,
                                   String SQLState,
                                   int vendorCode,
                                   Throwable ex,
                                   Object... params)

Parameters:

session - SFBaseSession

SQLState - the SQL state

vendorCode - the vendor code

ex - Throwable exception

params - additional parameters

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryId,
                                   SFBaseSession session,
                                   String SQLState,
                                   int vendorCode,
                                   Throwable ex,
                                   Object... params)

Parameters:

queryId - the query ID

session - SFBaseSession

SQLState - the SQL state

vendorCode - the vendor code

ex - Throwable exception

params - additional parameters

SnowflakeSQLLoggedException

@Deprecated
public SnowflakeSQLLoggedException(SFBaseSession session,
                                   ErrorCode errorCode,
                                   Object... params)

Deprecated.

use SnowflakeSQLLoggedException(String, SFBaseSession, ErrorCode, Object...)

Parameters:

session - SFBaseSession

errorCode - the error code

params - additional parameters

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryId,
                                   SFBaseSession session,
                                   ErrorCode errorCode,
                                   Object... params)

Parameters:

queryId - the query ID

session - SFBaseSession

errorCode - the error code

params - additional parameters

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(SFBaseSession session,
                                   SFException e)

Parameters:

session - SFBaseSession

e - throwable exception

SnowflakeSQLLoggedException

@Deprecated
public SnowflakeSQLLoggedException(SFBaseSession session,
                                   String reason)

Deprecated.

use SnowflakeSQLLoggedException(String, SFBaseSession, String)

Parameters:

session - SFBaseSession

reason - exception reason

SnowflakeSQLLoggedException

public SnowflakeSQLLoggedException(String queryId,
                                   SFBaseSession session,
                                   String reason)

Parameters:

queryId - the query ID

session - SFBaseSession

reason - exception reason

Method Detail

sendTelemetryData

public static void sendTelemetryData(String queryId,
                                     String SQLState,
                                     int vendorCode,
                                     SFBaseSession session,
                                     SQLException ex)

Function to construct log data based on possible exception inputs and send data through in-band telemetry, or oob if in-band does not work

Parameters:

queryId - query ID if exists

SQLState - SQLState

vendorCode - vendor code

session - session object, which is needed to send in-band telemetry but not oob. Might be null, in which case oob is used.

ex - Exception object