Package org.mariadb.jdbc.client
Interface Client
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
MultiPrimaryClient
,MultiPrimaryReplicaClient
,ReplayClient
,StandardClient
Client interface
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Abort current connectionvoid
close()
Close clientvoid
closePrepare
(Prepare prepare) Close prepare commandexecute
(ClientMessage message, boolean canRedo) Send client message and read resultexecute
(ClientMessage message, Statement stmt, boolean canRedo) Send client message and read resultexecute
(ClientMessage message, Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, boolean canRedo) Send client message and read resultexecutePipeline
(ClientMessage[] messages, Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, boolean canRedo) Send client messages pipelining and read resultGet connection contextGet connection exception factoryGet connection hostGet current socket IP or null (for Pipe / unix socket)int
get socket timeoutboolean
isClosed()
Is client closedboolean
is current client writer or read-onlyvoid
readStreamingResults
(List<Completion> completions, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion) Read resultsvoid
reset()
Reset connectionvoid
setReadOnly
(boolean readOnly) Switch to a writer/read-only connection, no effet on mono-connectionvoid
setSocketTimeout
(int milliseconds) Set socket timeout
-
Method Details
-
execute
Send client message and read result- Parameters:
message
- client messagecanRedo
- can client message be redone in case of failover- Returns:
- results
- Throws:
SQLException
- if execution fails
-
execute
List<Completion> execute(ClientMessage message, Statement stmt, boolean canRedo) throws SQLException Send client message and read result- Parameters:
message
- client messagestmt
- statementcanRedo
- can client message be redone in case of failover- Returns:
- results
- Throws:
SQLException
- if execution fails
-
execute
List<Completion> execute(ClientMessage message, Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, boolean canRedo) throws SQLException Send client message and read result- Parameters:
message
- client messagestmt
- statementfetchSize
- fetch sizemaxRows
- maximum number of rows. 0 = allresultSetConcurrency
- concurrencyresultSetType
- result-set typecloseOnCompletion
- close statement on completioncanRedo
- can client message be redone in case of failover- Returns:
- results
- Throws:
SQLException
- if any error occurs
-
executePipeline
List<Completion> executePipeline(ClientMessage[] messages, Statement stmt, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion, boolean canRedo) throws SQLException Send client messages pipelining and read result- Parameters:
messages
- client messagestmt
- statementfetchSize
- fetch sizemaxRows
- maximum number of rows. 0 = allresultSetConcurrency
- concurrencyresultSetType
- result-set typecloseOnCompletion
- close statement on completioncanRedo
- can client message be redone in case of failover- Returns:
- results
- Throws:
SQLException
- if any error occurs
-
readStreamingResults
void readStreamingResults(List<Completion> completions, int fetchSize, long maxRows, int resultSetConcurrency, int resultSetType, boolean closeOnCompletion) throws SQLException Read results- Parameters:
completions
- List that will have the new resultsfetchSize
- fetch sizemaxRows
- maximum number of rows. 0 = allresultSetConcurrency
- concurrencyresultSetType
- result-set typecloseOnCompletion
- close statement on completion- Throws:
SQLException
- if any error occurs
-
closePrepare
Close prepare command- Parameters:
prepare
- prepare command- Throws:
SQLException
- if any error occurs
-
abort
Abort current connection- Parameters:
executor
- executor- Throws:
SQLException
- if any error occurs
-
close
Close client- Specified by:
close
in interfaceAutoCloseable
- Throws:
SQLException
- if any error occurs
-
setReadOnly
Switch to a writer/read-only connection, no effet on mono-connection- Parameters:
readOnly
- must use read-only connection- Throws:
SQLException
- if any error occurs
-
getSocketTimeout
int getSocketTimeout()get socket timeout- Returns:
- socket timeout
-
setSocketTimeout
Set socket timeout- Parameters:
milliseconds
- timeout- Throws:
SQLException
- if any error occurs
-
isClosed
boolean isClosed()Is client closed- Returns:
- close flag
-
reset
void reset()Reset connection -
isPrimary
boolean isPrimary()is current client writer or read-only- Returns:
- is primary
-
getContext
Context getContext()Get connection context- Returns:
- connection context
-
getExceptionFactory
ExceptionFactory getExceptionFactory()Get connection exception factory- Returns:
- connection exception factory
-
getHostAddress
HostAddress getHostAddress()Get connection host- Returns:
- connection host
-
getSocketIp
String getSocketIp()Get current socket IP or null (for Pipe / unix socket)- Returns:
- Socket current IP
-