A flask extension that adds full text search capabilites to your SQLAlchemy models using the Whoosh search engine
Project description
Flask-SQLAlchemy-Whoosh
A simple and easy to use Flask extension to add full text search to your SQLAlchemy models using the Whoosh search engine.
Installing
$ pip install Flask-SQLAlchemy-Whoosh
Setup
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from Flask_SQLalchemy_Whoosh.searcher import WhooshSearcher
from Flask_SQLalchemy_Whoosh.mixin import SearchableMixin
app = Flask(__name__)
db = SQLAlchemy(app)
search = WhooshSearcher(app)
# If you want to use the SearchableMixin
SearchableMixin.init_search(search, db)
Documentation
You can find some documentation here
Example
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from Flask_SQLalchemy_Whoosh.searcher import WhooshSearcher
from Flask_SQLalchemy_Whoosh.mixin import SearchableMixin
from whoosh.fields import ID, TEXT, NUMERIC
app = Flask(__name__)
db = SQLAlchemy(app)
search = WhooshSearcher(app)
SearchableMixin.init_search(search, db)
class Product(SearchableMixin, db.Model):
__tablename__ = "product"
# __searchable__ is needed to tell the searcher what to index
# For documentation on the specifics of each field, refer to the Whoosh documentation
# https://whoosh.readthedocs.io/en/latest/schema.html
__searchable__ = {
"id": ID(stored=True, unique=True),
"name": TEXT(stored=True),
"desc": TEXT,
"price": NUMERIC
}
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String),
desc = db.Column(db.String),
price = db.Column(db.Integer)
# If you want to index a table that already has entries, use the reindex method
# It will index all entries in the table
Product.reindex()
# Use the search method to search a table
results, total = Product.search("name", "nails")
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for flask_sqlalchemy_whoosh-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7841e4080aa6f781bd45b513ab94d0926554ad80be53bd9a5a0f4668e2c9a1af |
|
MD5 | b83a52374b925da5993079a4b3ec61e5 |
|
BLAKE2b-256 | 904e07f84954b0bef067c0f3156d1d98f7d637253ee30a40c63262689a16daa5 |
Close
Hashes for flask_sqlalchemy_whoosh-0.1.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4aaac796c4d37bc968d828110184b8b2c30023da474c07621188d603ce726320 |
|
MD5 | 50a1cfdfdd130440b348a8365a1fba49 |
|
BLAKE2b-256 | 295acf6f71073aa2c3ad788f75bc4a79281baa6693681a1b39855d8b4be704fe |