Idris2Doc : Oracle.Types.Migration

Oracle.Types.Migration

(source)
Definitions
record Migration : Type
  A database migration.
  
  Migrations are defined entirely through the Idris API. There are no
  migration files or filesystem-based migration discovery mechanisms.
  
  `migrationversion` must uniquely identify the migration within a migration set.
  Migrations are normally applied in ascending version order.
  
  `migrationname` provides a human-readable description of the migration.
  
  `migrationup` applies the migration.
  
  `migrationdown` reverses the migration.
  

  Totality: total
  Visibility: public export
  Constructor: 
MkMigration : Int -> String -> (Connection -> IO (Either OracleError ())) -> (Connection -> IO (Either OracleError ())) -> Migration

  Projections:
  
.migrationdown : Migration -> Connection -> IO (Either OracleError ())
  
.migrationname : Migration -> String
  
.migrationup : Migration -> Connection -> IO (Either OracleError ())
  
.migrationversion : Migration -> Int
.migrationversion : Migration -> Int
  Totality: total
  Visibility: public export
migrationversion : Migration -> Int
  Totality: total
  Visibility: public export
.migrationname : Migration -> String
  Totality: total
  Visibility: public export
migrationname : Migration -> String
  Totality: total
  Visibility: public export
.migrationup : Migration -> Connection -> IO (Either OracleError ())
  Totality: total
  Visibility: public export
migrationup : Migration -> Connection -> IO (Either OracleError ())
  Totality: total
  Visibility: public export
.migrationdown : Migration -> Connection -> IO (Either OracleError ())
  Totality: total
  Visibility: public export
migrationdown : Migration -> Connection -> IO (Either OracleError ())
  Totality: total
  Visibility: public export
record MigrationInfo : Type
  Information about a migration that has been recorded in the database.
  
  This represents the persisted migration history rather than the executable migration definition itself.
  

  Totality: total
  Visibility: public export
  Constructor: 
MkMigrationInfo : Int -> String -> String -> MigrationInfo

  Projections:
  
.migrationinfoappliedAt : MigrationInfo -> String
  
.migrationinfoname : MigrationInfo -> String
  
.migrationinfoversion : MigrationInfo -> Int
.migrationinfoversion : MigrationInfo -> Int
  Totality: total
  Visibility: public export
migrationinfoversion : MigrationInfo -> Int
  Totality: total
  Visibility: public export
.migrationinfoname : MigrationInfo -> String
  Totality: total
  Visibility: public export
migrationinfoname : MigrationInfo -> String
  Totality: total
  Visibility: public export
.migrationinfoappliedAt : MigrationInfo -> String
  Totality: total
  Visibility: public export
migrationinfoappliedAt : MigrationInfo -> String
  Totality: total
  Visibility: public export
data MigrationStatus : Type
  The status of a migration relative to the supplied migration definitions and the migration history persisted in Oracle.
  

  Totality: total
  Visibility: public export
  Constructors:
  
MigrationPending : Migration -> MigrationStatus
  
MigrationApplied : Migration -> MigrationInfo -> MigrationStatus
  
MigrationMissing : MigrationInfo -> MigrationStatus
sameMigrationVersion : Migration -> MigrationInfo -> Bool
  Determine whether a migration version matches a persisted migration.
  

  Totality: total
  Visibility: export
isMigrationApplied : Migration -> List MigrationInfo -> Bool
  Determine whether a migration has already been applied.
  

  Totality: total
  Visibility: export