Derives Avro from a given schema file. Generates data types, FromAvro and ToAvro instances.

Describes the strictness of a field for a derived data type. The field will be derived as if it were written with a !.

Describes the representation of a field for a derived data type. The field will be derived as if it were written with an {--} pragma.

How to treat Avro namespaces in the generated Haskell types.

Default deriving options

defaultDeriveOptions = DeriveOptions
  { fieldNameBuilder  = mkPrefixedFieldName
  , fieldStrictness   = mkLazyField
  , namespaceBehavior = IgnoreNamespaces
  }

Generates a field name that is prefixed with the type name.

For example, if the schema defines type Person that has a field firstName, then the generated Haskell type will be like

Person { personFirstName :: Text }

Generates a field name that matches the field name in schema (sanitised for Haskell, so first letter is lower cased)

For example, if the schema defines type Person that has a field firstName, then the generated Haskell type will be like

Person { firstName :: Text }

You may want to enable DuplicateRecordFields if you want to use this method.

Marks any field as non-strict in the generated data types.

Make a field strict and unpacked if it has a primitive representation. Primitive types are types which GHC has either a static or an unlifted representation: `()`, Boolean, Int32, Int64, Schema, Schema.

Generates the value of type Schema that it can later be used with deriveAvro' or deriveAvroWithOptions'.

mySchema :: Schema
mySchema = $(makeSchema "schemas/my-schema.avsc")

Derives Haskell types from the given Avro schema file. These Haskell types support both reading and writing to Avro.

For an Avro schema with a top-level record called com.example.Foo, this generates:

• a Schema with the name schema'Foo or schemacom'exampleFoo, depending on the namespaceBehavior setting.
• Haskell types for each named type defined in the schema
• HasSchema instances for each type
• FromAvro instances for each type
• ToAvro instances for each type

This function ignores namespaces when generated Haskell type and field names. This will fail on valid Avro schemas which contain types with the same base name in different namespaces. It will also fail for schemas that contain types with base names that are the same except for the capitalization of the first letter.

The type com.example.Foo will generate a Haskell type Foo. If com.example.Foo has a field named Bar, the field in the Haskell record will be called fooBar.

Derive Haskell types from the given Avro schema.

For an Avro schema with a top-level definition com.example.Foo, this generates:

• a Schema with the name schema'Foo or schemacom'exampleFoo depending on namespace handling
• Haskell types for each named type defined in the schema
• HasSchema instances for each type
• FromAvro instances for each type
• ToAvro instances for each type

Derives "read only" Avro from a given schema file. For a schema with a top-level definition com.example.Foo, this generates:

• a Schema value with the name schema'Foo
• Haskell types for each named type defined in the schema
• HasSchema instances for each type
• FromAvro instances for each type

Same as deriveAvro but takes a ByteString rather than FilePath

Same as deriveAvroWithOptions but uses defaultDeriveOptions

deriveAvro = deriveAvroWithOptions defaultDeriveOptions

Same as deriveAvroWithOptions' but uses defaultDeriveOptions

deriveAvro' = deriveAvroWithOptions' defaultDeriveOptions

Same as deriveFromAvroWithOptions but uses defaultDeriveOptions.

deriveFromAvro = deriveFromAvroWithOptions defaultDeriveOptions