> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Table Mixin

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L0")

# module `table_mixin`

Mixin class containing Table specific methods

To be used by OpenMetadata class

## **Global Variables**

* **LRU\_CACHE\_SIZE**

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L51")

## class `OMetaTableMixin`

OpenMetadata API methods related to Tables.

To be inherited by OpenMetadata

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L295")

### method `create_or_update_custom_metric`

```python theme={null}
create_or_update_custom_metric(
    custom_metric: CreateCustomMetricRequest,
    table_id: str
) → Table
```

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

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L210")

### method `create_or_update_table_profiler_config`

```python theme={null}
create_or_update_table_profiler_config(
    fqn: str,
    table_profiler_config: TableProfilerConfig
) → Optional[Table]
```

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

**Args:**

`fqn`: Table FQN

`profile_sample`: new profile sample to set

**Returns:**

Updated table

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L282")

### method `get_latest_table_profile`

```python theme={null}
get_latest_table_profile(fqn: FullyQualifiedEntityName) → Optional[Table]
```

Get the latest profile data for a table

**Args:**

* `fqn` (str):  table fully qualified name

**Returns:**

* `Optional[Table]`:  OM table object

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L230")

### method `get_profile_data`

```python theme={null}
get_profile_data(
    fqn: str,
    start_ts: int,
    end_ts: int,
    limit=100,
    after=None,
    profile_type: Type[~T] = <class 'metadata.generated.schema.entity.data.table.TableProfile'>
) → EntityList[~T]
```

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

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L97")

### method `get_sample_data`

```python theme={null}
get_sample_data(table: Table) → Optional[Table]
```

GET call for the /sampleData endpoint for a given Table

Returns a Table entity with TableData (sampleData informed)

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L130")

### method `ingest_profile_data`

```python theme={null}
ingest_profile_data(
    table: Table,
    profile_request: CreateTableProfileRequest
) → Table
```

PUT profile data for a table

**Args:**

`table`: Table Entity to update

`table_profile`: Profile data to add

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L145")

### method `ingest_table_data_model`

```python theme={null}
ingest_table_data_model(table: Table, data_model: DataModel) → Table
```

PUT data model for a table

**Args:**

`table`: Table Entity to update

`data_model`: Model to add

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L60")

### method `ingest_table_sample_data`

```python theme={null}
ingest_table_sample_data(
    table: Table,
    sample_data: TableData
) → Optional[TableData]
```

PUT sample data for a table

**Args:**

`table`: Table Entity to update

`sample_data`: Data to add

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L172")

### method `publish_frequently_joined_with`

```python theme={null}
publish_frequently_joined_with(
    table: Table,
    table_join_request: TableJoins
) → None
```

POST frequently joined with for a table

**Args:**

`table`: Table Entity to update

`table_join_request`: Join data to add

***

[<img src="https://img.shields.io/badge/-source-cccccc?style=flat-square" />](https://github.com/open-metadata/OpenMetadata/tree/main/ingestion/src/metadata/ingestion/ometa/mixins/table_mixin.py#L158")

### method `publish_table_usage`

```python theme={null}
publish_table_usage(table: Table, table_usage_request: UsageRequest) → None
```

POST usage details for a Table

**Args:**

`table`: Table Entity to update

`table_usage_request`: Usage data to add

***