com.twitter.scalding.filecache

DistributedCacheFile

object DistributedCacheFile

The distributed cache is simply hadoop's method for allowing each node local access to a specific file. The registration of that file must be called with the Configuration of the job, and not when it's on a mapper or reducer. Additionally, a unique name for the node-local access path must be used to prevent collisions in the cluster. This class provides this functionality.

In the configuration phase, the file URI is used to construct an UncachedFile instance. The name of the symlink to use on the mappers is only available after calling the add() method, which registers the file and computes the unique symlink name and returns a CachedFile instance. The CachedFile instance is Serializable, it's designed to be assigned to a val and accessed later.

The local symlink is available thorugh .file or .path depending on what type you need.

example:

class YourJob(args: Args) extends Job(args) {
val theCachedFile = DistributedCacheFile("hdfs://ur-namenode/path/to/your/file.txt")

def somethingThatUsesTheCachedFile() {
  doSomethingWith(theCachedFile.path) // or theCachedFile.file
}
}
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DistributedCacheFile
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def apply(path: String)(implicit mode: Mode): CachedFile

  7. def apply(uri: URI)(implicit mode: Mode): CachedFile

    Create an object that can be used to register a given URI (representing an hdfs file) that should be added to the DistributedCache.

    Create an object that can be used to register a given URI (representing an hdfs file) that should be added to the DistributedCache.

    uri

    The fully qualified URI that points to the hdfs file to add

    returns

    A CachedFile instance

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. def symlinkNameFor(uri: URI): String

  20. def symlinkedUriFor(sourceUri: URI): URI

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  22. def toString(): String

    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped