module table_mixin
Mixin class containing Table specific methods
To be used by OpenMetadata class
Global Variables
- LRU_CACHE_SIZE
class OMetaTableMixin
OpenMetadata API methods related to Tables.
To be inherited by OpenMetadata
method create_or_update_custom_metric
Create or update custom metric. If custom metric name matches an existing one then it will be updated.
Args:
- <b>
custom_metric
</b> (CreateCustomMetricRequest): custom metric to be create or updated
method create_or_update_table_profiler_config
Update the profileSample property of a Table, given its FQN.
:param fqn: Table FQN :param profile_sample: new profile sample to set :return: Updated table
method get_latest_table_profile
Get the latest profile data for a table
Args:
- <b>
fqn
</b> (str): table fully qualified name
Returns:
- <b>
Optional[Table]
</b>: OM table object
method get_profile_data
Get profile data
Args:
- <b>
fqn
</b> (str): fullyQualifiedName - <b>
start_ts
</b> (int): start timestamp - <b>
end_ts
</b> (int): end timestamp - <b>
limit
</b> (int, optional): limit of record to return. Defaults to 100. - <b>
after
</b> (type, optional): use for API pagination. Defaults to None. profile_type (Union[Type[TableProfile], Type[ColumnProfile]], optional): Profile type to retrieve. Defaults to TableProfile.
Raises:
- <b>
TypeError
</b>: ifprofile_type
is not TableProfile or ColumnProfile
Returns:
- <b>
EntityList
</b>: EntityList list object
method get_sample_data
GET call for the /sampleData endpoint for a given Table
Returns a Table entity with TableData (sampleData informed)
method ingest_profile_data
PUT profile data for a table
:param table: Table Entity to update :param table_profile: Profile data to add
method ingest_table_data_model
PUT data model for a table
:param table: Table Entity to update :param data_model: Model to add
method ingest_table_sample_data
PUT sample data for a table
:param table: Table Entity to update :param sample_data: Data to add
method publish_frequently_joined_with
POST frequently joined with for a table
:param table: Table Entity to update :param table_join_request: Join data to add
method publish_table_usage
POST usage details for a Table
:param table: Table Entity to update :param table_usage_request: Usage data to add