{py:mod}abx_plugin_sqlitefts_search.searchbackend

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`SqliteftsSearchBackend <abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`_escape_sqlite3 <abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3>`
  - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3
    :summary:
    ```
* - {py:obj}`_escape_sqlite3_value <abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_value>`
  - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_value
    :summary:
    ```
* - {py:obj}`_escape_sqlite3_identifier <abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_identifier>`
  - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_identifier
    :summary:
    ```
* - {py:obj}`_create_tables <abx_plugin_sqlitefts_search.searchbackend._create_tables>`
  - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._create_tables
    :summary:
    ```
* - {py:obj}`_handle_query_exception <abx_plugin_sqlitefts_search.searchbackend._handle_query_exception>`
  - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._handle_query_exception
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`SQLITEFTS_SEARCH_BACKEND <abx_plugin_sqlitefts_search.searchbackend.SQLITEFTS_SEARCH_BACKEND>`
  - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SQLITEFTS_SEARCH_BACKEND
    :summary:
    ```

API

:canonical: abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3
```

:canonical: abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_value

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_value
```

:canonical: abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_identifier

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._escape_sqlite3_identifier
```

:canonical: abx_plugin_sqlitefts_search.searchbackend._create_tables

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._create_tables
```

:canonical: abx_plugin_sqlitefts_search.searchbackend._handle_query_exception

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend._handle_query_exception
```

:canonical: abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend

Bases: {py:obj}`abx_spec_searchbackend.BaseSearchBackend`

````{py:attribute} name
:canonical: abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.name
:type: str
:value: >
   'sqlite'

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.name
```

````

````{py:attribute} docs_url
:canonical: abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.docs_url
:type: str
:value: >
   'https://www.sqlite.org/fts5.html'

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.docs_url
```

````

````{py:method} index(snapshot_id: str, texts: typing.List[str])
:canonical: abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.index
:staticmethod:

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.index
```

````

````{py:method} search(text: str) -> typing.List[str]
:canonical: abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.search
:staticmethod:

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.search
```

````

````{py:method} flush(snapshot_ids: typing.Iterable[str])
:canonical: abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.flush
:staticmethod:

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SqliteftsSearchBackend.flush
```

````

:canonical: abx_plugin_sqlitefts_search.searchbackend.SQLITEFTS_SEARCH_BACKEND
:value: >
   'SqliteftsSearchBackend(...)'

```{autodoc2-docstring} abx_plugin_sqlitefts_search.searchbackend.SQLITEFTS_SEARCH_BACKEND
```