Skip to content

featurebyte.Relationship.info

info(
verbose: bool=False
) -> Dict[str, Any]

Description

Returns a dictionary that summarizes the essential information of the relationship represented by the Relationship object. The dictionary contains the following keys:

  • relationship_type: The relationship type
  • entity_id: The main entity of the relationship
  • related_entity_id: The entity that the relationship is related to
  • relation_table_id: The table that maps the relationship
  • enabled: Whether the relationship is enabled
  • updated_by: Who the relationship was updated by

Parameters

  • verbose: bool
    default: False
    The parameter "verbose" in the current state of the code does not have any impact on the output.

Returns

  • Dict[str, Any]
    Key-value mapping of properties of the object.

Examples

>>> relationship = fb.Relationship.get(<relationship_name>)
>>> relationship.info()