Part of the Search ecosystem · 125 projects
This module allows you to use a specific field on a content entity as the unique identifier for tracking items in a search index. This is useful when you need to synchronize with external systems that use custom identifiers instead of Drupal's internal entity IDs.
This module provides a Search API datasource that allows you to key your tracking IDs by a field on a content entity.
Some use cases include
- Limited ability to query the indexing backend and the indexing key needs to match the remote key.
- Custom keying where remote keying needs to match a remote source. For example, an enterprise identifier.
Features
Here, answer the following questions: What is the basic functionality? What unique features does enabling this project add? When and why would someone use this module? What use cases are there?
Post-Installation
Create a search index as you normally would and choose one of the "Field keyed" entity sources. Then set the field key value and the tracking keys will use the value of the field instead of the entity id.
Additional Requirements
PHP 8.3 and Search API
Ask your assistant about Search API Field Datasource
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
No dependencies recorded for this project.
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
More in the Search ecosystem
Most installed first
Activity
Release Timeline
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 1.0.0-beta2 | Pre-release | 10–11 | Jul 22, 2025 | ||
| 1.0.0-beta1 | Pre-release | 10–11 | Jul 1, 2025 | ||
| 1.0.x-dev | Dev | 10–11 | Apr 23, 2025 |