Packages

object CsvIO

This package uses a CSV mapper called Kantan.

import the following:

import kantan.csv._
import com.spotify.scio.extra.csv._

Reading

with a header

Kantan docs

case class User(name: String, age: Int)
implicit val decoder = HeaderDecoder.decoder("fullName", "userAge")(User.apply _)
val users: SCollection[User] = scioContext.csvFile(path)

without a header

Kantan docs

case class User(name: String, age: Int)
implicit val decoder = RowDecoder.ordered { (name: String, age: Int) => User(name, age) }
val csvConfiguration = CsvIO.ReadParam(csvConfiguration = CsvIO.DefaultCsvConfiguration.withoutHeader)
val users: SCollection[User] = scioContext.csvFile(path, csvConfiguration)

Writing

with a header

Kantan docs

case class User(name: String, age: Int)
implicit val encoder = HeaderEncoder.caseEncoder("fullName", "age")(User.unapply)

val users: SCollection[User] = ???
users.saveAsCsvFile(path)

without a header

Kantan docs

case class User(name: String, age: Int)
implicit val encoder = RowEncoder.encoder(0, 1)((u: User) => (u.name, u.age))

val users: SCollection[User] = ???
users.saveAsCsvFile(path)
Source
CsvIO.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CsvIO
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Read[T](path: String)(implicit evidence$1: HeaderDecoder[T], evidence$2: Coder[T]) extends ScioIO[T] with Product with Serializable
  2. final case class ReadParam extends Product with Serializable
  3. final case class ReadWrite[T](path: String)(implicit evidence$4: HeaderCodec[T], evidence$5: Coder[T]) extends ScioIO[T] with Product with Serializable
  4. final case class Write[T](path: String)(implicit evidence$3: HeaderEncoder[T]) extends ScioIO[T] with Product with Serializable
  5. final case class WriteParam extends Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DefaultCsvConfiguration: CsvConfiguration
  5. val DefaultReadParams: ReadParam
  6. val DefaultWriteParams: WriteParam
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. object ReadParam extends Serializable
  24. object WriteParam extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped