1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
# --------------------------------------------------------------------------
#
# 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.
#
# --------------------------------------------------------------------------
"""
FILE: schema_registry.py
DESCRIPTION:
This sample demonstrates authenticating the SchemaRegistryClient and basic usage, including:
- registering a schema.
- getting a schema by its ID.
- getting a schema by its version.
- getting schema id.
USAGE:
python schema_registry.py
Set the environment variables with your own values before running the sample:
1) SCHEMAREGISTRY_FULLY_QUALIFIED_NAMESPACE - The schema registry fully qualified namespace,
which should follow the format: `<your-namespace>.servicebus.windows.net`
2) SCHEMAREGISTRY_GROUP - The name of the schema group.
This example uses DefaultAzureCredential, which requests a token from Azure Active Directory.
For more information on DefaultAzureCredential, see
https://learn.microsoft.com/python/api/overview/azure/identity-readme?view=azure-python#defaultazurecredential.
"""
import os
import json
from azure.identity import DefaultAzureCredential
from azure.schemaregistry import SchemaRegistryClient, SchemaFormat
SCHEMAREGISTRY_FQN = os.environ["SCHEMAREGISTRY_JSON_FULLY_QUALIFIED_NAMESPACE"]
GROUP_NAME = os.environ["SCHEMAREGISTRY_GROUP"]
NAME = "your-schema-name"
FORMAT = SchemaFormat.JSON
JSON_SCHEMA = {
"$id": "https://example.com/person.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Person",
"type": "object",
"properties": {
"firstName": {"type": "string", "description": "The person's first name."},
"lastName": {"type": "string", "description": "The person's last name."},
"age": {
"description": "Age in years which must be equal to or greater than zero.",
"type": "integer",
"minimum": 0,
},
},
}
NEW_JSON_SCHEMA = {
"$id": "https://example.com/person.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Person2",
"type": "object",
"properties": {
"firstName": {"type": "string", "description": "The person's first name."},
"lastName": {"type": "string", "description": "The person's last name."},
"age": {
"description": "Age in years which must be equal to or greater than zero.",
"type": "integer",
"minimum": 0,
},
},
}
DEFINITION = json.dumps(JSON_SCHEMA, separators=(",", ":"))
NEW_DEFINITION = json.dumps(NEW_JSON_SCHEMA, separators=(",", ":"))
def register_schema(client, group_name, name, definition, format):
print("Registering schema...")
schema_properties = client.register_schema(group_name, name, definition, format)
print(f"Schema registered, returned schema id is {schema_properties.id}")
print(f"Schema properties are {schema_properties}")
return schema_properties
def get_schema_by_id(client, schema_id):
print("Getting schema by id...")
schema = client.get_schema(schema_id)
print(f"The schema string of schema id: {schema_id} is {schema.definition}")
print(f"Schema properties are {schema.properties}")
return schema.definition
def get_schema_by_version(client, group_name, name, version):
print("Getting schema by version...")
schema = client.get_schema(group_name=group_name, name=name, version=version)
print(f"The schema string of schema id: {schema.properties.id} is {schema.definition}")
print(f"Schema properties are {schema.properties}")
return schema.definition
def get_old_schema_by_version(client, group_name, name, new_definition):
updated_schema_properties = client.register_schema(group_name, name, new_definition, FORMAT)
print(f"Registered new schema of version: {updated_schema_properties.version}")
old_version = updated_schema_properties.version - 1
schema = client.get_schema(group_name=group_name, name=name, version=old_version)
print(f"Retrieving old schema v{schema.properties.version}: {schema.definition}")
return schema.definition
def get_schema_id(client, group_name, name, definition, format):
print("Getting schema id...")
schema_properties = client.get_schema_properties(group_name, name, definition, format)
print(f"The schema id is: {schema_properties.id}")
print(f"Schema properties are {schema_properties}")
return schema_properties.id
if __name__ == "__main__":
token_credential = DefaultAzureCredential()
schema_registry_client = SchemaRegistryClient(
fully_qualified_namespace=SCHEMAREGISTRY_FQN, credential=token_credential
)
with schema_registry_client:
schema_properties = register_schema(schema_registry_client, GROUP_NAME, NAME, DEFINITION, FORMAT)
schema_str = get_schema_by_id(schema_registry_client, schema_properties.id)
schema_str = get_schema_by_version(schema_registry_client, GROUP_NAME, NAME, schema_properties.version)
schema_str = get_old_schema_by_version(schema_registry_client, GROUP_NAME, NAME, NEW_DEFINITION)
schema_id = get_schema_id(schema_registry_client, GROUP_NAME, NAME, DEFINITION, FORMAT)
|
