Flask-SQLAlchemy setup

Introduction

Flask-SQLAlchemy helps you connect your Flask app to a database easily. It lets you work with databases using Python code instead of writing SQL queries.

You want to save user information like names and emails in a database.

You need to store and retrieve data for a blog or a small website.

You want to manage data without writing complex SQL commands.

You are building a Flask app that needs to remember data between visits.

Syntax

Flask

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///mydatabase.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
db = SQLAlchemy(app)

Set SQLALCHEMY_DATABASE_URI to tell Flask where your database is.

Creating SQLAlchemy(app) links the database to your Flask app.

Examples

This sets up a SQLite database file named site.db in your project folder.

Flask

app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///site.db'

This connects to a PostgreSQL database with username and password.

Flask

app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:password@localhost/mydb'

This creates the database object you use to define tables and interact with data.

Flask

db = SQLAlchemy(app)

Sample Program

This Flask app sets up a SQLite database named test.db. It defines a User table with an ID and username. It creates the table, adds one user named 'alice', saves it, and then prints the first user.

Flask

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db'
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False

db = SQLAlchemy(app)

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), unique=True, nullable=False)

    def __repr__(self):
        return f'<User {self.username}>'

with app.app_context():
    db.create_all()
    new_user = User(username='alice')
    db.session.add(new_user)
    db.session.commit()
    user = User.query.first()
    print(user)

Important Notes

Always set SQLALCHEMY_TRACK_MODIFICATIONS to False to avoid extra warnings.

Use app.app_context() when working with the database outside request handlers.

Remember to call db.create_all() once to create tables before adding data.

Summary

Flask-SQLAlchemy connects your Flask app to a database simply.

Configure the database URI and create a SQLAlchemy object linked to your app.

Define tables as Python classes and use the database session to add or query data.

Practice

1. What is the main purpose of Flask-SQLAlchemy in a Flask application?

easy

A. To create HTML templates for the Flask app

B. To connect the Flask app to a database and manage data easily

C. To handle user authentication and sessions

D. To serve static files like images and CSS

Solution

1. Step 1: Understand Flask-SQLAlchemy role

   Flask-SQLAlchemy is a tool that helps Flask apps talk to databases easily.

2. Step 2: Compare with other options

   Options B, C, and D relate to other Flask features, not database connection.

3. Final Answer:

   To connect the Flask app to a database and manage data easily -> Option B

4. Quick Check:

   Flask-SQLAlchemy = database connection [OK]

Hint: Flask-SQLAlchemy is about databases, not templates or files [OK]

Common Mistakes:

• Confusing Flask-SQLAlchemy with template engines
• Thinking it manages user sessions
• Assuming it serves static files

2. Which of the following is the correct way to initialize Flask-SQLAlchemy in your Flask app?

easy

A. db = SQLAlchemy(app)

B. db = SQLAlchemy()
db.init_app(appp)

C. db = SQLAlchemy(appp)

D. db = SQLAlchemy(app=Flask())

Solution

1. Step 1: Recall initialization pattern

   The simplest and most common way is to pass the app directly to SQLAlchemy constructor: db = SQLAlchemy(app).

2. Step 2: Check other options

   db = SQLAlchemy() db.init_app(appp) uses undefined 'appp'. db = SQLAlchemy(appp) uses undefined 'appp'. db = SQLAlchemy(app=Flask()) creates a new Flask app, not the existing one.

3. Final Answer:

   db = SQLAlchemy(app) -> Option A

4. Quick Check:

   Direct app in constructor = db = SQLAlchemy(app) [OK]

Hint: Pass your Flask app directly to SQLAlchemy() for quick setup [OK]

Common Mistakes:

• Trying to pass app as a keyword argument incorrectly
• Creating a new Flask app inside SQLAlchemy
• Forgetting to link SQLAlchemy to the app

3. Given this Flask-SQLAlchemy model and code, what will print(user.name) output?

from flask_sqlalchemy import SQLAlchemy
from flask import Flask

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///:memory:'
db = SQLAlchemy(app)

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(50))

with app.app_context():
    db.create_all()
    user = User(name='Alice')
    db.session.add(user)
    db.session.commit()

print(user.name)

medium

A. Empty string

B. None

C. Alice

D. Error: No such attribute

Solution

1. Step 1: Understand model and data insertion

   The User model has a name field. We create a user with name 'Alice' and add it to the database.

2. Step 2: Check what user.name holds after commit

   After committing, the user object still has the name 'Alice' stored in its attribute.

3. Final Answer:

   Alice -> Option C

4. Quick Check:

   User.name after commit = 'Alice' [OK]

Hint: Committed model instances keep their attribute values accessible [OK]

Common Mistakes:

• Assuming user.name becomes None after commit
• Thinking print causes a database query error
• Confusing model attribute with database column name

4. What is wrong with this Flask-SQLAlchemy setup code?

from flask_sqlalchemy import SQLAlchemy
from flask import Flask

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db'
db = SQLAlchemy()
db.init_app(app)

class Product(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(80))

product = Product(name='Book')
db.session.add(product)
db.session.commit()

medium

A. Missing app.app_context() when adding and committing

B. SQLALCHEMY_DATABASE_URI is incorrect

C. Product model lacks a __tablename__ attribute

D. db = SQLAlchemy() should be db = SQLAlchemy(app)

Solution

1. Step 1: Check app context usage

   When using db.init_app(app), database operations must be inside app.app_context() to access app config.

2. Step 2: Verify other parts

   The URI is valid, __tablename__ is optional, and db = SQLAlchemy() with init_app is valid. The missing app context causes runtime error.

3. Final Answer:

   Missing app.app_context() when adding and committing -> Option A

4. Quick Check:

   Database ops need app context [OK]

Hint: Wrap DB actions in app.app_context() if using init_app() [OK]

Common Mistakes:

• Ignoring app context requirement with init_app()
• Thinking __tablename__ is always required
• Confusing init_app() with passing app in constructor

5. You want to create a Flask app with Flask-SQLAlchemy that uses PostgreSQL. Which steps correctly set up the database URI and initialize the app and database? Choose the correct sequence.

hard

A. Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(appp)

B. Set app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db'; then db = SQLAlchemy(app)

C. Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(); no init_app call

D. Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(); db.init_app(app)

Solution

1. Step 1: Set correct PostgreSQL URI

   The URI must start with 'postgresql://' and include user, password, host, and database name.

2. Step 2: Initialize SQLAlchemy properly

   Using db = SQLAlchemy() then db.init_app(app) is a flexible pattern, especially for larger apps.

3. Step 3: Check other options

   Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(appp) uses undefined 'appp'; Set app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db'; then db = SQLAlchemy(app) uses SQLite, not PostgreSQL; Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(); no init_app call misses init_app call, so db won't link to app.

4. Final Answer:

   Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(); db.init_app(app) -> Option D

5. Quick Check:

   PostgreSQL URI + init_app() = Set app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://user:pass@localhost/dbname'; then db = SQLAlchemy(); db.init_app(app) [OK]

Hint: Use init_app() with PostgreSQL URI for flexible setup [OK]

Common Mistakes:

• Using SQLite URI when PostgreSQL is needed
• Forgetting to call init_app() after creating db without app
• Passing app to SQLAlchemy but using wrong URI format