IDatabaseTableRelationship¶
- class IDatabaseTableRelationship¶
Bases:
ImpactCOMWrapperBase- Description:
Describes a table relationship.
- Remarks:
All table relationship properties are read-only. Introduced in Impact 11.0.0.27.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property cascading_deletes¶
Gets cascading_deletes.
- Description:
Indicates whether cascading deletes are enabled for this relationship.
- Remarks:
When a record from the parent table is deleted, all associated records from the child table can be deleted automatically. This is know as a cascading delete.
- Returns:
The value of cascading_deletes.
- Return type:
cascading_deletes (bool)
- property child_column¶
Gets child_column.
- Description:
The column containing the key in the child table.
- Returns:
The value of child_column.
- Return type:
- property child_table¶
Gets child_table.
- Description:
The child table.
- Returns:
The value of child_table.
- Return type:
- property display_column¶
Gets display_column.
- Description:
Name of column used by advanced query lookup.
- Remarks:
If you configure an advanced query lookup with the same table and columns as a table relationship then the display_column can be retrieved.
- Returns:
The value of display_column.
- Return type:
display_column (str)
- property formatted_child¶
Gets formatted_child.
- Description:
Returns a name for the child part of the relationship, generated from the table and column names.
- Returns:
The value of formatted_child.
- Return type:
formatted_child (str)
- property formatted_name¶
Gets formatted_name.
- Description:
Returns a name for the relationship, generated from the table and column names.
- Remarks:
formatted_name is typically how the table relationships are displayed in the Impact interface and in error messages.
- Returns:
The value of formatted_name.
- Return type:
formatted_name (str)
- property formatted_parent¶
Gets formatted_parent.
- Description:
Returns a name for the parent part of the relationship, generated from the table and column names.
- Returns:
The value of formatted_parent.
- Return type:
formatted_parent (str)
- property internal_relationship¶
Gets internal_relationship.
- Description:
Indicates whether the relationship is defined within Impact, as opposed to user defined.
- Returns:
The value of internal_relationship.
- Return type:
internal_relationship (bool)
- property is_valid¶
Gets is_valid.
- Description:
Indicates whether the table relationship is valid.
- Remarks:
Introduced in Impact 12.0.0.187
- Returns:
The value of is_valid.
- Return type:
is_valid (bool)
- property key¶
Gets Key.
- Description:
Unique identifier for the table relationship.
- Remarks:
Key is the internal representation Impact uses to store table relationships.
- Returns:
The value of Key.
- Return type:
key (str)
- property parent_column¶
Gets parent_column.
- Description:
The column containing the key in the parent table.
- Returns:
The value of parent_column.
- Return type:
- property parent_table¶
Gets parent_table.
- Description:
The parent table.
- Returns:
The value of parent_table.
- Return type: