SchemaManagerSettings

pydantic settings safir.kafka.SchemaManagerSettings

Settings for constructing a PydanticSchemaManager.

Parameters:

• _case_sensitive (bool | None, default: None)

• _nested_model_default_partial_update (bool | None, default: None)

• _env_prefix (str | None, default: None)

• _env_file (Union[Path, str, List[Union[str, Path]], Tuple[Union[Path, str], ...], None], default: PosixPath('.'))

• _env_file_encoding (str | None, default: None)

• _env_ignore_empty (bool | None, default: None)

• _env_nested_delimiter (str | None, default: None)

• _env_parse_none_str (str | None, default: None)

• _env_parse_enums (bool | None, default: None)

• _cli_prog_name (str | None, default: None)

• _cli_parse_args (bool | list[str] | tuple[str, ...] | None, default: None)

• _cli_settings_source (Optional[CliSettingsSource[Any]], default: None)

• _cli_parse_none_str (str | None, default: None)

• _cli_hide_none_type (bool | None, default: None)

• _cli_avoid_json (bool | None, default: None)

• _cli_enforce_required (bool | None, default: None)

• _cli_use_class_docs_for_groups (bool | None, default: None)

• _cli_exit_on_error (bool | None, default: None)

• _cli_prefix (str | None, default: None)

• _cli_implicit_flags (bool | None, default: None)

• _secrets_dir (Union[Path, str, List[Union[str, Path]], Tuple[Union[Path, str], ...], None], default: None)

• values (Any)

Show JSON schema

{
   "title": "SchemaManagerSettings",
   "description": "Settings for constructing a `~safir.kafka.PydanticSchemaManager`.",
   "type": "object",
   "properties": {
      "registryUrl": {
         "description": "URL of a a Confluent-compatible schema registry",
         "format": "uri",
         "minLength": 1,
         "title": "Schema registry URL",
         "type": "string"
      },
      "suffix": {
         "default": "",
         "description": "A suffix that is added to the schema name (and thus the subject name). The suffix creates alternate subjects in the Schema Registry so schemas registered during testing and staging don't affect the compatibility continuity of a production subject. For production, it's best to not set a suffix.",
         "examples": [
            "_dev1"
         ],
         "title": "Suffix",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "registryUrl"
   ]
}

Config:

• env_prefix: str = SCHEMA_MANAGER_

• populate_by_name: bool = True

Fields:

• registry_url (pydantic_core._pydantic_core.Url)

• suffix (str)

field registry_url: AnyUrl [Required]

URL of a a Confluent-compatible schema registry

field suffix: str = ''

A suffix that is added to the schema name (and thus the subject name). The suffix creates alternate subjects in the Schema Registry so schemas registered during testing and staging don’t affect the compatibility continuity of a production subject. For production, it’s best to not set a suffix.

make_manager()

Construct a PydanticSchemaManager from the fields of this model.

Return type:

PydanticSchemaManager

to_registry_params()

Make a dict of params to construct an AsyncSchemaRegistryClient.

Return type:

SchemaRegistryClientParams