IDatabaseQueryMasterSetting¶
- class IDatabaseQueryMasterSetting¶
Bases:
IMasterSetting- Summary:
An object that represents a Database Query Master Tool Setting.
- Remarks:
Various properties of the query setting are exposed allowing the caller to provide user input to queries that require it. Introduced in Impact 5.1.4.24
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property criteria¶
Gets Criteria.
- Summary:
A list of all the search criteria to be used with a database query.
- Returns:
The value of Criteria.
- Return type:
- property full_name¶
Gets full_name.
- Summary:
Gets the full name of the setting including the path.
- Returns:
The value of full_name.
- Return type:
full_name (str)
- property key¶
Gets Key.
- Summary:
Gets the key of the setting.
- Returns:
The value of Key.
- Return type:
key (int)
- property layer_search_tables¶
Gets layer_search_tables.
- Summary:
Gets a comma separated list of layer type tables that will be searched by the database query.
- Remarks:
Introduced in Impact 6.4.0.9 and 7.0.0.58.
- Returns:
The value of layer_search_tables.
- Return type:
layer_search_tables (str)
- property name¶
Gets Name.
- Summary:
Gets the name of the setting.
- Returns:
The value of Name.
- Return type:
name (str)
- property sites¶
Gets Sites.
- Summary:
An ISites collection containing all the sites with which this MTS is associated.
- Remarks:
If IDatabase.settings.mts_sites is false, then NULL will be returned.
- property type¶
Gets Type.
- Summary:
The type of setting.
- 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.
- refresh()¶
- Summary:
Refresh the setting from the database.
Examples