Flask-SQLAlchemy setup - Step-by-Step Execution

Concept Flow - Flask-SQLAlchemy setup

Import Flask and SQLAlchemy

↓

Create Flask app instance

↓

Configure app with DB URI

↓

Create SQLAlchemy object with app

↓

Define database models

↓

Use models to create tables and query

↓

Run app

This flow shows how to set up Flask with SQLAlchemy: import, create app, configure DB, initialize SQLAlchemy, define models, then use them.

Execution Sample

Flask

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

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

This code creates a Flask app, sets the database URI, and initializes SQLAlchemy with the app.

Execution Table

Step	Action	Evaluation	Result
1	Import Flask and SQLAlchemy	Modules imported	Flask and SQLAlchemy ready to use
2	Create Flask app instance	app = Flask(__name__)	app object created
3	Set app config for DB URI	app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db'	App configured to use SQLite DB
4	Initialize SQLAlchemy with app	db = SQLAlchemy(app)	db object linked to app
5	Define model class (not shown here)	class User(db.Model): ...	Model ready for DB operations
6	Use db.create_all() to create tables	db.create_all()	Tables created in DB
7	Run app	app.run()	Flask app running with DB support
8	Exit	App stopped or interrupted	Execution ends

💡 App stops or is interrupted, ending execution

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
app	None	Flask app instance	Configured with DB URI	Same app instance	Same app instance
db	None	None	None	SQLAlchemy instance linked to app	Same db instance

Key Moments - 3 Insights

Why do we set 'SQLALCHEMY_DATABASE_URI' in app.config?

This tells Flask-SQLAlchemy where the database is. Without it, SQLAlchemy won't know which database to connect to. See execution_table step 3.

What does 'db = SQLAlchemy(app)' do?

It creates a SQLAlchemy object linked to the Flask app, enabling database operations through 'db'. See execution_table step 4.

When do the database tables get created?

Tables are created when you call 'db.create_all()' after defining your models. This is shown in execution_table step 6.

Visual Quiz - 3 Questions

Look at the execution table, what is the state of 'app' after step 3?

A SQLAlchemy instance

B None

C Flask app instance configured with DB URI

D Database tables created

💡 Hint

Check variable_tracker column 'After Step 3' for 'app'

At which step is the SQLAlchemy object linked to the Flask app?

A Step 2

B Step 4

C Step 3

D Step 6

💡 Hint

Look at execution_table step descriptions for 'db = SQLAlchemy(app)'

If we skip setting 'SQLALCHEMY_DATABASE_URI', what will happen?

A SQLAlchemy will raise an error when used

B SQLAlchemy will use a default in-memory database

C App will run without database support

D Tables will be created automatically

💡 Hint

Refer to key_moments about the importance of setting the DB URI

Concept Snapshot

Flask-SQLAlchemy setup:
1. Import Flask and SQLAlchemy
2. Create Flask app instance
3. Set 'SQLALCHEMY_DATABASE_URI' in app.config
4. Initialize SQLAlchemy with app: db = SQLAlchemy(app)
5. Define models inheriting db.Model
6. Create tables with db.create_all()
7. Use models to query and update DB

Full Transcript

To set up Flask with SQLAlchemy, first import the needed modules. Then create a Flask app instance. Next, configure the app with the database URI, which tells SQLAlchemy where the database is. After that, initialize SQLAlchemy by passing the app to it. Define your database models as classes inheriting from db.Model. Use db.create_all() to create the tables in the database. Finally, run the Flask app. This setup allows your Flask app to interact with the database easily.

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