Hydra.Ext.Avro.Schema

A model for Avro schemas. Based on the Avro 1.11.1 specification: | https://avro.apache.org/docs/1.11.1/specification)

Documentation

data Array

Constructors

Array

Fields

• arrayItems :: Schema

Instances

Read Array

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Array

readList :: ReadS [Array]

readPrec :: ReadPrec Array

readListPrec :: ReadPrec [Array]

Show Array

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Array -> ShowS

show :: Array -> String

showList :: [Array] -> ShowS

Eq Array

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Array -> Array -> Bool

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

Ord Array

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Array -> Array -> Ordering

(<) :: Array -> Array -> Bool

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

(>) :: Array -> Array -> Bool

(>=) :: Array -> Array -> Bool

max :: Array -> Array -> Array

min :: Array -> Array -> Array

_Array :: Name

_Array_items :: FieldName

data Enum_

Constructors

Enum_

Fields

• enumSymbols :: [String]

  a JSON array, listing symbols, as JSON strings. All symbols in an enum must be unique; duplicates are prohibited. Every symbol must match the regular expression [A-Za-z_][A-Za-z0-9_]* (the same requirement as for names)

• enumDefault :: Maybe String

  A default value for this enumeration, used during resolution when the reader encounters a symbol from the writer that isn’t defined in the reader’s schema. The value provided here must be a JSON string that’s a member of the symbols array

Instances

Read Enum_

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Enum_

readList :: ReadS [Enum_]

readPrec :: ReadPrec Enum_

readListPrec :: ReadPrec [Enum_]

Show Enum_

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Enum_ -> ShowS

show :: Enum_ -> String

showList :: [Enum_] -> ShowS

Eq Enum_

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Enum_ -> Enum_ -> Bool

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

Ord Enum_

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Enum_ -> Enum_ -> Ordering

(<) :: Enum_ -> Enum_ -> Bool

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

(>) :: Enum_ -> Enum_ -> Bool

(>=) :: Enum_ -> Enum_ -> Bool

max :: Enum_ -> Enum_ -> Enum_

min :: Enum_ -> Enum_ -> Enum_

_Enum :: Name

_Enum_symbols :: FieldName

_Enum_default :: FieldName

data Field

Constructors

Field

Fields

• fieldName :: String

  a JSON string providing the name of the field

• fieldDoc :: Maybe String

  a JSON string describing this field for users

• fieldType :: Schema

  a schema

• fieldDefault :: Maybe Value

  default value for this field, only used when reading instances that lack the field for schema evolution purposes

• fieldOrder :: Maybe Order

  specifies how this field impacts sort ordering of this record

• fieldAliases :: Maybe [String]

  a JSON array of strings, providing alternate names for this field

• fieldAnnotations :: Map String Value

  Any additional key/value pairs attached to the field

Instances

Read Field

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Field

readList :: ReadS [Field]

readPrec :: ReadPrec Field

readListPrec :: ReadPrec [Field]

Show Field

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

Eq Field

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Field -> Field -> Bool

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

Ord Field

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Field -> Field -> Ordering

(<) :: Field -> Field -> Bool

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

(>) :: Field -> Field -> Bool

(>=) :: Field -> Field -> Bool

max :: Field -> Field -> Field

min :: Field -> Field -> Field

_Field :: Name

_Field_name :: FieldName

_Field_doc :: FieldName

_Field_type :: FieldName

_Field_default :: FieldName

_Field_order :: FieldName

_Field_aliases :: FieldName

_Field_annotations :: FieldName

data Fixed

Constructors

Fixed

Fields

• fixedSize :: Int

  an integer, specifying the number of bytes per value

Instances

Read Fixed

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Fixed

readList :: ReadS [Fixed]

readPrec :: ReadPrec Fixed

readListPrec :: ReadPrec [Fixed]

Show Fixed

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Fixed -> ShowS

show :: Fixed -> String

showList :: [Fixed] -> ShowS

Eq Fixed

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Fixed -> Fixed -> Bool

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

Ord Fixed

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Fixed -> Fixed -> Ordering

(<) :: Fixed -> Fixed -> Bool

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

(>) :: Fixed -> Fixed -> Bool

(>=) :: Fixed -> Fixed -> Bool

max :: Fixed -> Fixed -> Fixed

min :: Fixed -> Fixed -> Fixed

_Fixed :: Name

_Fixed_size :: FieldName

data Map_

Constructors

Map_

Fields

• mapValues :: Schema

Instances

Read Map_

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Map_

readList :: ReadS [Map_]

readPrec :: ReadPrec Map_

readListPrec :: ReadPrec [Map_]

Show Map_

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Map_ -> ShowS

show :: Map_ -> String

showList :: [Map_] -> ShowS

Eq Map_

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Map_ -> Map_ -> Bool

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

Ord Map_

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Map_ -> Map_ -> Ordering

(<) :: Map_ -> Map_ -> Bool

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

(>) :: Map_ -> Map_ -> Bool

(>=) :: Map_ -> Map_ -> Bool

max :: Map_ -> Map_ -> Map_

min :: Map_ -> Map_ -> Map_

_Map :: Name

_Map_values :: FieldName

data Named

Constructors

Named

Fields

• namedName :: String

  a string naming this schema

• namedNamespace :: Maybe String

  a string that qualifies the name

• namedAliases :: Maybe [String]

  a JSON array of strings, providing alternate names for this schema

• namedDoc :: Maybe String

  a JSON string providing documentation to the user of this schema

• namedType :: NamedType
• namedAnnotations :: Map String Value

  Any additional key/value pairs attached to the type

Instances

Read Named

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Named

readList :: ReadS [Named]

readPrec :: ReadPrec Named

readListPrec :: ReadPrec [Named]

Show Named

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Named -> ShowS

show :: Named -> String

showList :: [Named] -> ShowS

Eq Named

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Named -> Named -> Bool

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

Ord Named

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Named -> Named -> Ordering

(<) :: Named -> Named -> Bool

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

(>) :: Named -> Named -> Bool

(>=) :: Named -> Named -> Bool

max :: Named -> Named -> Named

min :: Named -> Named -> Named

_Named :: Name

_Named_name :: FieldName

_Named_namespace :: FieldName

_Named_aliases :: FieldName

_Named_doc :: FieldName

_Named_type :: FieldName

_Named_annotations :: FieldName

data NamedType

Constructors

NamedTypeEnum Enum_

NamedTypeFixed Fixed

NamedTypeRecord Record

Instances

Read NamedType

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS NamedType

readList :: ReadS [NamedType]

readPrec :: ReadPrec NamedType

readListPrec :: ReadPrec [NamedType]

Show NamedType

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> NamedType -> ShowS

show :: NamedType -> String

showList :: [NamedType] -> ShowS

Eq NamedType

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: NamedType -> NamedType -> Bool

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

Ord NamedType

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: NamedType -> NamedType -> Ordering

(<) :: NamedType -> NamedType -> Bool

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

(>) :: NamedType -> NamedType -> Bool

(>=) :: NamedType -> NamedType -> Bool

max :: NamedType -> NamedType -> NamedType

min :: NamedType -> NamedType -> NamedType

_NamedType :: Name

_NamedType_enum :: FieldName

_NamedType_fixed :: FieldName

_NamedType_record :: FieldName

data Order

Constructors

OrderAscending

OrderDescending

OrderIgnore

Instances

Read Order

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Order

readList :: ReadS [Order]

readPrec :: ReadPrec Order

readListPrec :: ReadPrec [Order]

Show Order

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Order -> ShowS

show :: Order -> String

showList :: [Order] -> ShowS

Eq Order

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Order -> Order -> Bool

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

Ord Order

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Order -> Order -> Ordering

(<) :: Order -> Order -> Bool

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

(>) :: Order -> Order -> Bool

(>=) :: Order -> Order -> Bool

max :: Order -> Order -> Order

min :: Order -> Order -> Order

_Order :: Name

_Order_ascending :: FieldName

_Order_descending :: FieldName

_Order_ignore :: FieldName

data Primitive

Constructors

PrimitiveNull

no value

PrimitiveBoolean

A binary value

PrimitiveInt

32-bit signed integer

PrimitiveLong

64-bit signed integer

PrimitiveFloat

single precision (32-bit) IEEE 754 floating-point number

PrimitiveDouble

double precision (64-bit) IEEE 754 floating-point number

PrimitiveBytes

sequence of 8-bit unsigned bytes

PrimitiveString

unicode character sequence

Instances

Read Primitive

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Primitive

readList :: ReadS [Primitive]

readPrec :: ReadPrec Primitive

readListPrec :: ReadPrec [Primitive]

Show Primitive

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Primitive -> ShowS

show :: Primitive -> String

showList :: [Primitive] -> ShowS

Eq Primitive

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Primitive -> Primitive -> Bool

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

Ord Primitive

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Primitive -> Primitive -> Ordering

(<) :: Primitive -> Primitive -> Bool

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

(>) :: Primitive -> Primitive -> Bool

(>=) :: Primitive -> Primitive -> Bool

max :: Primitive -> Primitive -> Primitive

min :: Primitive -> Primitive -> Primitive

_Primitive :: Name

_Primitive_null :: FieldName

_Primitive_boolean :: FieldName

_Primitive_int :: FieldName

_Primitive_long :: FieldName

_Primitive_float :: FieldName

_Primitive_double :: FieldName

_Primitive_bytes :: FieldName

_Primitive_string :: FieldName

data Record

Constructors

Record

Fields

• recordFields :: [Field]

  a JSON array, listing fields

Instances

Read Record

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Record

readList :: ReadS [Record]

readPrec :: ReadPrec Record

readListPrec :: ReadPrec [Record]

Show Record

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

Eq Record

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Record -> Record -> Bool

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

Ord Record

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Record -> Record -> Ordering

(<) :: Record -> Record -> Bool

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

(>) :: Record -> Record -> Bool

(>=) :: Record -> Record -> Bool

max :: Record -> Record -> Record

min :: Record -> Record -> Record

_Record :: Name

_Record_fields :: FieldName

data Schema

Constructors

SchemaArray Array

SchemaMap Map_

SchemaNamed Named

SchemaPrimitive Primitive

SchemaReference String

A reference by name to a previously defined type

SchemaUnion Union

Instances

Read Schema

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Schema

readList :: ReadS [Schema]

readPrec :: ReadPrec Schema

readListPrec :: ReadPrec [Schema]

Show Schema

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Schema -> ShowS

show :: Schema -> String

showList :: [Schema] -> ShowS

Eq Schema

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Schema -> Schema -> Bool

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

Ord Schema

Defined in Hydra.Ext.Avro.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

_Schema :: Name

_Schema_array :: FieldName

_Schema_map :: FieldName

_Schema_named :: FieldName

_Schema_primitive :: FieldName

_Schema_reference :: FieldName

_Schema_union :: FieldName

newtype Union

Constructors

Union

Fields

• unUnion :: [Schema]

Instances

Read Union

Defined in Hydra.Ext.Avro.Schema

Methods

readsPrec :: Int -> ReadS Union

readList :: ReadS [Union]

readPrec :: ReadPrec Union

readListPrec :: ReadPrec [Union]

Show Union

Defined in Hydra.Ext.Avro.Schema

Methods

showsPrec :: Int -> Union -> ShowS

show :: Union -> String

showList :: [Union] -> ShowS

Eq Union

Defined in Hydra.Ext.Avro.Schema

Methods

(==) :: Union -> Union -> Bool

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

Ord Union

Defined in Hydra.Ext.Avro.Schema

Methods

compare :: Union -> Union -> Ordering

(<) :: Union -> Union -> Bool

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

(>) :: Union -> Union -> Bool

(>=) :: Union -> Union -> Bool

max :: Union -> Union -> Union

min :: Union -> Union -> Union

_Union :: Name