Packages

trait BaseEnv extends Env

Environment which provides a base path into which the application can write its data Unless overridden, paths will be of the form {uri}/data/{environment}/{project}/{branch} where environment is the logical environment (e.g. dev, test), project is the name of the application and branch is the Git branch

N.B when environment is 'prod', the branch is omitted from the path as we assume it will always be master

e.g. hdfs:///data/dev/my_project/feature_abc, hdfs:///data/prod/my_project

Linear Supertypes
Env, Logging, AnyRef, Any
Known Subclasses
HiveEnv
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseEnv
  2. Env
  3. Logging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def branch: String

    The name of the Git branch (or some other identifier of the feature being developed)

    The name of the Git branch (or some other identifier of the feature being developed)

    N.B by default, this will not be used when the environment is prod

  2. abstract def environment: String

    The name of the logical environment (e.g.

    The name of the logical environment (e.g. dev, prod)

  3. abstract def project: String

    The name of the project/application

  4. abstract def uri: String

    The uri for the base path

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def basePath: String

    Base path into which the application can write its data Unless overridden, paths will be of the form {uri}/data/{environment}/{project}/{branch} where environment is the logical environment (e.g.

    Base path into which the application can write its data Unless overridden, paths will be of the form {uri}/data/{environment}/{project}/{branch} where environment is the logical environment (e.g. dev, test), project is the name of the application and branch is the Git branch

    N.B when environment is 'prod', the branch is omitted from the path as we assume it will always be master

    e.g. hdfs:///data/dev/my_project/feature_abc, hdfs:///data/prod/my_project

  6. def cleanup(sparkSession: SparkSession): Unit

    Cleans up the environment

    Cleans up the environment

    sparkSession

    the SparkSession

    Definition Classes
    BaseEnv → Env
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def create(sparkSession: SparkSession): Unit

    Creates the environment

    Creates the environment

    sparkSession

    the SparkSession

    Definition Classes
    BaseEnv → Env
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    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. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  16. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  17. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  19. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  20. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  21. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  23. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def normaliseName(name: String): String

    Replace any special characters in the given string with underscores

    Replace any special characters in the given string with underscores

    name

    the name potentially containing special characters

    returns

    the name with special characters replaced with underscores

    Definition Classes
    Env
  29. def normalisedBranch: String
  30. def normalisedEnvironment: String
  31. def normalisedProject: String
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def tmpDir: String

    Directory in which to write temporary files

    Directory in which to write temporary files

    returns

    the temporary directory

    Definition Classes
    BaseEnv → Env
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Env

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped