sdk

No menu items for this category
OpenMetadata Documentation

module table_mixin

Mixin class containing Table specific methods

To be used by OpenMetadata class

Global Variables


  • LRU_CACHE_SIZE

OpenMetadata API methods related to Tables.

To be inherited by OpenMetadata


Create or update custom metric. If custom metric name matches an existing one then it will be updated.

Args:

  • custom_metric (CreateCustomMetricRequest): custom metric to be create or updated

Update the profileSample property of a Table, given its FQN.

Args:

fqn: Table FQN

profile_sample: new profile sample to set

Returns:

Updated table


Get the latest profile data for a table

Args:

  • fqn (str): table fully qualified name

Returns:

  • Optional[Table]: OM table object

Get profile data

Args:

  • fqn (str): fullyQualifiedName
  • start_ts (int): start timestamp
  • end_ts (int): end timestamp
  • limit (int, optional): limit of record to return. Defaults to 100.
  • after (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:

  • TypeError: if profile_type is not TableProfile or ColumnProfile

Returns:

  • EntityList: EntityList list object

GET call for the /sampleData endpoint for a given Table

Returns a Table entity with TableData (sampleData informed)


PUT profile data for a table

Args:

table: Table Entity to update

table_profile: Profile data to add


PUT data model for a table

Args:

table: Table Entity to update

data_model: Model to add


PUT sample data for a table

Args:

table: Table Entity to update

sample_data: Data to add


POST frequently joined with for a table

Args:

table: Table Entity to update

table_join_request: Join data to add


POST usage details for a Table

Args:

table: Table Entity to update

table_usage_request: Usage data to add