json-2-csv

License	MIT
Categories	CSV Data Data Formats JSON
GroupId	com.github.agourlay
ArtifactId	json-2-csv_2.11
Last Version	0.3.0
Release Date	Jul 28, 2017
Type	jar
Description	json-2-csv json-2-csv
Project URL	https://github.com/agourlay/json-2-csv
Project Organization	com.github.agourlay
Source Code Management	https://github.com/agourlay/json-2-csv.git

Download json-2-csv_2.11

Filename	Size
json-2-csv_2.11-0.3.0.pom
json-2-csv_2.11-0.3.0.jar	50 KB
json-2-csv_2.11-0.3.0-sources.jar	3 KB
json-2-csv_2.11-0.3.0-javadoc.jar	361 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.agourlay/json-2-csv_2.11/ -->
<dependency>
    <groupId>com.github.agourlay</groupId>
    <artifactId>json-2-csv_2.11</artifactId>
    <version>0.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.agourlay/json-2-csv_2.11/
implementation 'com.github.agourlay:json-2-csv_2.11:0.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.agourlay/json-2-csv_2.11/
implementation ("com.github.agourlay:json-2-csv_2.11:0.3.0")

Apache Buildr

'com.github.agourlay:json-2-csv_2.11:jar:0.3.0'

Apache Ivy

<dependency org="com.github.agourlay" name="json-2-csv_2.11" rev="0.3.0">
  <artifact name="json-2-csv_2.11" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.agourlay', module='json-2-csv_2.11', version='0.3.0')
)

Scala SBT

libraryDependencies += "com.github.agourlay" % "json-2-csv_2.11" % "0.3.0"

Leiningen

[com.github.agourlay/json-2-csv_2.11 "0.3.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.11.11
org.spire-math : jawn-ast_2.11	jar	0.11.0
com.github.tototoshi : scala-csv_2.11	jar	1.3.4

test (2)

Group / Artifact	Type	Version
commons-io : commons-io	jar	2.5
org.scalatest : scalatest_2.11	jar	3.0.3

Project Modules

There are no modules declared in this project.

json-2-csv

A library transforming JSON collections into CSV files.

Features

• ingests JSON collections from a File or from a LazyList[String].
• turns nested JSON objects into extra CSV columns and lines.
• works in a streaming fashion with a small memory footprint.

Limitations

• the JSON objects in the collection level must share a common structure.
• the first element should be a complete definition of the structure, the following elements can be sparse.
• the transformation stops at the first error encountered.

Input & output formats

A file containing a JSON collection like this is transformed into a CSV file like that.

When nested objects are turned into extra columns the content of the parent object is not repeated.

APIs

Two methods on the Json2Csv object returning an Either of the number of CSV lines written to the OutputStream:

def convert(file: File, resultOutputStream: OutputStream): Either[Exception, Long]

def convert(chunks: ⇒ LazyList[String], resultOutputStream: OutputStream): Either[Exception, Long]

Usage example

object Boot {
  def main(args: Array[String]): Unit = {
    if (args.isEmpty) println("Error - Provide the CSV file path as argument ")
    else {
      val output = new FileOutputStream("result-json.csv")
      Json2Csv.convert(new File(args(0)), output) match {
        case Right(nb) => println(s"$nb CSV lines written to 'result-json.csv'")
        case Left(e)  => println(s"Something bad happened $e")
      }
    }
  }
}

Installation

libraryDependencies ++= Seq(
  "com.github.agourlay" %% "json-2-csv" % "0.5.4",
  ...
)

License

This code is open source software licensed under the MIT License.

Versions

Version
0.3.0 Jul 28, 2017
0.2.3 Jul 4, 2017