Trait

com.twitter.summingbird

KeyedProducer

Related Doc: package summingbird

Permalink

sealed trait KeyedProducer[P <: Platform[P], K, V] extends Producer[P, (K, V)]

This has the methods on Key-Value streams. The rule is: if you can easily express your logic on the keys and values independently, do it! This is how you communicate structure to Summingbird and it uses these hints to attempt the most efficient run of your code.

Linear Supertypes
Producer[P, (K, V)], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. KeyedProducer
  2. Producer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++[U >: (K, V)](r: Producer[P, U]): Producer[P, U]

    Permalink

    Exactly the same as merge.

    Exactly the same as merge. Here by analogy with the scala.collections API

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

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[U](fn: PartialFunction[(K, V), U]): Producer[P, U]

    Permalink

    Prefer to flatMap for transforming a subset of items like optionMap but convenient with case syntax in scala prod.collect { case x if fn(x) => g(x) }

    Prefer to flatMap for transforming a subset of items like optionMap but convenient with case syntax in scala prod.collect { case x if fn(x) => g(x) }

    Definition Classes
    Producer
  8. def collectKeys[K2](pf: PartialFunction[K, K2]): KeyedProducer[P, K2, V]

    Permalink

    Builds a new KeyedProvider by applying a partial function to keys of elements of this one on which the function is defined.

  9. def collectValues[V2](pf: PartialFunction[V, V2]): KeyedProducer[P, K, V2]

    Permalink

    Builds a new KeyedProvider by applying a partial function to values of elements of this one on which the function is defined.

  10. def either[U](other: Producer[P, U]): Producer[P, Either[(K, V), U]]

    Permalink

    Merge a different type of Producer into a single stream

    Merge a different type of Producer into a single stream

    Definition Classes
    Producer
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def filter(fn: ((K, V)) ⇒ Boolean): Producer[P, (K, V)]

    Permalink

    Keep only the items that satisfy the fn

    Keep only the items that satisfy the fn

    Definition Classes
    Producer
  14. def filterKeys(pred: (K) ⇒ Boolean): KeyedProducer[P, K, V]

    Permalink

    Prefer this to filter or flatMap/flatMapKeys if you are filtering.

    Prefer this to filter or flatMap/flatMapKeys if you are filtering. This may be optimized in the future with an intrinsic node in the Producer graph. We know this never increases the number of items, and we know it does not rekey the partition.

  15. def filterValues(pred: (V) ⇒ Boolean): KeyedProducer[P, K, V]

    Permalink

    Prefer this to filter or flatMap/flatMapValues if you are filtering.

    Prefer this to filter or flatMap/flatMapValues if you are filtering. This may be optimized in the future with an intrinsic node in the Producer graph. We know this never increases the number of items, and we know it does not rekey the partition.

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def flatMap[U](fn: ((K, V)) ⇒ TraversableOnce[U]): Producer[P, U]

    Permalink

    Only use this function if you may return more than 1 item sometimes.

    Only use this function if you may return more than 1 item sometimes. otherwise use collect or optionMap, which can be pushed up the graph

    Definition Classes
    Producer
  18. def flatMapKeys[K2](fn: (K) ⇒ TraversableOnce[K2]): KeyedProducer[P, K2, V]

    Permalink

    Prefer to call this method to flatMap if you are expanding only keys.

    Prefer to call this method to flatMap if you are expanding only keys. It may trigger optimizations, that can significantly improve performance

  19. def flatMapValues[U](fn: (V) ⇒ TraversableOnce[U]): KeyedProducer[P, K, U]

    Permalink

    Prefer this to a raw map as this may be optimized to avoid a key reshuffle

  20. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  23. def keys: Producer[P, K]

    Permalink

    Return just the keys

  24. def leftJoin[RightV](stream: KeyedProducer[P, K, RightV], buffer: leftJoin.buffer._15.type.Service[K, RightV] with leftJoin.buffer._15.type.Sink[(K, RightV)] forSome {val _15: P}): KeyedProducer[P, K, (V, Option[RightV])]

    Permalink

    Do a windowed join on a stream.

    Do a windowed join on a stream. You need to provide a sink that manages the buffer. Offline, this might be a bounded HDFS partition. Online it might be a cache that evicts after a period of time.

  25. def leftJoin[RightV](service: P.Service[K, RightV]): KeyedProducer[P, K, (V, Option[RightV])]

    Permalink

    Do a lookup/join on a service.

    Do a lookup/join on a service. This is how you trigger async computation is summingbird. Any remote API call, DB lookup, etc... happens here

  26. def lookup[U >: (K, V), V](service: P.Service[U, V]): KeyedProducer[P, U, Option[V]]

    Permalink

    This is identical to a certain leftJoin: map((_, ())).leftJoin(srv).mapValues{case (_, v) => v} Useful when you are looking up values from say a stream of inputs, such as IDs.

    This is identical to a certain leftJoin: map((_, ())).leftJoin(srv).mapValues{case (_, v) => v} Useful when you are looking up values from say a stream of inputs, such as IDs.

    Definition Classes
    Producer
  27. def map[U](fn: ((K, V)) ⇒ U): Producer[P, U]

    Permalink

    Map each item to a new value

    Map each item to a new value

    Definition Classes
    Producer
  28. def mapKeys[K2](fn: (K) ⇒ K2): KeyedProducer[P, K2, V]

    Permalink

    Prefer to call this method to flatMap/map if you are mapping only keys.

    Prefer to call this method to flatMap/map if you are mapping only keys. It may trigger optimizations, that can significantly improve performance

  29. def mapValues[U](fn: (V) ⇒ U): KeyedProducer[P, K, U]

    Permalink

    Prefer this to a raw map as this may be optimized to avoid a key reshuffle

  30. def merge[U >: (K, V)](r: Producer[P, U]): Producer[P, U]

    Permalink

    Combine the output into one Producer

    Combine the output into one Producer

    Definition Classes
    Producer
  31. def name(id: String): Producer[P, (K, V)]

    Permalink

    Naming a node is so that you may give Options for that node that may change the run-time performance of the job (parameter tuning, etc...)

    Naming a node is so that you may give Options for that node that may change the run-time performance of the job (parameter tuning, etc...)

    Definition Classes
    Producer
  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. def optionMap[U](fn: ((K, V)) ⇒ Option[U]): Producer[P, U]

    Permalink

    Prefer this or collect to flatMap if you are always emitting 0 or 1 items

    Prefer this or collect to flatMap if you are always emitting 0 or 1 items

    Definition Classes
    Producer
  36. def sumByKey(store: P.Store[K, V])(implicit semigroup: Semigroup[V]): Summer[P, K, V]

    Permalink

    emits a KeyedProducer with a value that is the store value, just BEFORE a merge, and the right is a new delta (which may include, depending on the Platform, Store and Options, more than a single aggregated item).

    emits a KeyedProducer with a value that is the store value, just BEFORE a merge, and the right is a new delta (which may include, depending on the Platform, Store and Options, more than a single aggregated item).

    so, the sequence out of this has the property that: (v0, vdelta1), (v0 + vdelta1, vdelta2), (v0 + vdelta1 + vdelta2, vdelta3), ...

  37. def swap: KeyedProducer[P, V, K]

    Permalink

    Exchange values for keys

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

    Permalink
    Definition Classes
    AnyRef
  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  40. def values: Producer[P, V]

    Permalink

    Keep only the values

  41. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def write[U >: (K, V)](sink: P.Sink[U]): TailProducer[P, (K, V)]

    Permalink

    Cause some side effect on the sink, but pass through the values so they can be consumed downstream

    Cause some side effect on the sink, but pass through the values so they can be consumed downstream

    Definition Classes
    Producer

Inherited from Producer[P, (K, V)]

Inherited from AnyRef

Inherited from Any

Ungrouped