rhino_health.lib.endpoints.data_schema.data_schema_endpoints

Module Contents

Classes

DataSchemaEndpoints

class rhino_health.lib.endpoints.data_schema.data_schema_endpoints.DataSchemaEndpoints(session)

get_data_schema_by_name(name, version=VersionMode.LATEST, project_uid=None) → rhino_health.lib.endpoints.data_schema.data_schema_dataclass.LTSDataSchema | None

Returns the latest or a specific DataSchema dataclass

Warning

This feature is under development and the interface may change

Warning

There is no uniqueness constraint on the name for data_schemas so you may not get the correct result

Warning

VersionMode.ALL will return the same as VersionMode.LATEST

Parameters:

name: str

Full name for the DataSchema

version: Optional[Union[int, VersionMode]]

Version of the DataSchema, latest by default, for an earlier version pass in an integer

project_uid: Optional[str]

Project UID to search under

Returns:

data_schema: Optional[DataSchema]

DataSchema with the name or None if not found

Examples

>>> session.data_schema.get_data_schema_by_name("My DataSchema")
DataSchema("My DataSchema")

search_for_data_schemas_by_name(name: str, version: int | rhino_health.lib.endpoints.endpoint.VersionMode | None = VersionMode.LATEST, project_uid: str | None = None, name_filter_mode: rhino_health.lib.endpoints.endpoint.NameFilterMode | None = NameFilterMode.CONTAINS)

Returns DataSchema dataclasses

Warning

This feature is under development and the interface may change

Parameters:

name: str

Full or partial name for the DataSchema

version: Optional[Union[int, VersionMode]]

Version of the DataSchema, latest by default

project_uid: Optional[str]

Project UID to search under

name_filter_mode: Optional[NameFilterMode]

Only return results with the specified filter mode. By default uses CONTAINS

Returns:

data_schemas: List[DataSchema]

DataSchema dataclasses that match the name

See also

rhino_health.lib.endpoints.endpoint.FilterMode

Different modes to filter by

rhino_health.lib.endpoints.endpoint.VersionMode

Return specific versions

Examples

>>> session.data_schema.search_for_data_schemas_by_name("My DataSchema")
[DataSchema(name="My DataSchema")]

remove_data_schema(data_schema_uid: str)

Removes a DataSchema with the DATASCHAMA_UID from the system

Warning

This feature is under development and incomplete

get_data_schemas(data_schema_uids: List[str] | None = None) → List[rhino_health.lib.endpoints.data_schema.data_schema_dataclass.LTSDataSchema]

Gets the Data Schemas with the specified DATA_SCHEMA_UIDS

Warning

This feature is under development and the interface may change