sqlalchemy-searchable 2.0.0__tar.gz

sqlalchemy_searchable-2.0.0/.gitignore

@@ -0,0 +1,36 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+docs/_build
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject

sqlalchemy_searchable-2.0.0/CHANGES.rst

@@ -0,0 +1,345 @@
+Changelog
+---------
+
+Here you can see the full list of changes between each SQLAlchemy-Searchable release.
+
+2.0.0 (2023-08-28)
+^^^^^^^^^^^^^^^^^^
+
+- **BREAKING CHANGE**: Drop support for Python 3.6 and 3.7.
+- **BREAKING CHANGE**: Drop support for SQLAlchemy 1.3.
+- **BREAKING CHANGE**: Remove ``quote_identifier`` function.
+- **BREAKING CHANGE**: Remove ``SearchManager.search_function_ddl`` method. Use
+  ``CreateSearchFunctionSQL(column)`` instead.
+- **BREAKING CHANGE**: Remove ``SearchManager.search_trigger_ddl`` method. Use
+  ``CreateSearchTriggerSQL(column)`` instead.
+- Migrate from Travis CI to Github workflows in order to have a working CI
+  again.
+- Remove ``validators`` dependency
+- Add support for Python 3.10 and 3.11.
+- Use the ``pyproject.toml`` standard to specify project metadata, dependencies
+  and tool configuration. Use Hatch to build the project.
+- Use Ruff for linting the project, replacing both isort and flake8.
+- Upgrade Python syntax with pyupgrade to the minimum Python version supported.
+- Use Black to format Python code.
+- Add support for SQLAlchemy 2.0.
+- Use SQLAlchemy's compilation extension to build the SQL for creating and
+  dropping the search functions and triggers.
+- Update SQLAlchemy-Utils dependency to >=0.40.0.
+- Fix the deprecation warning for ``sqlalchemy.orm.mapper()`` in
+  ``make_searchable()`` and ``remove_listeners()``.
+- Migrate the Read the Docs configuration to use `.readthedocs.yaml`
+  configuration file.
+- Rewrite the test suite to use pytest fixtures ove classic xunit-style set-up.
+- Fix ``parse_websearch`` tests on PostgreSQL 14 and later.
+- Add PostgreSQL versions 11, 13, 14 and 15 to the CI build matrix. Previously,
+  the tests were only run on PostgreSQL 12.
+- Rewrite the documentation to be up-to-date with the codebase, to fix the
+  grammar and formatting issues, and to ensure the code examples are correct.
+- The query interface is considered legacy in SQLAlchemy 2.0. Migrate the tests
+  and documentation to use ``Session.execute()`` in conjunction with ``select()`` to
+  run ORM queries.
+
+1.4.1 (2021-06-15)
+^^^^^^^^^^^^^^^^^^
+
+- Added auto_index option
+
+
+1.4.0 (2021-06-13)
+^^^^^^^^^^^^^^^^^^
+
+- Simplify search parsing
+- Fix parser errors with search keywords containing special characters such as underscores
+
+
+1.3.0 (2021-06-02)
+^^^^^^^^^^^^^^^^^^
+
+- Raise PostgreSQL requirement to version 11
+- Use websearch_to_tsquery internally rather than own parsing functions
+- Drop py34, py35 support
+
+
+1.2.0 (2020-07-10)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed 'or' keyword parsing (#93)
+- Dropped py27 support
+
+
+1.1.0 (2019-07-05)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed some issues with query parsing
+- Fixed 'or' keyword parsing (#85)
+- Dropped py33 support
+- Fixed deprecation warnings (#81, pull request courtesy of Le-Stagiaire)
+
+
+1.0.3 (2018-02-22)
+^^^^^^^^^^^^^^^^^^
+
+- Add missing expressions.sql
+
+
+1.0.2 (2018-02-22)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed import issue with expressions.sql
+
+
+1.0.1 (2018-02-20)
+^^^^^^^^^^^^^^^^^^
+
+- Made all parser functions immutable
+
+
+1.0 (2018-02-20)
+^^^^^^^^^^^^^^^^
+
+- Added pure PostgreSQL search query parsing (faster and can be used on SQL level)
+- PostgreSQL >= 9.6 required
+- Added support for phrase searching
+- Removed python search query parsing
+- Removed pyparsing from requirements
+- Removed symbol removal (now handled implicitly on PostgreSQL side)
+
+
+0.10.6 (2017-10-12)
+^^^^^^^^^^^^^^^^^^^
+
+- Fixed Flask-SQLAlchemy support (#63, pull request by quantus)
+
+
+0.10.5 (2017-07-25)
+^^^^^^^^^^^^^^^^^^^
+
+- Added drop_trigger utility function (#58, pull request by ilya-chistyakov)
+
+
+0.10.4 (2017-06-28)
+^^^^^^^^^^^^^^^^^^^
+
+- Index generation no longer manipulates table args (#55, pull request by jmuhlich)
+
+
+0.10.3 (2017-01-26)
+^^^^^^^^^^^^^^^^^^^
+
+- Fixed 'Lo' unicode letter parsing (#50, pull request courtesy by StdCarrot)
+
+
+0.10.2 (2016-09-02)
+^^^^^^^^^^^^^^^^^^^
+
+- Fixed vector matching to use global configuration regconfig as fallback
+
+
+0.10.1 (2016-04-14)
+^^^^^^^^^^^^^^^^^^^
+
+- Use identifier quoting for reserved keywords (#45, pull request by cristen)
+
+
+0.10.0 (2016-03-31)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed unicode parsing in search query parser, #42
+- Removed Python 2.6 support
+
+
+0.9.3 (2015-05-31)
+^^^^^^^^^^^^^^^^^^
+
+- Added support for search term weights
+
+
+0.9.2 (2015-04-01)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed listener configuration (#31)
+
+
+0.9.1 (2015-03-25)
+^^^^^^^^^^^^^^^^^^
+
+- Added sort param to search function for ordering search results by relevance
+
+
+0.9.0 (2015-03-19)
+^^^^^^^^^^^^^^^^^^
+
+- Added PyPy support
+- Added isort and flake8 checks
+- Added support for custom vectorizers in sync_trigger, #25
+- Fixed and / or parsing where search word started with keyword, #22
+- Removed 'and' as keyword from search query parser (spaces are always considered as 'and' keywords)
+
+
+0.8.0 (2015-01-03)
+^^^^^^^^^^^^^^^^^^
+
+- Made search function support for queries without entity_zero
+- Changed catalog configuration option name to regconfig to be compatible with the PostgreSQL and SQLAlchemy naming
+- Added custom type and column vectorizers
+- SQLAlchemy requirement updated to 0.9.0
+- SQLAlchemy-Utils requirement updated to 0.29.0
+
+
+0.7.1 (2014-12-16)
+^^^^^^^^^^^^^^^^^^
+
+- Changed GIN indexes to table args Index constructs. This means current version of alembic should be able to create these indexes automatically.
+- Changed GIN index naming to adhere to SQLAlchemy index naming conventions
+
+
+0.7.0 (2014-11-17)
+^^^^^^^^^^^^^^^^^^
+
+- Replaced remove_hyphens configuration option by more generic remove_symbols configuration option
+- Emails are no longer considered as special tokens by default.
+
+
+0.6.0 (2014-09-21)
+^^^^^^^^^^^^^^^^^^
+
+- Added sync_trigger alembic helper function
+
+
+0.5.0 (2014-03-19)
+^^^^^^^^^^^^^^^^^^
+
+- Python 3 support
+- Enhanced email token handling
+- New configuration option: remove_hyphens
+
+
+0.4.5 (2013-10-22)
+^^^^^^^^^^^^^^^^^^
+
+- Updated validators dependency to 0.2.0
+
+
+0.4.4 (2013-10-17)
+^^^^^^^^^^^^^^^^^^
+
+- Search query string parser now notices emails and leaves them as they are (same behavious as in PostgreSQL tsvector parser)
+
+
+0.4.3 (2013-10-07)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed index/trigger creation when multiple vectors attached to single class
+- Search vector without columns do not generate triggers anymore
+
+
+0.4.2 (2013-10-07)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed single table inheritance handling in define_triggers_and_indexes manager method.
+
+
+0.4.1 (2013-10-04)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed negation operator parsing
+
+
+0.4.0 (2013-10-04)
+^^^^^^^^^^^^^^^^^^
+
+- Completely rewritten search API
+- Renamed SearchQueryMixin.search and main module search function's 'language' parameter to 'catalog'
+- Support for multiple search vectors per class
+
+
+0.3.3 (2013-10-03)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed support for numbers in parse_search_query
+
+
+0.3.2 (2013-10-03)
+^^^^^^^^^^^^^^^^^^
+
+- Added support for hyphens between words
+
+
+0.3.1 (2013-10-02)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed parse_search_query to support nested parenthesis and negation operator
+
+
+0.3.0 (2013-10-01)
+^^^^^^^^^^^^^^^^^^
+
+- Added better search query parsing capabilities (support for nested parenthesis, or operator and negation operator)
+
+
+0.2.1 (2013-08-01)
+^^^^^^^^^^^^^^^^^^
+
+- Made psycopg dependency more permissive
+
+
+0.2.0 (2013-08-01)
+^^^^^^^^^^^^^^^^^^
+
+- Added dependency to SQLAlchemy-Utils
+- Search vectors must be added manually to each class
+
+
+0.1.8 (2013-07-30)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed safe_search_terms single quote handling
+
+
+0.1.7 (2013-05-22)
+^^^^^^^^^^^^^^^^^^
+
+- Language set explicitly on each query condition
+
+
+0.1.6 (2013-04-17)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed search function when using session based queries
+
+
+0.1.5 (2013-04-03)
+^^^^^^^^^^^^^^^^^^
+
+- Added table name identifier quoting
+
+
+0.1.4 (2013-01-30)
+^^^^^^^^^^^^^^^^^^
+
+- Fixed search_filter func when using empty or undefined search options
+
+
+0.1.3 (2013-01-30)
+^^^^^^^^^^^^^^^^^^
+
+- Added support for custom language parameter in query search functions
+
+
+0.1.2 (2013-01-30)
+^^^^^^^^^^^^^^^^^^
+
+- Added psycopg2 to requirements, fixed travis.yml
+
+
+0.1.1 (2013-01-12)
+^^^^^^^^^^^^^^^^^^
+
+- safe_search_terms support for other than english catalogs
+
+
+0.1.0 (2013-01-12)
+^^^^^^^^^^^^^^^^^^
+
+- Initial public release

sqlalchemy_searchable-2.0.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2012, Konsta Vesterinen
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* The names of the contributors may not be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sqlalchemy_searchable-2.0.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: sqlalchemy-searchable
+Version: 2.0.0
+Summary: Provides fulltext search capabilities for declarative SQLAlchemy models.
+Project-URL: Code, https://github.com/kvesteri/sqlalchemy-searchable
+Project-URL: Documentation, https://sqlalchemy-searchable.readthedocs.io/
+Project-URL: Issue Tracker, http://github.com/kvesteri/sqlalchemy-searchable/issues
+Author-email: Konsta Vesterinen <konsta@fastmonkeys.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Requires-Dist: sqlalchemy-utils>=0.40.0
+Requires-Dist: sqlalchemy>=1.4
+Description-Content-Type: text/x-rst
+
+SQLAlchemy-Searchable
+=====================
+
+|Version Status| |Downloads|
+
+Fulltext searchable models for SQLAlchemy. Only supports PostgreSQL
+
+
+Resources
+---------
+
+- `Documentation <https://sqlalchemy-searchable.readthedocs.io/>`_
+- `Issue Tracker <http://github.com/kvesteri/sqlalchemy-searchable/issues>`_
+- `Code <http://github.com/kvesteri/sqlalchemy-searchable/>`_
+
+
+.. |Version Status| image:: https://img.shields.io/pypi/v/SQLAlchemy-Searchable.svg
+   :target: https://pypi.python.org/pypi/SQLAlchemy-Searchable/
+.. |Downloads| image:: https://img.shields.io/pypi/dm/SQLAlchemy-Searchable.svg
+   :target: https://pypi.python.org/pypi/SQLAlchemy-Searchable/

sqlalchemy_searchable-2.0.0/README.rst

@@ -0,0 +1,20 @@
+SQLAlchemy-Searchable
+=====================
+
+|Version Status| |Downloads|
+
+Fulltext searchable models for SQLAlchemy. Only supports PostgreSQL
+
+
+Resources
+---------
+
+- `Documentation <https://sqlalchemy-searchable.readthedocs.io/>`_
+- `Issue Tracker <http://github.com/kvesteri/sqlalchemy-searchable/issues>`_
+- `Code <http://github.com/kvesteri/sqlalchemy-searchable/>`_
+
+
+.. |Version Status| image:: https://img.shields.io/pypi/v/SQLAlchemy-Searchable.svg
+   :target: https://pypi.python.org/pypi/SQLAlchemy-Searchable/
+.. |Downloads| image:: https://img.shields.io/pypi/dm/SQLAlchemy-Searchable.svg
+   :target: https://pypi.python.org/pypi/SQLAlchemy-Searchable/

sqlalchemy_searchable-2.0.0/docs/Makefile

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SQLAlchemy-Searchable.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SQLAlchemy-Searchable.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/SQLAlchemy-Searchable"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SQLAlchemy-Searchable"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

sqlalchemy_searchable-2.0.0/docs/alembic_migrations.rst

@@ -0,0 +1,12 @@
+Alembic migrations
+------------------
+
+.. currentmodule:: sqlalchemy_searchable
+
+When making changes to your database schema, you have to ensure the associated
+search triggers and trigger functions get updated also. SQLAlchemy-Searchable
+offers two helper functions for this: :func:`sync_trigger` and
+:func:`drop_trigger`.
+
+.. autofunction:: sync_trigger
+.. autofunction:: drop_trigger