Packages

trait HiveEnv extends BaseEnv

Environment which provides databases. By default, there will be a single database of the form {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 database name as we assume it will always be master

e.g. dev_my_project_feature_abc, prod_my_project

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

Abstract Value Members

  1. abstract def baseDatabaseLocation: String

    Base database location (individual databases locations will be baseDatabaseLocation/database_name)

  2. 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

    Definition Classes
    BaseEnv
  3. abstract def environment: String

    The name of the logical environment (e.g.

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

    Definition Classes
    BaseEnv
  4. abstract def project: String

    The name of the project/application

    The name of the project/application

    Definition Classes
    BaseEnv
  5. abstract def uri: String

    The uri for the base path

    The uri for the base path

    Definition Classes
    BaseEnv

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. def allDBs: Seq[String]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def baseDBName: String

    Base database name of the form {environment}_{project}_{branch} where environment is the logical environment (e.g.

    Base database name of the form {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 database name as we assume it will always be master

    e.g. dev_my_project_feature_abc, prod_my_project

  7. 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

    Definition Classes
    BaseEnv
  8. def cleanup(sparkSession: SparkSession): Unit

    Cleans up the environment

    Cleans up the environment

    sparkSession

    the SparkSession

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

    Creates the environment

    Creates the environment

    sparkSession

    the SparkSession

    Definition Classes
    HiveEnv → BaseEnv → Env
  11. def createBaseDB: Boolean

    Whether to create the base database.

    Whether to create the base database. If false, only the extraDBs will be created.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def extraDBs: Seq[String]

    Any extra databases to be created in addition to or instead of the base database

  15. def extraDBsNormalised: Seq[String]
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    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. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  21. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. 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
  34. def normalisedBranch: String
    Definition Classes
    BaseEnv
  35. def normalisedEnvironment: String
    Definition Classes
    BaseEnv
  36. def normalisedProject: String
    Definition Classes
    BaseEnv
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. 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
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from BaseEnv

Inherited from Env

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped