Class ClientAutoDetector (0.25.0)

public class ClientAutoDetector

Utility class that tries to automatically detect well-known clients and drivers that are connecting to PGAdapter.

Inheritance

java.lang.Object > ClientAutoDetector

Static Fields

DEFAULT_LOCAL_STATEMENTS

public static final ImmutableList<LocalStatement> DEFAULT_LOCAL_STATEMENTS
Field Value
TypeDescription
com.google.common.collect.ImmutableList<LocalStatement>

EMPTY_LOCAL_STATEMENTS

public static final ImmutableList<LocalStatement> EMPTY_LOCAL_STATEMENTS
Field Value
TypeDescription
com.google.common.collect.ImmutableList<LocalStatement>

PGBENCH_USAGE_HINT

public static final String PGBENCH_USAGE_HINT
Field Value
TypeDescription
String

Static Methods

detectClient(PGSetting setting)

public static ClientAutoDetector.WellKnownClient detectClient(PGSetting setting)

Detect the client based on a session state setting.

Parameter
NameDescription
settingPGSetting
Returns
TypeDescription
ClientAutoDetector.WellKnownClient

detectClient(List<ParseMessage> skippedParseMessages, ParseMessage parseMessage)

public static ClientAutoDetector.WellKnownClient detectClient(List<ParseMessage> skippedParseMessages, ParseMessage parseMessage)

Returns the WellKnownClient that the detector thinks is connected to PGAdapter based on the Parse message that has been received.

Parameters
NameDescription
skippedParseMessagesList<ParseMessage>
parseMessageParseMessage
Returns
TypeDescription
ClientAutoDetector.WellKnownClient

detectClient(List<ParseMessage> skippedParseMessages, List<Statement> statements)

public static ClientAutoDetector.WellKnownClient detectClient(List<ParseMessage> skippedParseMessages, List<Statement> statements)

Returns the WellKnownClient that the detector thinks is connected to PGAdapter based on the given list of SQL statements that have been executed.

Parameters
NameDescription
skippedParseMessagesList<ParseMessage>
statementsList<com.google.cloud.spanner.Statement>
Returns
TypeDescription
ClientAutoDetector.WellKnownClient

detectClient(List<String> orderParameterKeys, Map<String,String> parameters)

public static ClientAutoDetector.WellKnownClient detectClient(List<String> orderParameterKeys, Map<String,String> parameters)

Returns the WellKnownClient that the detector thinks is connecting to PGAdapter based purely on the list of parameters. It will return UNSPECIFIED if no specific client could be determined.

Parameters
NameDescription
orderParameterKeysList<String>
parametersMap<String,String>
Returns
TypeDescription
ClientAutoDetector.WellKnownClient

Constructors

ClientAutoDetector()

public ClientAutoDetector()