Packages

case class TestAppConfig(baseDatadir: Path, configOverrides: Vector[Config])(implicit ec: ExecutionContext) extends DbAppConfig with TestDbManagement with JdbcProfileComponent[TestAppConfig] with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TestAppConfig
  2. Serializable
  3. Product
  4. Equals
  5. JdbcProfileComponent
  6. TestDbManagement
  7. DbManagement
  8. DbAppConfig
  9. AppConfig
  10. BitcoinSLogger
  11. StartStopAsync
  12. StartStop
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TestAppConfig(baseDatadir: Path, configOverrides: Vector[Config])(implicit ec: ExecutionContext)

Type Members

  1. type ConfigType = TestAppConfig

    Sub members of AppConfig should override this type with the type of themselves, ensuring withOverrides return the correct type

    Sub members of AppConfig should override this type with the type of themselves, ensuring withOverrides return the correct type

    Attributes
    protected[bitcoins]
    Definition Classes
    TestAppConfigAppConfig

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. lazy val allTables: List[slick.jdbc.JdbcProfile.JdbcAPI.TableQuery[slick.jdbc.JdbcProfile.JdbcAPI.Table[_]]]
    Definition Classes
    TestDbManagementDbManagement
  5. def appConfig: TestAppConfig
    Definition Classes
    TestAppConfigJdbcProfileComponent
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val baseDatadir: Path

    The base data directory.

    The base data directory. This is where we look for a configuration file

    Definition Classes
    TestAppConfigAppConfig
  8. lazy val chain: BitcoinChainParams

    Chain parameters for the blockchain we're on

    Chain parameters for the blockchain we're on

    Definition Classes
    AppConfig
  9. def clean(): CleanResult

    Runs flyway clean

    Runs flyway clean

    WARNING: THIS DELETES ALL DATA IN THE DATABASE, YOU PROBABLY DON'T WANT THIS UNLESS YOU ARE USING TESTS

    Definition Classes
    DbManagement
    See also

    https://flywaydb.org/documentation/command/clean

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. lazy val config: Config
    Attributes
    protected
    Definition Classes
    AppConfig
  12. def configFileName: String
    Definition Classes
    AppConfig
  13. val configOverrides: Vector[Config]

    List of user-provided configs that should override defaults

    List of user-provided configs that should override defaults

    Definition Classes
    TestAppConfigAppConfig
  14. def createSchema(createIfNotExists: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]
    Definition Classes
    DbManagement
  15. def createTable(table: slick.jdbc.JdbcProfile.JdbcAPI.TableQuery[_ <: slick.jdbc.JdbcProfile.JdbcAPI.Table[_]], createIfNotExists: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]

    Creates the given table

    Creates the given table

    Definition Classes
    DbManagement
  16. lazy val database: JdbcDatabaseDef

    The database we are connecting to

    The database we are connecting to

    Definition Classes
    JdbcProfileComponent
  17. lazy val datadir: Path

    The network specific data directory.

    The network specific data directory.

    Definition Classes
    AppConfig
  18. lazy val dbConfig: DatabaseConfig[JdbcProfile]

    The configuration details for connecting/using the database for our projects that require database connections

    The configuration details for connecting/using the database for our projects that require database connections

    Definition Classes
    JdbcProfileComponent
  19. lazy val dbHost: String

    The host of our postgresql database

    The host of our postgresql database

    Definition Classes
    DbAppConfig
  20. lazy val dbName: String

    The name of our database

    The name of our database

    Definition Classes
    DbAppConfig
  21. lazy val dbPassword: String
    Definition Classes
    DbAppConfig
  22. lazy val dbPath: Path

    The path where our DB is located

    The path where our DB is located

    Definition Classes
    DbAppConfig
  23. lazy val dbPort: Int

    The port number of our postgresql database

    The port number of our postgresql database

    Definition Classes
    DbAppConfig
  24. lazy val dbUsername: String
    Definition Classes
    DbAppConfig
  25. lazy val driver: DatabaseDriver
    Definition Classes
    DbAppConfig
  26. def dropAll()(implicit ec: ExecutionContext): Future[Unit]
    Definition Classes
    DbManagement
  27. def dropTable(tableName: String)(implicit ec: ExecutionContext): Future[Int]
    Definition Classes
    DbManagement
  28. def dropTable(table: slick.jdbc.JdbcProfile.JdbcAPI.TableQuery[slick.jdbc.JdbcProfile.JdbcAPI.Table[_]]): Future[Unit]
    Definition Classes
    DbManagement
  29. implicit val ec: ExecutionContext
    Definition Classes
    TestAppConfigTestDbManagement
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  32. lazy val flyway: Flyway
    Attributes
    protected
    Definition Classes
    DbManagement
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def getConfigString(path: String): String
    Definition Classes
    AppConfig
  35. def getConfigStringOpt(path: String): Option[String]
    Definition Classes
    AppConfig
  36. lazy val hikariLoggingInterval: Option[Duration]

    Gets how often we should log hikari connection pool stats if None, this means isHikariLoggingEnabled is not enabled

    Gets how often we should log hikari connection pool stats if None, this means isHikariLoggingEnabled is not enabled

    Definition Classes
    DbAppConfig
  37. def info(): MigrationInfoService

    Returns flyway information about the state of migrations

    Returns flyway information about the state of migrations

    Definition Classes
    DbManagement
    See also

    https://flywaydb.org/documentation/command/info

  38. lazy val isHikariLoggingEnabled: Boolean
    Definition Classes
    DbAppConfig
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. lazy val jdbcUrl: String
    Definition Classes
    DbAppConfig
  41. def logger: Logger
    Definition Classes
    BitcoinSLogger
  42. def migrate(): MigrateResult

    Executes migrations related to this database

    Executes migrations related to this database

    Definition Classes
    DbManagement
    See also

    https://flywaydb.org/documentation/api/#programmatic-configuration-java

  43. def migrationsApplied(): Int
    Definition Classes
    DbManagement
  44. def moduleName: String

    Name of the module.

    Name of the module. chain, wallet, node etc.

    Attributes
    protected[bitcoins]
    Definition Classes
    TestAppConfigAppConfig
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. lazy val network: BitcoinNetwork

    The blockchain network we're on

    The blockchain network we're on

    Definition Classes
    AppConfig
  47. def newConfigOfType(configs: Vector[Config]): TestAppConfig

    Constructor to make a new instance of this config type

    Constructor to make a new instance of this config type

    Attributes
    protected[bitcoins]
    Definition Classes
    TestAppConfigAppConfig
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. lazy val numThreads: Int
    Definition Classes
    JdbcProfileComponent
  51. def productElementNames: Iterator[String]
    Definition Classes
    Product
  52. lazy val profile: JdbcProfile
    Definition Classes
    JdbcProfileComponent
  53. lazy val schemaName: Option[String]
    Definition Classes
    DbAppConfig
  54. lazy val slickDbConfig: DatabaseConfig[JdbcProfile]
    Definition Classes
    DbAppConfig
  55. def start(): Future[Unit]

    Starts this project.

    Starts this project. After this future resolves, all operations should be able to be performed correctly.

    Starting may include creating database tables, making directories or files needed later or something else entirely.

    Definition Classes
    TestAppConfigAppConfigStartStop
  56. def startHikariLogger(interval: Duration): HikariLogging

    Starts the background logger for hikari

    Starts the background logger for hikari

    interval

    - how often hikari logs database connection pool information

    Attributes
    protected
    Definition Classes
    JdbcProfileComponent
  57. def stop(): Future[Unit]

    Releases the thread pool associated with this AppConfig's DB

    Releases the thread pool associated with this AppConfig's DB

    Definition Classes
    DbAppConfigStartStop
  58. def stopHikariLogger(): Unit
    Attributes
    protected
    Definition Classes
    JdbcProfileComponent
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. implicit def tableQueryToWithSchema(tableQuery: slick.jdbc.JdbcProfile.JdbcAPI.TableQuery[_]): slick.jdbc.JdbcProfile.JdbcAPI.TableQuery[slick.jdbc.JdbcProfile.JdbcAPI.Table[_]]

    Internally, slick defines the schema member as

    Internally, slick defines the schema member as

    def schema: SchemaDescription = buildTableSchemaDescription(q.shaped.value.asInstanceOf[Table[_]])

    we need to cast between TableQuery's of specific table types to the more generic TableQuery[Table[_]] to get methods in this trait working as they require schema (which essentially does this cast anyway)

    This cast is needed because TableQuery is not covariant in its type parameter. However, since Query is covariant in its first type parameter, I believe the cast from TableQuery[T1] to TableQuery[T2] will always be safe so long as T1 is a subtype of T2 AND T1#TableElementType is equal to T2#TableElementType.

    The above conditions are always the case when this is called in the current code base and will stay that way so long as no one tries anything too fancy.

    Attributes
    protected
    Definition Classes
    DbManagement
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. def withOverrides(configOverrides: Vector[Config]): ConfigType

    This method returns a new AppConfig, where every key under bitcoin-s overrides the configuration picked up by other means (the reference.conf provided by bitcoin-s and the application.conf provided by the user).

    This method returns a new AppConfig, where every key under bitcoin-s overrides the configuration picked up by other means (the reference.conf provided by bitcoin-s and the application.conf provided by the user). If you pass in configs with overlapping keys (e.g. several configs with the key bitcoin-s.network), the latter config overrides the first.

    Definition Classes
    AppConfig
  65. def withOverrides(configOverrides: Config): ConfigType
    Definition Classes
    AppConfig

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TestDbManagement

Inherited from DbManagement

Inherited from DbAppConfig

Inherited from AppConfig

Inherited from BitcoinSLogger

Inherited from StartStopAsync[Unit]

Inherited from StartStop[Future[Unit]]

Inherited from AnyRef

Inherited from Any

Ungrouped