feat: add auto_index option

Author: kvesteri

CHANGES.rst

@@ -4,6 +4,12 @@ Changelog
 Here you can see the full list of changes between each SQLAlchemy-Searchable release.
 
 
+1.4.1 (2021-06-15)
+^^^^^^^^^^^^^^^^^^
+
+- Added auto_index option
+
+
 1.4.0 (2021-06-13)
 ^^^^^^^^^^^^^^^^^^
 

sqlalchemy_searchable/__init__.py

@@ -9,7 +9,7 @@
 
 from .vectorizers import Vectorizer
 
-__version__ = '1.4.0'
+__version__ = '1.4.1'
 
 
 vectorizer = Vectorizer()
@@ -240,6 +240,7 @@ class SearchManager():
         'search_trigger_function_name': '{table}_{column}_update',
         'regconfig': 'pg_catalog.english',
         'weights': (),
+        'auto_index': True
     }
 
     def __init__(self, options={}):
@@ -293,7 +294,8 @@ def process_mapper(self, mapper, cls):
             if column in self.processed_columns:
                 continue
 
-            self.append_index(cls, column)
+            if self.option(column, 'auto_index'):
+                self.append_index(cls, column)
 
             self.processed_columns.append(column)
 

tests/__init__.py

@@ -55,7 +55,8 @@ def options(self):
         return {
             'remove_symbols': self.remove_symbols,
             'search_trigger_name': self.search_trigger_name,
-            'search_trigger_function_name': self.search_trigger_function_name
+            'search_trigger_function_name': self.search_trigger_function_name,
+            'auto_index': True
         }
 
     def create_tables(self):

tests/test_multiple_vectors_per_class.py

@@ -25,9 +25,9 @@ class TextItem(self.Base):
 
             content = sa.Column(sa.UnicodeText)
 
-            name_vector = sa.Column(TSVectorType('name'))
+            name_vector = sa.Column(TSVectorType('name', auto_index=True))
 
-            content_vector = sa.Column(TSVectorType('content'))
+            content_vector = sa.Column(TSVectorType('content', auto_index=True))
 
 
 class TestMultipleSearchVectorsSearchFunction(TestCase):
@@ -41,8 +41,8 @@ class TextMultiItem(self.Base):
 
             name = sa.Column(sa.Unicode(255))
             content = sa.Column(sa.UnicodeText)
-            name_vector = sa.Column(TSVectorType('name'))
-            content_vector = sa.Column(TSVectorType('content'))
+            name_vector = sa.Column(TSVectorType('name', auto_index=False))
+            content_vector = sa.Column(TSVectorType('content', auto_index=False))
 
         self.TextMultiItem = TextMultiItem
 
@@ -60,5 +60,7 @@ def test_choose_vector(self):
         query = self.TextItemQuery(self.TextMultiItem, self.session)
         s1 = search(query, 'ipsum', vector=self.TextMultiItem.name_vector)
         assert s1.first().name == 'ipsum'
-        s2 = search(query, 'ipsum', vector=self.TextMultiItem.content_vector)
-        assert s2.first().name == 'index'
+
+    def test_without_auto_index(self):
+        indexes = self.TextMultiItem.__table__.indexes
+        assert indexes == set()

tests/test_schema_creation.py

@@ -29,6 +29,6 @@ class TextItem(self.Base):
 
             name = sa.Column(sa.Unicode(255))
 
-            search_vector = sa.Column(TSVectorType())
+            search_vector = sa.Column(TSVectorType(auto_index=True))
 
             content = sa.Column(sa.UnicodeText)