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", 1)
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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d78981c3dceeae5e381a3d32830f40c96bdaddbb8e3bc18555a44dc01ba8cd61 |
|
MD5 | 5cd1780acd2377bb867d346c8b63ff02 |
|
BLAKE2b-256 | 639360f4848dc9aba63d3799c02744031c3bba8c5b73b17e28a25ab0a217d792 |
Close
Hashes for flask_sqlalchemy_whoosh-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fc8bd927eb5dcad32ab4a981fb68d231fa30743a6a095754387cd1d85541ee6 |
|
MD5 | 9ea3ebc75ff6b36d6d52c9037427770f |
|
BLAKE2b-256 | d84eb9480e728289837bb1fd98b30bceb8063bac5113814233a3d5023850be48 |