Class/Object

com.snowplowanalytics.snowplow.enrich.common.enrichments.registry.sqlquery

SqlQueryEnrichment

Related Docs: object SqlQueryEnrichment | package sqlquery

Permalink

case class SqlQueryEnrichment(inputs: List[Input], db: Db, query: Query, output: Output, cache: Cache) extends Enrichment with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, Enrichment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SqlQueryEnrichment
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Enrichment
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SqlQueryEnrichment(inputs: List[Input], db: Db, query: Query, output: Output, cache: Cache)

    Permalink

Value Members

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

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

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

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

    Permalink
    Definition Classes
    Any
  5. val cache: Cache

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val db: Db

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def filesToCache: List[(URI, String)]

    Permalink

    Gets the list of files the enrichment requires cached locally.

    Gets the list of files the enrichment requires cached locally. The default implementation returns an empty list; if an enrichment requires files, it must override this method.

    returns

    A list of pairs, where the first entry in the pair indicates the (remote) location of the source file and the second indicates the local path where the enrichment expects to find the file.

    Definition Classes
    Enrichment
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def get(intMap: IntMap[ExtractedValue]): ThrowableXor[List[JObject]]

    Permalink

    Get contexts from cache or perform query if nothing found and put result into cache

    Get contexts from cache or perform query if nothing found and put result into cache

    intMap

    IntMap of extracted values

    returns

    validated list of Self-describing contexts

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getPlaceholderCount: ValidationNel[String, Int]

    Permalink

    If lastPlaceholderCount is successful return it If it's unsucessfult - try to count save result for future use

  14. val inputs: List[Input]

    Permalink
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def lookup(event: EnrichedEvent, derivedContexts: List[JObject], customContexts: JsonSchemaPairs, unstructEvent: JsonSchemaPairs): ValidationNel[String, List[JObject]]

    Permalink

    Primary function of the enrichment Failure means connection failure, failed unexpected JSON-value, etc Successful Nil skipped lookup (unfilled placeholder for eg, empty response)

    Primary function of the enrichment Failure means connection failure, failed unexpected JSON-value, etc Successful Nil skipped lookup (unfilled placeholder for eg, empty response)

    event

    currently enriching event

    derivedContexts

    derived contexts as list of JSON objects

    customContexts

    custom contexts as JsonSchemaPairs

    unstructEvent

    unstructured (self-describing) event as empty or single element JsonSchemaPairs

    returns

    Nil if some inputs were missing, validated JSON contexts if lookup performed

  17. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  20. val output: Output

    Permalink
  21. def query(intMap: IntMap[ExtractedValue]): ThrowableXor[List[JObject]]

    Permalink

    Perform SQL query and convert result to JSON object

    Perform SQL query and convert result to JSON object

    intMap

    map with values extracted from inputs and ready to be set placeholders in prepared statement

    returns

    validated list of Self-describing contexts

  22. val query: Query

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

    Permalink
    Definition Classes
    AnyRef
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Enrichment

Inherited from AnyRef

Inherited from Any

Ungrouped