Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package spotify
    Definition Classes
    com
  • package scio
    Definition Classes
    spotify
  • package extra
    Definition Classes
    scio
  • package csv

    Main package for CSV type-safe APIs.

    Main package for CSV type-safe APIs. Import all.

    import com.spotify.scio.extra.csv._
    Definition Classes
    extra
  • object CsvIO

    This package uses a CSV mapper called Kantan.

    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)
    Definition Classes
    csv
  • Read
  • ReadParam
  • ReadWrite
  • Write
  • WriteParam

object WriteParam extends Serializable

Source
CsvIO.scala
Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteParam
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 DefaultCompression: Compression
  5. val DefaultCsvConfig: CsvConfiguration
  6. val DefaultFilenamePolicySupplier: Null
  7. val DefaultNumShards: Int
  8. val DefaultPrefix: String
  9. val DefaultShardNameTemplate: String
  10. val DefaultSuffix: String
  11. val DefaultTempDirectory: String
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped