Python sqlalchemy-searchable Module: Installation and Advanced Use Case Tutorials

Python Modules › Database Interaction
, , ,

Python sqlalchemy-searchable Module

The sqlalchemy-searchable module is an extension for SQLAlchemy that adds full-text search capabilities to your SQLAlchemy models. This powerful library allows developers to efficiently implement search functionality in applications using SQLAlchemy for ORM (Object Relational Mapping). Specifically, it is compatible with different databases and is designed to work with Python 3.6 and later versions seamlessly. The module leverages PostgreSQL’s or MySQL’s full-text search features to enhance the data querying process substantially.

Application Scenarios

The primary purpose of the sqlalchemy-searchable module is to add full-text search capabilities to applications that utilize SQLAlchemy as their ORM solution. This can be particularly beneficial in the following scenarios:

  1. E-commerce Platforms: Facilitating product searches with better relevancy and speed.
  2. Document Management Systems: Enabling users to search through large sets of documents efficiently.
  3. Content Management Systems (CMS): Allowing for quick retrieval of articles or posts based on user queries.

By integrating sqlalchemy-searchable, developers can empower their applications with enhanced searching capabilities that yield more accurate results compared to simple query matching.

Installation Instructions

The sqlalchemy-searchable module is not included in the Python standard library and needs to be installed separately. You can easily do this via pip:

1
pip install sqlalchemy-searchable  # Install the sqlalchemy-searchable module

Ensure that you also have SQLAlchemy installed in your environment. If not, you can install it with:

1
pip install SQLAlchemy  # Install SQLAlchemy if not already installed

Usage Examples

Below we will illustrate three different usage examples for sqlalchemy-searchable, showcasing how to implement it in various scenarios.

Example 1: Basic Search Implementation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
from sqlalchemy import create_engine  # Importing the SQLAlchemy's engine
from sqlalchemy.ext.declarative import declarative_base  # Base class for models
from sqlalchemy.orm import sessionmaker  # ORM session management
from sqlalchemy_searchable import make_searchable  # Importing searchable functionality
from sqlalchemy import Column, Integer, String  # Importing SQLAlchemy data types

# Setting up the database engine
engine = create_engine('sqlite:///test.db')  # Using SQLite for demonstration purposes

Base = declarative_base()  # Creating a base class for our models
make_searchable()  # Activating searchable functionality

# Defining a sample model with search capabilities
class Product(Base):
    __tablename__ = 'products'  # Table name in the database
    id = Column(Integer, primary_key=True)  # Product ID
    name = Column(String)  # Product Name
    description = Column(String)  # Product Description
    __ts_vector__ = Column('ts_vector', TSVectorType('name', 'description'))  # Full-text search vector

Base.metadata.create_all(engine)  # Creating the table in the database

# Creating a session to interact with the database
Session = sessionmaker(bind=engine)  # Binding the session to the engine
session = Session()  # Creating a new session

# Adding some products for demonstration
session.add(Product(name='Laptop', description='A powerful laptop for productivity.'))  # Product entry
session.add(Product(name='Phone', description='A smartphone with great features.'))  # Product entry
session.commit()  # Committing the entries

# Performing a search on products
search_term = 'laptop'  # The term to search for
results = session.query(Product).search(search_term).all()  # Searching in the database

# Displaying search results
for product in results:
    print(f'Found Product: {product.name} - {product.description}')  # Output found products

Example 2: Advanced Search with Ranking

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
from sqlalchemy import func  # Importing SQLAlchemy's functions for ranking

# Continuing from the previous example...

search_term = 'phone'  # Search term

# Performing a search with ranking
results = (session.query(Product)
           .filter(Product.__ts_vector__.match(search_term))
           .order_by(func.ts_rank(Product.__ts_vector__, func.plainto_tsquery(search_term)).desc())  # Ranking results
           .all())  # Executing the search query

# Displaying ranked search results
for product in results:
    print(f'Ranked Product: {product.name} - Rank Score: {product.rank}')  # Output ranked products

Example 3: Full-Text Search Integration in Web Applications

1
2
3
4
5
6
7
8
9
10
11
12
from flask import Flask, request, jsonify  # Importing Flask for web framework

app = Flask(__name__)  # Creating a new Flask application

@app.route('/search', methods=['GET'])  # Defining a search endpoint
def search():
    term = request.args.get('q')  # Getting the search term from query parameters
    results = session.query(Product).search(term).all()  # Searching products
    return jsonify([{'name': product.name, 'description': product.description} for product in results])  # Returning as JSON

if __name__ == '__main__':
    app.run(debug=True)  # Running the Flask application

The above examples illustrate how to integrate the sqlalchemy-searchable module in various Python applications, from basic usage to web applications. The key takeaway is how it enhances the search functionality effectively, thus improving user experience.

I highly recommend following my blog, the EVZS Blog, where you can easily find comprehensive tutorials for every Python standard library module. It’s a fantastic resource for both beginners and advanced users looking to deepen their understanding of Python. You will benefit from concise explanations, practical examples, and much more, making it a valuable addition to your learning path.

Software and library versions are constantly updated

If this document is no longer applicable or is incorrect, please leave a message or contact me for an update. Let's create a good learning atmosphere together. Thank you for your support! - Travis Tang