kafka_overwatch.overwatch_resources.schema_registry package

Submodules

kafka_overwatch.overwatch_resources.schema_registry.schema module

class kafka_overwatch.overwatch_resources.schema_registry.schema. Schema ( schema_id , schema_string , overwatch_registry , schema_type = None ) [source]

Bases: object

Class to maintain metadata about schema

property overwatch_registry : SchemaRegistry
property schema_type : str | None
kafka_overwatch.overwatch_resources.schema_registry.schema. refresh_subject_metadata ( subject , sr_client ) [source]

Iterates over all the versions of a given subject. If the version and schema is already in the registry inventory, skip. If not, retrieve the schema details, and store to the in-memory registry.

kafka_overwatch.overwatch_resources.schema_registry.schemas_restore module

Module used to re-import schemas from backup to existing or new schema registry

kafka_overwatch.overwatch_resources.schema_registry.schemas_restore. main ( * args , ** kwargs ) [source]

Main function

kafka_overwatch.overwatch_resources.schema_registry.schemas_restore. restore_subject ( schema_registry , subject_name , subject_details , tmp_folder ) [source]
Return type :

None

kafka_overwatch.overwatch_resources.schema_registry.schemas_restore. restore_subject_versions ( schema_registry , subject_name , subject_details , tmp_folder , existing_versions = None ) [source]

Restore a full subject given it doesn’t exist in Registry

Return type :

None

kafka_overwatch.overwatch_resources.schema_registry.subject module

class kafka_overwatch.overwatch_resources.schema_registry.subject. Subject ( name , overwatch_registry ) [source]

Bases: object

“Class to maintain subject metadata information

property overwatch_registry : SchemaRegistry

Module contents

class kafka_overwatch.overwatch_resources.schema_registry. BasicAuthCreds ( username , password , runtime_key ) [source]

Bases: object

get_sr_creds ( runtime_key ) [source]
class kafka_overwatch.overwatch_resources.schema_registry. SchemaRegistry ( registry_name , registry_config , runtime_key ) [source]

Bases: object

Manages a schema registry and its assignment to Kafka clusters

backup ( s3_backup_handler ) [source]
property config : SchemaRegistry
get_client ( runtime_key ) [source]
Return type :

typing.Optional [ kafka_schema_registry_admin.kafka_schema_registry_admin.SchemaRegistry ]

init_backup_handler ( ) [source]
Return type :

kafka_overwatch.aws_helpers.s3.S3Handler

schemas : dict [ int , kafka_overwatch.overwatch_resources.schema_registry.schema.Schema ]

Kafka clusters this schema registry is linked to

subjects : dict [ str , kafka_overwatch.overwatch_resources.schema_registry.subject.Subject ]

Index of the schemas in the registry