34fbe5d64c
* DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT * DOCS - Prepare 1.7 Release and 1.8 SNAPSHOT
9.7 KiB
| title | slug |
|---|---|
| Patch Mixin | /sdk/python/api-reference/patch-mixin |
module patch_mixin
Mixin class containing PATCH specific methods
To be used by OpenMetadata class
Global Variables
- OWNER_TYPES
function update_column_tags
update_column_tags(
columns: List[Column],
column_tag: ColumnTag,
operation: PatchOperation
) → None
Inplace update for the incoming column list
function update_column_description
update_column_description(
columns: List[Column],
column_fqn: str,
description: str,
force: bool = False
) → None
Inplace update for the incoming column list
class OMetaPatchMixin
OpenMetadata API methods related to Tables.
To be inherited by OpenMetadata
method patch
patch(entity: Type[~T], source: ~T, destination: ~T) → Optional[~T]
Given an Entity type and Source entity and Destination entity, generate a JSON Patch and apply it.
Args entity (T): Entity Type source: Source payload which is current state of the source in OpenMetadata destination: payload with changes applied to the source.
Returns Updated Entity
method patch_automation_workflow_response
patch_automation_workflow_response(
automation_workflow: Workflow,
test_connection_result: TestConnectionResult,
workflow_status: WorkflowStatus
) → None
Given an AutomationWorkflow, JSON PATCH the status and response.
method patch_column_description
patch_column_description(
table: Table,
column_fqn: str,
description: str,
force: bool = False
) → Optional[~T]
Given an Table , Column FQN, JSON PATCH the description of the column
Args src_table: origin Table object column_fqn: FQN of the column to update description: new description to add force: if True, we will patch any existing description. Otherwise, we will maintain the existing data. Returns Updated Entity
method patch_column_tag
patch_column_tag(
table: Table,
column_fqn: str,
tag_label: TagLabel,
operation: Union[ForwardRef(<ADD: 'add'>), ForwardRef(<REMOVE: 'remove'>)] = <PatchOperation.ADD: 'add'>
) → Optional[~T]
Will be deprecated in 1.3
method patch_column_tags
patch_column_tags(
table: Table,
column_tags: List[ColumnTag],
operation: Union[ForwardRef(<ADD: 'add'>), ForwardRef(<REMOVE: 'remove'>)] = <PatchOperation.ADD: 'add'>
) → Optional[~T]
Given an Entity ID, JSON PATCH the tag of the column
Args entity_id: ID tag_label: TagLabel to add or remove column_name: column to update operation: Patch Operation to add or remove Returns Updated Entity
method patch_description
patch_description(
entity: Type[~T],
source: ~T,
description: str,
force: bool = False
) → Optional[~T]
Given an Entity type and ID, JSON PATCH the description.
Args entity (T): Entity Type source: source entity object description: new description to add force: if True, we will patch any existing description. Otherwise, we will maintain the existing data. Returns Updated Entity
method patch_domain
patch_domain(entity: BaseModel, domain: Domain) → Optional[BaseModel]
Patch domain data for an Entity
method patch_life_cycle
patch_life_cycle(entity: BaseModel, life_cycle: LifeCycle) → Optional[BaseModel]
Patch life cycle data for a entity
:param entity: Entity to update the life cycle for :param life_cycle_data: Life Cycle data to add
method patch_owner
patch_owner(
entity: Type[~T],
source: ~T,
owner: EntityReference = None,
force: bool = False
) → Optional[~T]
Given an Entity type and ID, JSON PATCH the owner. If not owner Entity type and not owner ID are provided, the owner is removed.
Args entity (T): Entity Type of the entity to be patched entity_id: ID of the entity to be patched owner: Entity Reference of the owner. If None, the owner will be removed force: if True, we will patch any existing owner. Otherwise, we will maintain the existing data. Returns Updated Entity
method patch_table_constraints
patch_table_constraints(
table: Table,
constraints: List[TableConstraint]
) → Optional[~T]
Given an Entity ID, JSON PATCH the table constraints of table
Args source_table: Origin table description: new description to add table_constraints: table constraints to add
Returns Updated Entity
method patch_tag
patch_tag(
entity: Type[~T],
source: ~T,
tag_label: TagLabel,
operation: Union[ForwardRef(<ADD: 'add'>), ForwardRef(<REMOVE: 'remove'>)] = <PatchOperation.ADD: 'add'>
) → Optional[~T]
Will be deprecated in 1.3
method patch_tags
patch_tags(
entity: Type[~T],
source: ~T,
tag_labels: List[TagLabel],
operation: Union[ForwardRef(<ADD: 'add'>), ForwardRef(<REMOVE: 'remove'>)] = <PatchOperation.ADD: 'add'>
) → Optional[~T]
Given an Entity type and ID, JSON PATCH the tag.
Args entity (T): Entity Type source: Source entity object tag_label: TagLabel to add or remove operation: Patch Operation to add or remove the tag. Returns Updated Entity
method patch_test_case_definition
patch_test_case_definition(
source: TestCase,
entity_link: str,
test_case_parameter_values: Optional[List[TestCaseParameterValue]] = None
) → Optional[TestCase]
Given a test case and a test case definition JSON PATCH the test case
Args test_case: test case object test_case_definition: test case definition to add