Package org.apache.druid.catalog.model.table

Class InputFormats.JsonFormatDefn

java.lang.Object

org.apache.druid.catalog.model.table.InputFormats.BaseFormatDefn

org.apache.druid.catalog.model.table.InputFormats.JsonFormatDefn

All Implemented Interfaces:

InputFormatDefn

Enclosing class:

InputFormats

public static class InputFormats.JsonFormatDefn
extends InputFormats.BaseFormatDefn

JSON format definition. For now, we only expose the "keep nulls" attribute via a table function argument. We can easily add more later as the JSON format evolves.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_KEY

Constructor Summary

Constructors

Constructor	Description
JsonFormatDefn()

Method Summary

Modifier and Type	Method	Description
org.apache.druid.data.input.InputFormat	convertFromArgs(Map<String,Object> args, List<ColumnSpec> columns, com.fasterxml.jackson.databind.ObjectMapper jsonMapper)	Create an input format instance from the values provided as arguments that correspond to the defined parameters.
protected Class<? extends org.apache.druid.data.input.InputFormat>	inputFormatClass()	The target input format class for Jackson conversions.
String	typeValue()

Methods inherited from class org.apache.druid.catalog.model.table.InputFormats.BaseFormatDefn

convert, convertColumns, convertFromTable, parameters, validate

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_KEY

public static final String TYPE_KEY

See Also:

Constant Field Values

Constructor Detail

JsonFormatDefn

public JsonFormatDefn()

Method Detail

typeValue

public String typeValue()

Returns:

the string used to identify the input format type in the serialized JSON for the input format. This is also the value used in the format property for SQL functions.

inputFormatClass

protected Class<? extends org.apache.druid.data.input.InputFormat> inputFormatClass()

Description copied from class: InputFormats.BaseFormatDefn

The target input format class for Jackson conversions.

Specified by:

inputFormatClass in class InputFormats.BaseFormatDefn

convertFromArgs

public org.apache.druid.data.input.InputFormat convertFromArgs(Map<String,Object> args,
                                                               List<ColumnSpec> columns,
                                                               com.fasterxml.jackson.databind.ObjectMapper jsonMapper)

Description copied from interface: InputFormatDefn

Create an input format instance from the values provided as arguments that correspond to the defined parameters. The map provided is guaranteed to have a value for each parameter defined as non-optional, and those values will be of the type defined in the parameter. The map will also contain values for the input source: the format should ignore values that don't correspond to parameters it defined.

Parameters:

args - the actual arguments for the defined parameters

columns - the columns provided in SQL, typically via the `EXTEND` clause, but perhaps from an the table spec, if the function is for a partial table

jsonMapper - the mapper to use to perform conversions

Returns:

an input format as defined by the arguments