Package io.delta.kernel.engine

Interface JsonHandler

@Evolving public interface JsonHandler
Provides JSON handling functionality to Delta Kernel. Delta Kernel can use this client to parse JSON strings into ColumnarBatch or read content from JSON files. Connectors can leverage this interface to provide their best implementation of the JSON parsing capability to Delta Kernel.
Since:
3.0.0

  • Method Details

    • parseJson

      ColumnarBatch parseJson(ColumnVector jsonStringVector, StructType outputSchema, Optional<ColumnVector> selectionVector)
      Parse the given json strings and return the fields requested by outputSchema as columns in a ColumnarBatch.

      There are a couple special cases that should be handled for specific data types:

      • FloatType and DoubleType: handle non-numeric numbers encoded as strings
        • NaN: "NaN"
        • Positive infinity: "+INF", "Infinity", "+Infinity"
        • Negative infinity: "-INF", "-Infinity""
      • DateType: handle dates encoded as strings in the format "yyyy-MM-dd"
      • TimestampType: handle timestamps encoded as strings in the format "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
      Parameters:
      jsonStringVector - String ColumnVector of valid JSON strings.
      outputSchema - Schema of the data to return from the parsed JSON. If any requested fields are missing in the JSON string, a null is returned for that particular field in the returned Row. The type for each given field is expected to match the type in the JSON.
      selectionVector - Optional selection vector indicating which rows to parse the JSON. If present, only the selected rows should be parsed. Unselected rows should be all null in the returned batch.
      Returns:
      a ColumnarBatch of schema outputSchema with one row for each entry in jsonStringVector

    • deserializeStructType

      StructType deserializeStructType(String structTypeJson)
      Deserialize the Delta schema from structTypeJson according to the Delta Protocol schema serialization rules .
      Parameters:
      structTypeJson - the JSON formatted schema string to parse
      Returns:
      the parsed StructType

    • readJsonFiles

      CloseableIterator<ColumnarBatch> readJsonFiles(CloseableIterator<FileStatus> fileIter, StructType physicalSchema, Optional<Predicate> predicate) throws IOException
      Read and parse the JSON format file at given locations and return the data as a ColumnarBatch with the columns requested by physicalSchema.
      Parameters:
      fileIter - Iterator of files to read data from.
      physicalSchema - Select list of columns to read from the JSON file.
      predicate - Optional predicate which the JSON reader can optionally use to prune rows that don't satisfy the predicate. Because pruning is optional and may be incomplete, caller is still responsible apply the predicate on the data returned by this method.
      Returns:
      an iterator of ColumnarBatchs containing the data in columnar format. It is the responsibility of the caller to close the iterator. The data returned is in the same as the order of files given in scanFileIter
      Throws:
      IOException - if an I/O error occurs during the read.

    • writeJsonFileAtomically

      void writeJsonFileAtomically(String filePath, CloseableIterator<Row> data, boolean overwrite) throws IOException
      Serialize each Row in the iterator as JSON and write as a separate line in destination file. This call either succeeds in creating the file with given contents or no file is created at all. It won't leave behind a partially written file.

      Following are the supported data types and their serialization rules. At a high-level, the JSON serialization is similar to that of jackson JSON serializer.

      • Primitive types: @code boolean, byte, short, int, long, float, double, string}
      • struct: any element whose value is null is not written to file
      • map: only a map with string key type is supported. If an entry value is null, it should be written to the file.
      • array: null value elements are written to file
      Parameters:
      filePath - Fully qualified destination file path
      data - Iterator of Row objects where each row should be serialized as JSON and written as separate line in the destination file.
      overwrite - If true, the file is overwritten if it already exists. If false and a file exists FileAlreadyExistsException is thrown.
      Throws:
      FileAlreadyExistsException - if the file already exists and overwrite is false.
      IOException - if any other I/O error occurs.