IDatabaseTable¶
- class IDatabaseTable¶
Bases:
ImpactCOMWrapperBase- Summary:
Represents a table description in the database.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property active_date¶
Gets active_date.
- Summary:
Returns the column storing the archive date.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of active_date.
- Return type:
- property active_flag¶
Gets active_flag.
- Summary:
Returns the column storing the archive status.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of active_flag.
- Return type:
- property active_mode¶
Gets active_mode.
- Summary:
Indicates whether the active_flag column represents active or archive
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of active_mode.
- Return type:
- property active_time¶
Gets active_time.
- Summary:
Returns the column storing the archive time.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of active_time.
- Return type:
- property active_user¶
Gets active_user.
- Summary:
Returns the column storing the archive user.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of active_user.
- Return type:
- property active_utc¶
Gets active_utc.
- Summary:
Indicates whether the archive date/time are stored as UTC.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of active_utc.
- Return type:
active_utc (bool)
- property columns¶
Gets Columns.
- Summary:
An IDatabaseColumns collection containing descriptions of the columns contained in this table.
- Returns:
The value of Columns.
- Return type:
- property guid_column¶
Gets guid_column.
- Summary:
Returns the column configured to store the GUID
- Remarks:
If the table has a GUID column configured and the column exists then the matching IDatabaseColumn is returned. If the IDatabaseTable.type doesn’t support user configured GUID columns then a NULL column is returned (currently only custom and remote tables support user configured GUID columns). This property will NOT return internally defined GUID columns for internal tables as they are hard coded known columns. This property can only be used to determine user configured GUID columns. Introduced in Impact 11.0.0.109
- Returns:
The value of guid_column.
- Return type:
Gets Hidden.
- Summary:
Indicates whether the table is Hidden.
- Returns:
The value of Hidden.
- Return type:
hidden (bool)
- property layer_type¶
Gets layer_type.
- Summary:
The table extra layer type.
- Remarks:
This property is only valid when the Type of the table is dttLayerExtra.
- Returns:
The value of layer_type.
- Return type:
layer_type (str)
- property modification_date¶
Gets modification_date.
- Summary:
Returns the column storing the modification date.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of modification_date.
- Return type:
- property modification_time¶
Gets modification_time.
- Summary:
Returns the column storing the modification time.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of modification_time.
- Return type:
- property modification_user¶
Gets modification_user.
- Summary:
Returns the column storing the modification user.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of modification_user.
- Return type:
- property modification_utc¶
Gets modification_utc.
- Summary:
Indicates whether the modification date/time are stored as UTC.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of modification_utc.
- Return type:
modification_utc (bool)
- property name¶
Gets Name.
- Summary:
The table name.
- Returns:
The value of Name.
- Return type:
name (str)
- property private¶
Gets Private.
- Summary:
Indicates whether the table is Private.
- Returns:
The value of Private.
- Return type:
private (bool)
- property prompt¶
Gets Prompt.
- Summary:
The display name for the table
- Remarks:
Introduced in Impact 11.0.0.112
- Returns:
The value of Prompt.
- Return type:
prompt (str)
- property relationships¶
Gets Relationships.
- Summary:
Returns a collection of the table relationships defined for this table.
- Remarks:
Introduced in Impact 11.0.0.27
- Returns:
The value of Relationships.
- Return type:
- property remote_auto_increment¶
Gets remote_auto_increment.
- Summary:
Indicates whether the index column is auto-incremented, for a remote table.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of remote_auto_increment.
- Return type:
remote_auto_increment (bool)
- property remote_index¶
Gets remote_index.
- Summary:
Returns the column storing the primary index, for a remote table.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of remote_index.
- Return type:
- property remote_row_zero_locking¶
Gets remote_row_zero_locking.
- Summary:
Indicates whether row-zero locking is used when inserting rows, for a remote table.
- Remarks:
Introduced in Impact 11.0.0.34
- Returns:
The value of remote_row_zero_locking.
- Return type:
remote_row_zero_locking (bool)
- property type¶
Gets Type.
- Summary:
The table type.
- Returns:
The value of Type.
- Return type:
- isNone()¶
Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.
- prompt_translated(language_id, exact_language_match)¶
- Summary:
Returns the tables display name, translated into the specified language.
- Remarks:
For a more detailed explanation of the parameters, please see the notes for the IDatabase.master_setting_name_translated method. Introduced in Impact 11.0.0.112
- Parameters:
language_id (any) – A string or enum representing the language wanted.
exact_language_match (bool) – Specifies what to do if there is no translation for the specified language.
Examples