# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# --------------------------------------------------------------------------
from typing import Any, TYPE_CHECKING, Union
from .._common._constants import SchemaFormat
from .._common._schema import Schema, SchemaProperties
from .._common._response_handlers import (
_parse_response_schema,
_parse_response_schema_properties,
)
from .._generated.aio._azure_schema_registry import AzureSchemaRegistry
from .._generated.rest import schema as schema_rest
if TYPE_CHECKING:
from azure.core.credentials_async import AsyncTokenCredential
[docs]class SchemaRegistryClient(object):
"""
SchemaRegistryClient is as a central schema repository for enterprise-level data infrastructure,
complete with support for versioning and management.
:param str fully_qualified_namespace: The Schema Registry service fully qualified host name,
for example my-namespace.servicebus.windows.net.
:param credential: To authenticate to manage the entities of the SchemaRegistry namespace.
:type credential: AsyncTokenCredential
.. admonition:: Example:
.. literalinclude:: ../samples/async_samples/sample_code_schemaregistry_async.py
:start-after: [START create_sr_client_async]
:end-before: [END create_sr_client_async]
:language: python
:dedent: 4
:caption: Create a new instance of the SchemaRegistryClient.
"""
def __init__(
self,
fully_qualified_namespace: str,
credential: "AsyncTokenCredential",
**kwargs: Any
) -> None:
self._generated_client = AzureSchemaRegistry(credential, fully_qualified_namespace, **kwargs)
async def __aenter__(self):
await self._generated_client.__aenter__()
return self
async def __aexit__(self, *args):
await self._generated_client.__aexit__(*args)
[docs] async def close(self) -> None:
""" This method is to close the sockets opened by the client.
It need not be used when using with a context manager.
"""
await self._generated_client.close()
[docs] async def register_schema(
self,
group_name: str,
name: str,
schema_definition: str,
format: Union[str, SchemaFormat], # pylint:disable=redefined-builtin
**kwargs: Any
) -> SchemaProperties:
"""
Register new schema. If schema of specified name does not exist in specified group,
schema is created at version 1. If schema of specified name exists already in specified group,
schema is created at latest version + 1.
:param str group_name: Schema group under which schema should be registered.
:param str name: Name of schema being registered.
:param str schema_definition: String representation of the schema being registered.
:param format: Format for the schema being registered.
For now Avro is the only supported schema format by the service.
:type format: Union[str, SchemaFormat]
:rtype: SchemaProperties
.. admonition:: Example:
.. literalinclude:: ../samples/async_samples/sample_code_schemaregistry_async.py
:start-after: [START register_schema_async]
:end-before: [END register_schema_async]
:language: python
:dedent: 4
:caption: Register a new schema.
"""
try:
format = format.value
except AttributeError:
pass
request = schema_rest.build_register_request(
group_name=group_name,
schema_name=name,
content=schema_definition,
serialization_type=format,
content_type=kwargs.pop("content_type", "application/json"),
**kwargs
)
response = await self._generated_client.send_request(request)
response.raise_for_status()
return _parse_response_schema_properties(response)
[docs] async def get_schema(
self,
id: str, # pylint:disable=redefined-builtin
**kwargs: Any
) -> Schema:
"""
Gets a registered schema by its unique ID.
Azure Schema Registry guarantees that ID is unique within a namespace.
:param str id: References specific schema in registry namespace.
:rtype: Schema
.. admonition:: Example:
.. literalinclude:: ../samples/async_samples/sample_code_schemaregistry_async.py
:start-after: [START get_schema_async]
:end-before: [END get_schema_async]
:language: python
:dedent: 4
:caption: Get schema by id.
"""
request = schema_rest.build_get_by_id_request(schema_id=id)
response = await self._generated_client.send_request(request, **kwargs)
response.raise_for_status()
return _parse_response_schema(response)
[docs] async def get_schema_properties(
self,
group_name: str,
name: str,
schema_definition: str,
format: Union[str, SchemaFormat], # pylint:disable=redefined-builtin
**kwargs: Any
) -> SchemaProperties:
"""
Gets the ID referencing an existing schema within the specified schema group,
as matched by schema defintion comparison.
:param str group_name: Schema group under which schema should be registered.
:param str name: Name of schema being registered.
:param str schema_definition: String representation of the schema being registered.
:param format: Format for the schema being registered.
:type format: Union[str, SchemaFormat]
:rtype: SchemaProperties
.. admonition:: Example:
.. literalinclude:: ../samples/async_samples/sample_code_schemaregistry_async.py
:start-after: [START get_schema_id_async]
:end-before: [END get_schema_id_async]
:language: python
:dedent: 4
:caption: Get schema by id.
"""
try:
format = format.value
except AttributeError:
pass
request = schema_rest.build_query_id_by_content_request(
group_name=group_name,
schema_name=name,
content=schema_definition,
serialization_type=format,
content_type=kwargs.pop("content_type", "application/json"),
**kwargs
)
response = await self._generated_client.send_request(request, **kwargs)
response.raise_for_status()
return _parse_response_schema_properties(response)