Support Drupal's Entity Reference field type concept on external data source.

Created on 4 April 2019, almost 6 years ago
Updated 3 February 2025, 2 days ago

Hi I'd like a feature whereby there is support to reference another entity from an entity's field, just like ordinary/traditional Drupal (using local MySQL database) does.

This would take the form of 2 operations:

1) Initial setup of the Entity Reference: On creating a field in an entity which is an Entity Reference, in the standard Drupal Content editor, calls are made to the external data source to create a relationship between the data for the entities. This operation should cover both creation of the Entity reference field and deletion, for when the field is deleted from the entity.

2) Accessing data (read/write) from the field in the entity. Because the field references another entity, a call must be made to the external data source.

As a concrete/real-life example, this could be a REST call to a Node JS-based external API microservice, which is the interface to an external, non-Drupal Postgres database. The implementation of the relationship creation could be a series of SQL commands, e.g. to setup a foreign key between the entities. Then for access to the field, another API call would be used and the API would support it, implementing it as a series of SQL commands to access the other entity.

The implementation of the REST call on the API side is bespoke and would be implemented per project.

However the interface/protocol/API call structure definition that Drupal makes, via this module (External Entities) (probably as an extension plug-in) is standardised.

The API side has to support this standard interface for this functionality to work - so that it can respond to the call from Drupal. But how it implements it is up to the developer and is a separate activity from the Drupal side.

What this all means is that not only is the data decoupled from Drupal and/or allowing interoperation with other data sources, it also means that the relationships between that external data are modelled within that data source itself. So there is not a dependency on Drupal to manage the relationships. However, Drupal provides the benefit of the generic standardised interface to model those relationships via entity editors such as the Content Type editor.

Feature request
Status

Active

Version

2.0

Component

Code

Created by

🇬🇧United Kingdom therobyouknow

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇨🇦Canada colan Toronto 🇨🇦

    This sounds overly complicated. What about simply having a config tab for the entity that allows you do choose which fields are entity references? By default, it could translate the remote ID value into the Drupal entity ID, and use that to make the reference?

    For more complicated values in the reference field, it could allow for hook implementations that provide a translation in code.

  • 🇨🇦Canada colan Toronto 🇨🇦
  • 🇫🇷France guignonv

    I didn't read everything in details (not enough time to be honest) but I leave this post as a note for people who might want to do something for that issue.

    There is something that has not been implemented yet in the external entity API for entity queries: in StorageClientBase::testDrupalConditions(), there is currently no (or limited) support for complex filtering on fields using syntax with sub-fields (like it is the case here with entity references) or with '%delta' (eg. ->condition('tags.%delta.value', 'news'))). That might be the reason why it does not behave like other Drupal entities with references.

Production build 0.71.5 2024