DEV Community

Harpreet Singh
Harpreet Singh

Posted on

SQLAlchemy Essentials

SQLAlchemy is a popular Python library that allows developers to interact with relational databases seamlessly. PyPI offically describes it as a "Python SQL toolkit and Object Relational Mapper that gives application developers the full power and flexibility of SQL". This blog post introduces you to the basics of SQLAlchemy, including installing the library, defining database tables, creating databases, and establishing relationships between tables.


Installing SQLAlchemy:

Before diving into SQLAlchemy's capabilities, let's start by installing the library. Open your terminal and use the following command to install:

pip install sqlalchemy
Enter fullscreen mode Exit fullscreen mode

Now that you have it installed, let's begin with defining tables.


Defining Tables:

Tables are the building blocks of any relational database. SQLAlchemy simplifies table creation by allowing you to define tables as Python classes. Here's an example:

from sqlalchemy import create_engine, Column, Integer, String
from sqlalchemy.orm import declarative_base

# Define a declarative base
Base = declarative_base()

# Define a table class
class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True)
    username = Column(String)
    email = Column(String)
Enter fullscreen mode Exit fullscreen mode

In this example, we've defined a User class that maps to a users table. The class attributes (id, username, and email) correspond to the table columns. The id column is set as the primary key.


Creating the Database:

Once you've defined your tables, it's time to create the actual database. This involves establishing a connection and using the create_all() method provided by the Base class:

from sqlalchemy import create_engine

# Create a database engine
engine = create_engine('sqlite:///db_name.db')

# Create the tables
Base.metadata.create_all(engine)
Enter fullscreen mode Exit fullscreen mode

The code above creates an SQLite database named db_name.db and generates the necessary tables based on your class definitions.
Note that the db_name should be whatever you want to name your database. Now you'd likely have more than one table.


Establishing Relationships:

Relational databases often involve relationships between tables. SQLAlchemy makes it easy to define these relationships within your class definitions. For instance, consider a scenario where you have a User table and an associated Post table. Here's how you could define a one-to-many relationship:

from sqlalchemy.orm import relationship

class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True)
    username = Column(String)
    email = Column(String)

    posts = relationship('Post', back_populates='author')

class Post(Base):
    __tablename__ = 'posts'

    id = Column(Integer, primary_key=True)
    title = Column(String)
    content = Column(String)
    author_id = Column(Integer, ForeignKey('users.id'))

    author = relationship('User', back_populates='posts')

Enter fullscreen mode Exit fullscreen mode

In this example, the User class has a one-to-many relationship with the Post class, with the posts attribute representing the relationship. The author attribute in the Post class establishes the reverse relationship. Note that while there are other ways to create the relationship, I prefer back_populates as it goes on both tables and improves readability.


Conclusion:

SQLAlchemy simplifies the process of working with databases in Python. This keeps the focus on python programming without switching back and forth with raw SQL. By installing the library, defining tables, creating databases, and establishing relationships, you can leverage its power to build sophisticated database-driven applications efficiently.

Top comments (0)