com.at.avro.config

Class AvroConfig

java.lang.Object

com.at.avro.config.AvroConfig

public class AvroConfig
extends Object

Configuration that allows avro model tweaking. Model is then used to generate schemas.

Author:

artur@callfire.com

Constructor Summary

Constructors

Constructor and Description
AvroConfig(String namespace)

Method Summary

Modifier and Type	Method and Description
java.util.function.BiConsumer<AvroSchema,schemacrawler.schema.Table>	getAvroSchemaPostProcessor()
Class<?>	getDateTypeClass()
Class<?>	getDecimalTypeClass()
java.util.function.Function<String,String>	getFieldNameMapper()
String	getNamespace()
java.util.function.Function<String,String>	getSchemaNameMapper()
java.util.function.Function<String,String>	getUnknownTypeResolver()
boolean	isAllFieldsDefaultNull()
boolean	isNullableTrueByDefault()
boolean	isUseSqlCommentsAsDoc()
boolean	representEnumsAsStrings()
AvroConfig	setAllFieldsDefaultNull(boolean allFieldsDefaultNull) Set to true to make all fields default to null.
AvroConfig	setAvroSchemaPostProcessor(java.util.function.BiConsumer<AvroSchema,schemacrawler.schema.Table> avroSchemaPostProcessor) Set a callback that will be called after avro model was built.
AvroConfig	setDateTypeClass(Class<?> dateTypeClass) Sets a "java-class" property in this fields definition.
AvroConfig	setDecimalTypeClass(Class<?> decimalTypeClass) Sets a "java-class" property in this fields definition.
AvroConfig	setFieldNameMapper(java.util.function.Function<String,String> fieldNameMapper) Provide custom field names resolver function which takes DB column name as an input.
AvroConfig	setNullableTrueByDefault(boolean nullableTrueByDefault) Set to true to make all fields nullable in avro schema.
AvroConfig	setRepresentEnumsAsStrings(boolean representEnumsAsStrings) Resolve 'enum' type to 'string' instead of 'enum'.
AvroConfig	setSchemaNameMapper(java.util.function.Function<String,String> schemaNameMapper) Provide custom schema name resolver function which takes DB table name as an input.
AvroConfig	setUnknownTypeResolver(java.util.function.Function<String,String> unknownTypeResolver) Provide mapper for unknown db types.
AvroConfig	setUseSqlCommentsAsDoc(boolean useSqlCommentsAsDoc) Set to true to use SQL comments at table and field level as optional avro doc fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AvroConfig

public AvroConfig(String namespace)

Method Detail

setSchemaNameMapper

public AvroConfig setSchemaNameMapper(java.util.function.Function<String,String> schemaNameMapper)

Provide custom schema name resolver function which takes DB table name as an input. Table name is used by default.

getSchemaNameMapper

public java.util.function.Function<String,String> getSchemaNameMapper()

setFieldNameMapper

public AvroConfig setFieldNameMapper(java.util.function.Function<String,String> fieldNameMapper)

Provide custom field names resolver function which takes DB column name as an input. Column name is used by default.

getFieldNameMapper

public java.util.function.Function<String,String> getFieldNameMapper()

setRepresentEnumsAsStrings

public AvroConfig setRepresentEnumsAsStrings(boolean representEnumsAsStrings)

Resolve 'enum' type to 'string' instead of 'enum'.

representEnumsAsStrings

public boolean representEnumsAsStrings()

setAllFieldsDefaultNull

public AvroConfig setAllFieldsDefaultNull(boolean allFieldsDefaultNull)

Set to true to make all fields default to null. DB column definition is used by default.

isAllFieldsDefaultNull

public boolean isAllFieldsDefaultNull()

getNamespace

public String getNamespace()

setNullableTrueByDefault

public AvroConfig setNullableTrueByDefault(boolean nullableTrueByDefault)

Set to true to make all fields nullable in avro schema. DB column definition is used by default.

isNullableTrueByDefault

public boolean isNullableTrueByDefault()

setDateTypeClass

public AvroConfig setDateTypeClass(Class<?> dateTypeClass)

Sets a "java-class" property in this fields definition. This might be used by avro java code generator to use the class you want for dates.

getDateTypeClass

public Class<?> getDateTypeClass()

setDecimalTypeClass

public AvroConfig setDecimalTypeClass(Class<?> decimalTypeClass)

Sets a "java-class" property in this fields definition. This might be used by avro java code generator to use the class you want for decimals.

getDecimalTypeClass

public Class<?> getDecimalTypeClass()

setUnknownTypeResolver

public AvroConfig setUnknownTypeResolver(java.util.function.Function<String,String> unknownTypeResolver)

Provide mapper for unknown db types. Throws IllegalArgumentException by default. For example, if you want to default all unknown types to string: avroConfig.setUnknownTypeResolver(type -> "string") IllegalArgumentException is thrown by default.

getUnknownTypeResolver

public java.util.function.Function<String,String> getUnknownTypeResolver()

setAvroSchemaPostProcessor

public AvroConfig setAvroSchemaPostProcessor(java.util.function.BiConsumer<AvroSchema,schemacrawler.schema.Table> avroSchemaPostProcessor)

Set a callback that will be called after avro model was built. Schema model is ready by this point, but you can still modify it by adding custom properties.

getAvroSchemaPostProcessor

public java.util.function.BiConsumer<AvroSchema,schemacrawler.schema.Table> getAvroSchemaPostProcessor()

setUseSqlCommentsAsDoc

public AvroConfig setUseSqlCommentsAsDoc(boolean useSqlCommentsAsDoc)

Set to true to use SQL comments at table and field level as optional avro doc fields.

isUseSqlCommentsAsDoc

public boolean isUseSqlCommentsAsDoc()