MySQL Shell API  8.0.26
Unified development interface for MySQL Products
Methods | Properties | List of all members
ClassicSession Class Reference

Enables interaction with a MySQL Server using the MySQL Protocol. More...

Methods

void close () override
 Closes the internal connection to the MySQL Server held on this session object.
 
void start_transaction () override
 Starts a transaction context on the server. More...
 
void commit () override
 Commits all the operations executed after a call to start_transaction(). More...
 
void rollback () override
 Discards all the operations executed after a call to start_transaction(). More...
 
str get_uri ()
 Retrieves the URI for the current session. More...
 
ClassicResult run_sql (str query, list args=[])
 Executes a query and returns the corresponding ClassicResult object. More...
 
ClassicResult query (str query, list args=[])
 Executes a query and returns the corresponding ClassicResult object. More...
 
bool is_open ()
 Returns true if session is known to be open. More...
 

Properties

str uri
 Same as get_uri()
 

Detailed Description

Enables interaction with a MySQL Server using the MySQL Protocol.

Provides facilities to execute queries.

# Begins a transaction
classicSession.start_transaction();
# Inserts some records
res1 = classicSession.run_sql('insert into sample values ("john")');
res2 = classicSession.run_sql('insert into sample values ("carol")');
res3 = classicSession.run_sql('insert into sample values ("jack")');
# Commits the transaction
classicSession.commit();

Member Function Documentation

◆ start_transaction()

void start_transaction ( )
override

Starts a transaction context on the server.

Returns
A ClassicResult object.

Calling this function will turn off the autocommit mode on the server.

All the operations executed after calling this function will take place only when commit() is called.

All the operations executed after calling this function, will be discarded if rollback() is called.

When commit() or rollback() are called, the server autocommit mode will return back to it's state before calling start_transaction().

◆ commit()

void commit ( )
override

Commits all the operations executed after a call to start_transaction().

Returns
A ClassicResult object.

All the operations executed after calling start_transaction() will take place when this function is called.

The server autocommit mode will return back to it's state before calling start_transaction().

◆ rollback()

void rollback ( )
override

Discards all the operations executed after a call to start_transaction().

Returns
A ClassicResult object.

All the operations executed after calling start_transaction() will be discarded when this function is called.

The server autocommit mode will return back to it's state before calling start_transaction().

◆ get_uri()

str get_uri ( )

Retrieves the URI for the current session.

Returns
A string representing the connection data.

◆ run_sql()

ClassicResult run_sql ( str  query,
list  args = [] 
)

Executes a query and returns the corresponding ClassicResult object.

Parameters
querythe SQL query to execute against the database.
argsOptional list of literals to use when replacing ? placeholders in the query string.
Returns
A ClassicResult object.
Exceptions
LogicErrorif there's no open session.
ArgumentErrorif the parameters are invalid.

◆ query()

ClassicResult query ( str  query,
list  args = [] 
)

Executes a query and returns the corresponding ClassicResult object.

Parameters
querythe SQL query string to execute, with optional ? placeholders.
argsOptional list of literals to use when replacing ? placeholders in the query string.
Returns
A ClassicResult object.
Attention
This function will be removed in a future release, use the run_sql function instead.
Exceptions
Anexception is thrown if an error occurs on the SQL execution.

◆ is_open()

bool is_open ( )

Returns true if session is known to be open.

Returns
A boolean value indicating if the session is still open.

Returns true if the session is still open and false otherwise.

Note
This function may return true if connection is lost.