AlternateKeyInfo Class

Alternate key metadata for a Dataverse table.

Constructor

AlternateKeyInfo(metadata_id: str = '', schema_name: str = '', key_attributes: ~typing.List[str] = <factory>, status: str = '')

Name	Description
metadata_id Required	str Key metadata GUID.
schema_name Required	str Key schema name.
key_attributes	list[str] List of column logical names that compose the key. Default value: <factory>
status Required	str Index creation status (`"Active"`, `"Pending"`, `"InProgress"`, `"Failed"`).

Create from raw EntityKeyMetadata API response.

Create from raw EntityKeyMetadata API response.

from_api_response(response_data: Dict[str, Any]) -> AlternateKeyInfo

Name	Description
response_data Required	dict Raw key metadata dictionary from the Web API.

Type	Description
AlternateKeyInfo

key_attributes: List[str]

metadata_id: str = ''

schema_name: str = ''

status: str = ''