ReadDormantDIMObjectWithLock - Teradata Meta Data Services

Teradata Meta Data Services Programmer Guide

Product
Teradata Meta Data Services
Release Number
15.00
Language
English (United States)
Last Update
2018-09-28
Product Category
Teradata Tools and Utilities

ReadDormantDIMObjectWithLock

Purpose

ReadDormantDIMObjectWithLock extends the functionality of ReadObject to support the Retain Associated Business Information feature. ReadDormantDIMObjectWithLock returns an object that is either active or dormant. The requirements for specifying the object to be returned are the same as for ReadObject. ReadDormantDIMObjectWithLock differs from ReadDormantDIMObject in that it acquires all database locks necessary to both read and write the object. For a subsequent WriteObject on this object, this prevents a deadlock caused by lock upgrades. This function should always be used within an explicit transaction to retain the locks since locks are maintained until the transaction commits or rolls back.

Requirements

You must be initialized as an MDS Administrator (superuser) to use this function.

The class ID (internal or globally unique) and object name or the object ID (internal or globally unique) must be set before calling ReadDormantDIMObjectWithLock. If given, the internal object ID must be for a version of the object.

Syntax

HRESULT ReadDormantDIMObjectWithLock();