This addon provides the bases to implement addons to export information to Typesense indexes.
auto_awesome What this module does
AI-generated from the code · Odoo 18.0Adds Typesense as a search engine backend in Odoo, so users can configure a Typesense server and export indexed data to it.
This module extends the search engine connector framework so that Typesense can be used as the search engine behind Odoo's indexing features.
- On the search engine backend form (model
se.backend), a new "Typesense" option appears in the Type field. When selected, extra fields are shown: Host, Port, Protocol, Typesense API Key and Typesense server timeout. Host, Port, Protocol and API Key are required when the type is Typesense. - These connection fields are only visible to users in the connector search engine manager group.
- The module provides the technical adapter that talks to Typesense: it can test the connection (reporting clear errors for wrong API key, missing host, or unreachable server), create or update the index (collection) from the index configuration, add new fields to an existing index, export records to Typesense, delete records from the index, clear the index, and read documents back page by page.
- Reindexing is intentionally not supported: because Typesense schemas can be updated, users just need to export the settings after changing them.
- It depends on the
connector_search_enginemodule and requires the Pythontypesenseandrequestslibraries.
Depends on
Required by other modules
Models and fields (1)
- se.backend · extends an existing modelts_api_key, backend_type (Type), ts_server_host (Typesense host), ts_server_port (Typesense port), ts_server_timeout (Typesense server timeout), ts_server_protocol (Typesense protocol)
Text generated by AI (DeepSeek) from reading the Odoo 18.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub
Availability by version
Reviewed: 2026-11-03Confirmation status: 2 confirmed, 7 with no information of 9 versions.
Sources · Odoo 18.0
Confirmed on 2026-11-03 in branch 18.0 of OCA/search-engine.
terminal Installation and usage
OCA documentation · Odoo 18.0Installation
Source · Odoo 18.0This package requires a typesense search engine running. Please read this for a quick docker based setup.
Configuration
Source · Odoo 18.0You have to configure (Host, Port, Protocol, Typesense API Key) in a new backend form view:
Search Engine \> Configuration \> Backends
Usage
Source · Odoo 18.0We recommend to use the typesense-dashboard for managing your typesense server. I will allow you to configure the mapping of index with a nice UI. Please take a look here:
Installation instructions, the distribution package, dependencies and configuration steps are not shown because they have not yet been verified in the module documentation for any version.
Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.