Safe Haskell	Safe-Inferred
Language	Haskell2010

Kafka.Avro.SchemaRegistry

Synopsis

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)
schemaRegistry_ :: MonadIO m => Maybe Auth -> String -> m SchemaRegistry
schemaRegistryWithHeaders :: MonadIO m => Maybe Auth -> [Header] -> String -> m SchemaRegistry
loadSubjectSchema :: MonadIO m => SchemaRegistry -> Subject -> Version -> m (Either SchemaRegistryError Schema)
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])
defaultSchemaRegistryConfig :: SchemaRegistryConfig
cfgAuth :: Maybe Auth -> SchemaRegistryConfig -> SchemaRegistryConfig
cfgHeaders :: [Header] -> SchemaRegistryConfig -> SchemaRegistryConfig
cfgAutoRegisterSchemas :: Bool -> SchemaRegistryConfig -> SchemaRegistryConfig
newtype SchemaId = SchemaId {
- unSchemaId :: Int32
}
newtype Subject = Subject {
- unSubject :: Text
}
data SchemaRegistryConfig
data SchemaRegistry
data SchemaRegistryError
- = SchemaRegistryConnectError String
- | SchemaRegistryLoadError SchemaId
- | SchemaRegistrySchemaNotFound SchemaId
- | SchemaRegistrySubjectNotFound Subject
- | SchemaRegistryNoCompatibleSchemaFound Schema
- | SchemaRegistryUrlNotFound String
- | SchemaRegistrySendError String
- | SchemaRegistryCacheError
data Schema where
- Null
- Boolean
- Int {
  - logicalTypeI :: Maybe LogicalTypeInt
  }
- Long {
  - logicalTypeL :: Maybe LogicalTypeLong
  }
- Float
- Double
- Bytes {
  - logicalTypeB :: Maybe LogicalTypeBytes
  }
- String {
  - logicalTypeS :: Maybe LogicalTypeString
  }
- Array {
  - item :: Schema
  }
- Map {
  - values :: Schema
  }
- NamedType TypeName
- Record {
  - name :: TypeName
  - aliases :: [TypeName]
  - doc :: Maybe Text
  - fields :: [Field]
  }
- Enum {
  - name :: TypeName
  - aliases :: [TypeName]
  - doc :: Maybe Text
  - symbols :: Vector Text
  }
- Union {
  - options :: Vector Schema
  }
- Fixed {
  - name :: TypeName
  - aliases :: [TypeName]
  - size :: Int
  - logicalTypeF :: Maybe LogicalTypeFixed
  }
- pattern String' :: Schema
- pattern Bytes' :: Schema
- pattern Long' :: Schema
- pattern Int' :: Schema
data Compatibility
- = NoCompatibility
- | FullCompatibility
- | ForwardCompatibility
- | BackwardCompatibility
newtype Version = Version {
- unVersion :: Word32
}

Documentation

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

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

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

Get the schema ID. If the SchemaRegistry is configured to auto-register schemas, this posts the schema to the schema registry server. Otherwise, this searches for a compatible schema and returns a SchemaRegistryNoCompatibleSchemaFound if none is found.

schemaRegistry_ :: MonadIO m => Maybe Auth -> String -> m SchemaRegistry Source #

schemaRegistryWithHeaders :: MonadIO m => Maybe Auth -> [Header] -> String -> m SchemaRegistry Source #

loadSubjectSchema :: MonadIO m => SchemaRegistry -> Subject -> Version -> m (Either SchemaRegistryError Schema) Source #

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

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

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

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

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

defaultSchemaRegistryConfig :: SchemaRegistryConfig Source #

cfgAuth :: Maybe Auth -> SchemaRegistryConfig -> SchemaRegistryConfig Source #

Add authentication options

cfgHeaders :: [Header] -> SchemaRegistryConfig -> SchemaRegistryConfig Source #

Add extra headers

cfgAutoRegisterSchemas :: Bool -> SchemaRegistryConfig -> SchemaRegistryConfig Source #

Set whether to auto-publish schemas If set to False, encoding will fail if there is no compatible schema in the schema registy. This is equivalent to the confluent 'auto.register.schemas' option.

newtype SchemaId Source #

Constructors

SchemaId
Fields unSchemaId :: Int32

Instances

Instances details

FromJSON SchemaId Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods parseJSON :: Value -> Parser SchemaId # parseJSONList :: Value -> Parser [SchemaId] # omittedField :: Maybe SchemaId #
Show SchemaId Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods showsPrec :: Int -> SchemaId -> ShowS # show :: SchemaId -> String # showList :: [SchemaId] -> ShowS #
Eq SchemaId Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods (==) :: SchemaId -> SchemaId -> Bool # (/=) :: SchemaId -> SchemaId -> Bool #
Ord SchemaId Source #
Instance details Defined in Kafka.Avro.SchemaRegistry 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 #
Hashable SchemaId Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods hashWithSalt :: Int -> SchemaId -> Int # hash :: SchemaId -> Int #

newtype Subject Source #

Constructors

Subject
Fields unSubject :: Text

Instances

Instances details

IsString Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods fromString :: String -> Subject #
Generic Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Associated Types type Rep Subject :: Type -> Type # Methods from :: Subject -> Rep Subject x # to :: Rep Subject x -> Subject #
Show Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods showsPrec :: Int -> Subject -> ShowS # show :: Subject -> String # showList :: [Subject] -> ShowS #
Eq Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods (==) :: Subject -> Subject -> Bool # (/=) :: Subject -> Subject -> Bool #
Ord Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry 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 #
Hashable Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods hashWithSalt :: Int -> Subject -> Int # hash :: Subject -> Int #
type Rep Subject Source #
Instance details Defined in Kafka.Avro.SchemaRegistry type Rep Subject = D1 ('MetaData "Subject" "Kafka.Avro.SchemaRegistry" "hw-kafka-avro-6.1.2-5vCsqYhHrV8COh2oNt0J9X" 'True) (C1 ('MetaCons "Subject" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSubject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data SchemaRegistryConfig Source #

data SchemaRegistry Source #

data SchemaRegistryError Source #

Constructors

SchemaRegistryConnectError String
SchemaRegistryLoadError SchemaId
SchemaRegistrySchemaNotFound SchemaId
SchemaRegistrySubjectNotFound Subject
SchemaRegistryNoCompatibleSchemaFound Schema
SchemaRegistryUrlNotFound String
SchemaRegistrySendError String
SchemaRegistryCacheError

Instances

Instances details

Show SchemaRegistryError Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods showsPrec :: Int -> SchemaRegistryError -> ShowS # show :: SchemaRegistryError -> String # showList :: [SchemaRegistryError] -> ShowS #
Eq SchemaRegistryError Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods (==) :: SchemaRegistryError -> SchemaRegistryError -> Bool # (/=) :: SchemaRegistryError -> SchemaRegistryError -> Bool #

data Schema #

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.

Constructors

Null
Boolean
Int
Fields logicalTypeI :: Maybe LogicalTypeInt
Long
Fields logicalTypeL :: Maybe LogicalTypeLong
Float
Double
Bytes
Fields logicalTypeB :: Maybe LogicalTypeBytes
String
Fields logicalTypeS :: Maybe LogicalTypeString
Array
Fields item :: Schema
Map
Fields values :: Schema
NamedType TypeName
Record
Fields name :: TypeName aliases :: [TypeName] doc :: Maybe Text fields :: [Field]
Enum
Fields name :: TypeName aliases :: [TypeName] doc :: Maybe Text symbols :: Vector Text
Union
Fields options :: Vector Schema
Fixed
Fields name :: TypeName aliases :: [TypeName] size :: Int logicalTypeF :: Maybe LogicalTypeFixed

Bundled Patterns

pattern String' :: Schema
pattern Bytes' :: Schema
pattern Long' :: Schema
pattern Int' :: Schema

Instances

Instances details

FromJSON Schema
Instance details Defined in Data.Avro.Schema.Schema Methods parseJSON :: Value -> Parser Schema # parseJSONList :: Value -> Parser [Schema] # omittedField :: Maybe Schema #
ToJSON Schema
Instance details Defined in Data.Avro.Schema.Schema Methods toJSON :: Schema -> Value # toEncoding :: Schema -> Encoding # toJSONList :: [Schema] -> Value # toEncodingList :: [Schema] -> Encoding # omitField :: Schema -> Bool #
Generic Schema
Instance details Defined in Data.Avro.Schema.Schema Associated Types type Rep Schema :: Type -> Type # Methods from :: Schema -> Rep Schema x # to :: Rep Schema x -> Schema #
Show Schema
Instance details Defined in Data.Avro.Schema.Schema Methods showsPrec :: Int -> Schema -> ShowS # show :: Schema -> String # showList :: [Schema] -> ShowS #
NFData Schema
Instance details Defined in Data.Avro.Schema.Schema Methods rnf :: Schema -> () #
Eq Schema
Instance details Defined in Data.Avro.Schema.Schema Methods (==) :: Schema -> Schema -> Bool # (/=) :: Schema -> Schema -> Bool #
Ord Schema
Instance details Defined in Data.Avro.Schema.Schema Methods compare :: Schema -> Schema -> Ordering # (<) :: Schema -> Schema -> Bool # (<=) :: Schema -> Schema -> Bool # (>) :: Schema -> Schema -> Bool # (>=) :: Schema -> Schema -> Bool # max :: Schema -> Schema -> Schema # min :: Schema -> Schema -> Schema #
type Rep Schema
Instance details Defined in Data.Avro.Schema.Schema type Rep Schema = D1 ('MetaData "Schema" "Data.Avro.Schema.Schema" "avro-0.6.2.1-K4NKVXEWvoh82sZBiL8gyp" 'False) (((C1 ('MetaCons "Null" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Boolean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Int" 'PrefixI 'True) (S1 ('MetaSel ('Just "logicalTypeI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogicalTypeInt))))) :+: ((C1 ('MetaCons "Long" 'PrefixI 'True) (S1 ('MetaSel ('Just "logicalTypeL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogicalTypeLong))) :+: C1 ('MetaCons "Float" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Double" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Bytes" 'PrefixI 'True) (S1 ('MetaSel ('Just "logicalTypeB") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogicalTypeBytes)))))) :+: (((C1 ('MetaCons "String" 'PrefixI 'True) (S1 ('MetaSel ('Just "logicalTypeS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogicalTypeString))) :+: C1 ('MetaCons "Array" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Schema))) :+: (C1 ('MetaCons "Map" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Schema)) :+: C1 ('MetaCons "NamedType" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TypeName)))) :+: ((C1 ('MetaCons "Record" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TypeName) :: S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TypeName])) :: (S1 ('MetaSel ('Just "doc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Field]))) :+: C1 ('MetaCons "Enum" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TypeName) :: S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TypeName])) :: (S1 ('MetaSel ('Just "doc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "symbols") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Text))))) :+: (C1 ('MetaCons "Union" 'PrefixI 'True) (S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Schema))) :+: C1 ('MetaCons "Fixed" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TypeName) :: S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TypeName])) :: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "logicalTypeF") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogicalTypeFixed))))))))

data Compatibility Source #

Constructors

NoCompatibility
FullCompatibility
ForwardCompatibility
BackwardCompatibility

Instances

Instances details

FromJSON Compatibility Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods parseJSON :: Value -> Parser Compatibility # parseJSONList :: Value -> Parser [Compatibility] # omittedField :: Maybe Compatibility #
Show Compatibility Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods showsPrec :: Int -> Compatibility -> ShowS # show :: Compatibility -> String # showList :: [Compatibility] -> ShowS #
Eq Compatibility Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods (==) :: Compatibility -> Compatibility -> Bool # (/=) :: Compatibility -> Compatibility -> Bool #
Ord Compatibility Source #
Instance details Defined in Kafka.Avro.SchemaRegistry 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 #

newtype Version Source #

Constructors

Version
Fields unVersion :: Word32

Instances

Instances details

Show Version Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
Eq Version Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in Kafka.Avro.SchemaRegistry 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 #
Hashable Version Source #
Instance details Defined in Kafka.Avro.SchemaRegistry Methods hashWithSalt :: Int -> Version -> Int # hash :: Version -> Int #