In this lesson, you will learn how to execute MySQL stored procedures in Python.

Further Reading:

Solve Python MySQL Exercise
Read Python MySQL Tutorial (Complete Guide)

Prerequisites

Before moving further, make sure you have the following in place.

Username and password that you need to connect to MySQL
MySQL stored procedure name which you want to call.

For this lesson, I have created a stored procedure get_laptop under the “Electronics” database. This procedure fetches laptop details from the Laptop table based on the laptop id passed as an IN parameter

If a table is not present in your MySQL server, you can refer to our article to create a MySQL table from Python.

You can also download a SQL query file, which contains SQL queries for table creation and data so that you can use this table for your SQL operations.

If you already know the stored procedure you want to execute, you can skip the following query. Else, open the MySQL console and run the below query to create a MySQL Stored Procedure.

DELIMITER $
USE Electronics$
CREATE * from Laptop where id = d_id;
END $
DELIMITER ;Code language: Python (python)

Now you know the stored procedure to execute, so let’s move to our example.

Note: We are using the MySQL Connector Python module to execute a MySQL Stored Procedure.

Steps to execute MySQL Stored Procedure in Python

To call MySQL stored procedure from Python, you need to follow these steps: –

How to execute MySQL stored procedure in Python

Connect to MySQL from Python
Refer to Python MySQL database connection to connect to MySQL database from Python using MySQL Connector module
Get Cursor Object from Connection
Next, use a connection.cursor() method to create a cursor object. This method creates a new MySQLCursor object.
Execute the stored procedure
Execute the stored procedure using the cursor.callproc(). here, you must know the stored procedure name and its IN and OUT parameters. For example, cursor.callproc('get_laptop',[1,])
Fetch results
Once the stored procedure executes successfully, we can extract the result using a cursor.stored_results()
Close the cursor object and database connection object
use cursor.clsoe() and connection.clsoe() method to close open connections after your work completes.

Now, let see the example. In this example, we are going to execute the get_laptop stored procedure using Python.

import mysql.connector
from mysql.connector import Error

try:
    connection = mysql.connector.connect(host='localhost',
                                         database='Electronics',
                                         user='pynative',
                                         password='pynative@#29')
    cursor = connection.cursor()
    cursor.callproc('get_laptop', [1, ])
    # print results
    print("Printing laptop details")
    for result in cursor.stored_results():
        print(result.fetchall())

except mysql.connector.Error as error:
    print("Failed to execute stored procedure: {}".format(error))
finally:
    if (connection.is_connected()):
        cursor.close()
        connection.close()
        print("MySQL connection is closed")Code language: Python (python)

You should get the following output.

Printing laptop details
[(1, 'Lenovo ThinkPad P71', 6459.0, datetime.date(2019, 8, 14))]
MySQL connection is closed

Note: Also, catch any SQL exceptions that may occur during this process.
Use the MySQL Connector module’s Error class, which shows us an error when we failed to execute a stored procedure. Example ER_ACCESS_DENIED_ERROR when username or password is wrong.

Cursor callproc() Method

Syntax

result_args = cursor.callproc(proc_name, args=())Code language: Python (python)

The callproc() method calls the stored procedure mentioned in the proc_name argument. The args sequence of parameters must contain one entry for each argument that the procedure expects. For example, the procedure can have one or many IN and OUT parameters.

The callproc() returns a modified copy of the input sequence. This method doesn’t change the input parameters. However, It can replace the output and input/output parameters with new values as per the execution result.

The stored procedure returns the output in result sets, and It is automatically fetched and stored as MySQLCursorBuffered instances.

For example, a stored procedure “addition” takes two parameters, adds the values, and returns the sum.

CREATE PROCEDURE add_num(IN num1 INT, IN num2 INT, OUT sum INT)
BEGIN
SET sum := num1 + num2;
END;Code language: Python (python)

The following example shows how to execute this Add procedure in Python.

args = (5, 6, 0) # 0 is to hold value of the OUT parameter sum
cursor.callproc('add_num', args)Code language: Python (python)

Next Steps:

To practice what you learned in this article, Please solve a Python Database Exercise project to Practice and master the Python Database operations.

Comments

Smart eagle says

January 12, 2023 at 5:37 pm

I think commit() should be inserted to complete update/save changes in the real database

like: connection.commit()

Reza says

December 10, 2022 at 7:11 pm

Hi. thank you for your useful article.
I have a question, What kind of connection is used here? Service-based or Connection-based only?

Edson Bravo says

October 6, 2022 at 5:39 pm

boa tarde pessoal como posso usar um procedimento armazenado usando uma entry do tekinter como iria ficar este codigo podem me ajudar?

Praj says

May 4, 2020 at 12:43 pm

Great content mate!
Quick question, how can i add triggers such as events?
I tried JDBC, did not work well so switched to Python in the last moment so I am confused with limited time to finish my assignment.
So i have a library database and i need to check expired memberships everyday and notify the members. How shall I?
Thanks

rajat says

August 7, 2019 at 5:35 pm

If i create 2 tables and want to compare them and the result will store in a new table.How will i do that?

- Vishal says
  
  August 10, 2019 at 4:52 pm
  
  Hi Rajat,
  
  You can write a SQL script for this
  or you can perform all the data comparison in Python for that you need to use data structure effectively
  
dave gardner says

July 16, 2019 at 6:42 am

Hi all, good article though can everyone please note that you will have to run the below:

mySQL_conn.commit()

Otherwise, the code will not execute on the server (or commit at least).

I lost more time on this than i would like to admit : )

- Bobcat says
  
  November 2, 2020 at 7:34 pm
  
  Thank you. Unbelievable.
  
Steven Hughes says

November 1, 2018 at 12:09 pm

Your example is incorrect.
Calling the procedure add results in ProgrammingError(1064)
Further your example ode still returns 5,6,0
What is the line 3,4,7 supposed to represent?
Please don’t post erroneous material like this..

- Vishal says
  
  November 1, 2018 at 3:11 pm
  
  Hey Steven. Thank you for comment.
  We apologizes if issue in this particular code. Give us sometime to check, we will definitely correct if required.
  
- Vishal says
  
  November 1, 2018 at 3:43 pm
  
  Hey Steven example is correct. Tuple entry was by mistake we removed it.
  We already mentioned steps and code in First example.
  In second example to called “add” stored procedure, here we just provided the snippet you should write it in correct code format by referring the above first example.
  
  Let me know if you still facing problems.
  
  - hank says
    
    August 2, 2019 at 10:46 am
    hi all,
    
    it seems that “add” is a reserved word. I changed the name to add_h and successfully created the procedure.
    
    Further to the explanation “The stored procedure returns output in result sets, and It is automatically fetched and stored as MySQLCursorBuffered instances.” Please try below…
    
    args = (5, 6, 0) result_args=cursor.callproc('add_h',args) print("###### procedure result : ",result_args[2])
    
    Hope this sheds some light on the question.
Mohammad Arshad says

September 26, 2018 at 3:07 pm

suppose i already created a stored procedure in phpmyadmin
my question is
how can i use or access implement in django framework
and how to get output

Python Execute MySQL Stored Procedure

Table of contents

Prerequisites

Steps to execute MySQL Stored Procedure in Python

Cursor callproc() Method

Next Steps:

About Vishal

Related Tutorial Topics:

All Coding Exercises:

Python Exercises and Quizzes

About PYnative

Follow Us

Explore Python

Coding Exercises

Legal Stuff

Table of contents

Prerequisites

Steps to execute MySQL Stored Procedure in Python

Cursor callproc() Method

Next Steps:

About Vishal

Related Tutorial Topics:

All Coding Exercises:

Python Exercises and Quizzes

Comments

Leave a Reply Cancel reply

About PYnative

Follow Us

Explore Python

Coding Exercises

Legal Stuff