https://github.com/alexferl/flask-mysqldb

MySQL extension for the Flask web framework
https://github.com/alexferl/flask-mysqldb

flask flask-extension flask-mysqldb mysqldb

Last synced: 2 days ago
JSON representation

MySQL extension for the Flask web framework

• Host: GitHub
• URL: https://github.com/alexferl/flask-mysqldb
• Owner: alexferl
• License: mit
• Created: 2015-02-15T02:16:52.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-26T00:04:05.000Z (about 2 months ago)
• Last Synced: 2024-12-03T09:14:01.288Z (20 days ago)
• Topics: flask, flask-extension, flask-mysqldb, mysqldb
• Language: Python
• Homepage:
• Size: 106 KB
• Stars: 122
• Watchers: 3
• Forks: 59
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flask-MySQLdb

Flask-MySQLdb provides MySQL connection for Flask.

## Quickstart

First, you _may_ need to install some dependencies for [mysqlclient](https://github.com/PyMySQL/mysqlclient)

if you don't already have them, see [here](https://github.com/PyMySQL/mysqlclient#install).

Second, install Flask-MySQLdb:

```shell

pip install flask-mysqldb

```

Flask-MySQLdb depends, and will install for you, recent versions of Flask

(2.2.5 or later) and [mysqlclient](https://github.com/PyMySQL/mysqlclient).

Flask-MySQLdb is compatible with and tested with Python 3.8+.

Next, add a `MySQL` instance to your code:

```python

from flask import Flask

from flask_mysqldb import MySQL

app = Flask(__name__)

# Required

app.config["MYSQL_USER"] = "user"

app.config["MYSQL_PASSWORD"] = "password"

app.config["MYSQL_DB"] = "database"

# Extra configs, optional:

app.config["MYSQL_CURSORCLASS"] = "DictCursor"

app.config["MYSQL_CUSTOM_OPTIONS"] = {"ssl": {"ca": "/path/to/ca-file"}}  # https://mysqlclient.readthedocs.io/user_guide.html#functions-and-attributes

mysql = MySQL(app)

@app.route("/")

def users():

    cur = mysql.connection.cursor()

    cur.execute("""SELECT user, host FROM mysql.user""")

    rv = cur.fetchall()

    return str(rv)

if __name__ == "__main__":

    app.run(debug=True)

```

Other configuration directives can be found [here](https://github.com/alexferl/flask-mysqldb/blob/master/flask_mysqldb/__init__.py#L31).

## Why

Why would you want to use this extension versus just using MySQLdb by itself?

The only reason is that the extension was made using Flask's best practices in relation

to resources that need caching on the [app context](https://flask.palletsprojects.com/en/2.0.x/appcontext/).

What that means is that the extension will manage creating and teardown the connection to MySQL

for you while with if you were just using MySQLdb you would have to do it yourself.

## Resources

- [PyPI](https://pypi.org/project/Flask-MySQLdb/)