Kafka.Avro.SchemaRegistry

Documentation

schemaRegistry :: MonadIO m => String -> m SchemaRegistry

loadSchema :: MonadIO m => SchemaRegistry -> SchemaId -> m (Either SchemaRegistryError Schema)

sendSchema :: MonadIO m => SchemaRegistry -> Subject -> Schema -> m (Either SchemaRegistryError SchemaId)

getGlobalConfig :: MonadIO m => SchemaRegistry -> m (Either SchemaRegistryError Compatibility)

getSubjectConfig :: MonadIO m => SchemaRegistry -> Subject -> m (Either SchemaRegistryError Compatibility)

getVersions :: MonadIO m => SchemaRegistry -> Subject -> m (Either SchemaRegistryError [Version])

isCompatible :: MonadIO m => SchemaRegistry -> Subject -> Version -> Schema -> m (Either SchemaRegistryError Bool)

getSubjects :: MonadIO m => SchemaRegistry -> m (Either SchemaRegistryError [Subject])

newtype SchemaId

Constructors

SchemaId

Fields

• unSchemaId :: Int32

Instances

Eq SchemaId

Methods

(==) :: SchemaId -> SchemaId -> Bool

(/=) :: SchemaId -> SchemaId -> Bool

Ord SchemaId

Methods

compare :: SchemaId -> SchemaId -> Ordering

(<) :: SchemaId -> SchemaId -> Bool

(<=) :: SchemaId -> SchemaId -> Bool

(>) :: SchemaId -> SchemaId -> Bool

(>=) :: SchemaId -> SchemaId -> Bool

max :: SchemaId -> SchemaId -> SchemaId

min :: SchemaId -> SchemaId -> SchemaId

Show SchemaId

Methods

showsPrec :: Int -> SchemaId -> ShowS

show :: SchemaId -> String

showList :: [SchemaId] -> ShowS

Hashable SchemaId

Methods

hashWithSalt :: Int -> SchemaId -> Int

hash :: SchemaId -> Int

FromJSON SchemaId

Methods

parseJSON :: Value -> Parser SchemaId

parseJSONList :: Value -> Parser [SchemaId]

newtype Subject

Constructors

Subject

Fields

• unSubject :: Text

Instances

Eq Subject

Methods

(==) :: Subject -> Subject -> Bool

(/=) :: Subject -> Subject -> Bool

Ord Subject

Methods

compare :: Subject -> Subject -> Ordering

(<) :: Subject -> Subject -> Bool

(<=) :: Subject -> Subject -> Bool

(>) :: Subject -> Subject -> Bool

(>=) :: Subject -> Subject -> Bool

max :: Subject -> Subject -> Subject

min :: Subject -> Subject -> Subject

Show Subject

Methods

showsPrec :: Int -> Subject -> ShowS

show :: Subject -> String

showList :: [Subject] -> ShowS

IsString Subject

Methods

fromString :: String -> Subject

Generic Subject

Associated Types

type Rep Subject :: * -> *

Methods

from :: Subject -> Rep Subject x

to :: Rep Subject x -> Subject

Hashable Subject

Methods

hashWithSalt :: Int -> Subject -> Int

hash :: Subject -> Int

type Rep Subject

type Rep Subject = D1 * (MetaData "Subject" "Kafka.Avro.SchemaRegistry" "hw-kafka-avro-2.1.0-DL1XohKs9riKgHB3D5aGWJ" True) (C1 * (MetaCons "Subject" PrefixI True) (S1 * (MetaSel (Just Symbol "unSubject") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

data SchemaRegistry

data SchemaRegistryError

Constructors

SchemaRegistryConnectError String

SchemaRegistryLoadError SchemaId

SchemaRegistrySchemaNotFound SchemaId

SchemaRegistrySendError String

Instances

Eq SchemaRegistryError

Methods

(==) :: SchemaRegistryError -> SchemaRegistryError -> Bool

(/=) :: SchemaRegistryError -> SchemaRegistryError -> Bool

Show SchemaRegistryError

Methods

showsPrec :: Int -> SchemaRegistryError -> ShowS

show :: SchemaRegistryError -> String

showList :: [SchemaRegistryError] -> ShowS

type Schema = Type

An Avro schema is either * A "JSON object in the form `{"type":"typeName" ...` * A "JSON string, naming a defined type" (basic type wo free variablesnames) * A "JSON array, representing a union"

N.B. It is possible to create a Haskell value (of Schema type) that is not a valid Avro schema by violating one of the above or one of the conditions called out in validateSchema.

data Compatibility

Constructors

NoCompatibility

FullCompatibility

ForwardCompatibility

BackwardCompatibility

Instances

Eq Compatibility

Methods

(==) :: Compatibility -> Compatibility -> Bool

(/=) :: Compatibility -> Compatibility -> Bool

Ord Compatibility

Methods

compare :: Compatibility -> Compatibility -> Ordering

(<) :: Compatibility -> Compatibility -> Bool

(<=) :: Compatibility -> Compatibility -> Bool

(>) :: Compatibility -> Compatibility -> Bool

(>=) :: Compatibility -> Compatibility -> Bool

max :: Compatibility -> Compatibility -> Compatibility

min :: Compatibility -> Compatibility -> Compatibility

Show Compatibility

Methods

showsPrec :: Int -> Compatibility -> ShowS

show :: Compatibility -> String

showList :: [Compatibility] -> ShowS

FromJSON Compatibility

Methods

parseJSON :: Value -> Parser Compatibility

parseJSONList :: Value -> Parser [Compatibility]

newtype Version

Constructors

Version

Fields

• unVersion :: Word32

Instances

Eq Version

Methods

(==) :: Version -> Version -> Bool

(/=) :: Version -> Version -> Bool

Ord Version

Methods

compare :: Version -> Version -> Ordering

(<) :: Version -> Version -> Bool

(<=) :: Version -> Version -> Bool

(>) :: Version -> Version -> Bool

(>=) :: Version -> Version -> Bool

max :: Version -> Version -> Version

min :: Version -> Version -> Version

Show Version

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Hashable Version

Methods

hashWithSalt :: Int -> Version -> Int

hash :: Version -> Int