Documentation
¶
Index ¶
- Constants
- Variables
- func AssertIndex(t *testing.T, tableName string, wantIndexName string, wantDefinition string, ...)
- func AssertTableColumnsEqual(t *testing.T, want *TableColumn, actual *TableColumn)
- func CheckDatabaseExistsWithNewConnection(dbname string) bool
- func CheckTableExists(db *sql.DB, tableName string) bool
- func ConnectInitializedDatabase(postgresDbConfig *postgresdb.Config, upgradeScripts []*UpgradeScript, ...) (*sql.DB, error)
- func GetNumTablesInDb(db *sql.DB) int
- func PostTestWithDbClose(db *sql.DB, dbname string)
- func PreTest(t *testing.T) (*sql.DB, string)
- func QueryAllRows(db *sql.DB, tableName string) [][]interface{}
- func QueryDbVersion(db *sql.DB) (uint32, error)
- func RunUpgradeScripts(db *sql.DB, scripts []*UpgradeScript, codeVersionString string) error
- func ValidateDBVersionRow(t *testing.T, actualRow []interface{}, wantVersion int, ...)
- type IndexSearchResult
- type TableColumn
- type UpgradeScript
Constants ¶
const SqlDbVersionTableAlter1 = "ALTER TABLE db_version ADD COLUMN code_version_string TEXT"
const SqlDbVersionTableCreate = "" /* 211-byte string literal not displayed */
tables
Variables ¶
var UpgradeScripts = []*UpgradeScript{ MakeUpgradeScript(1, SqlDbVersionTableCreate), MakeUpgradeScript(2, SqlDbVersionTableAlter1), }
Functions ¶
func AssertIndex ¶ added in v1.10.0
func AssertIndex(t *testing.T, tableName string, wantIndexName string, wantDefinition string, indexes IndexSearchResult)
AssertIndex validates that the index exists
func AssertTableColumnsEqual ¶ added in v1.10.0
func AssertTableColumnsEqual(t *testing.T, want *TableColumn, actual *TableColumn)
AssertTableColumnsEqual is well-named
func CheckDatabaseExistsWithNewConnection ¶ added in v1.10.0
CheckDatabaseExistsWithNewConnection is well-named
func CheckTableExists ¶ added in v1.10.0
CheckTableExists is well-named
func ConnectInitializedDatabase ¶
func ConnectInitializedDatabase(postgresDbConfig *postgresdb.Config, upgradeScripts []*UpgradeScript, codeVersionString string) (*sql.DB, error)
ConnectInitializedDatabase creates a database with the required metadata tables
func GetNumTablesInDb ¶ added in v1.10.0
GetNumTablesInDb is well-named
func PostTestWithDbClose ¶ added in v1.10.0
PostTestWithDbClose logic for tests related to db upgrades
func QueryAllRows ¶ added in v1.10.0
QueryAllRows queries all the rows of a given table in a database
func RunUpgradeScripts ¶ added in v1.10.0
func RunUpgradeScripts(db *sql.DB, scripts []*UpgradeScript, codeVersionString string) error
RunUpgradeScripts is a utility function that can be run from outside this package so we need to export it
Types ¶
type IndexSearchResult ¶ added in v1.10.0
IndexSearchResult captures the result from GetTableIndexes() and is used as input to AssertIndex()
func GetTableIndexes ¶ added in v1.10.0
func GetTableIndexes(db *sql.DB, tableName string) IndexSearchResult
GetTableIndexes is well-named
type TableColumn ¶ added in v1.10.0
type TableColumn struct {
ColumnName string // `db:"column_name"`
OrdinalPosition int // `db:"ordinal_position"`
ColumnDefault interface{} // `db:"column_default"`
IsNullable string // `db:"is_nullable"` // uses "YES" / "NO" instead of a boolean
DataType string // `db:"data_type"`
CharacterMaximumLength interface{} // `db:"character_maximum_length"`
}
TableColumn is a column in a table specefied generically
func GetTableSchema ¶ added in v1.10.0
func GetTableSchema(db *sql.DB, tableName string) []TableColumn
GetTableSchema is well-named
type UpgradeScript ¶
type UpgradeScript struct {
// contains filtered or unexported fields
}
UpgradeScript encapsulates a script to be run to upgrade the database from one version to the next
func MakeUpgradeScript ¶
func MakeUpgradeScript(version uint32, command string, moreCommands ...string) *UpgradeScript
MakeUpgradeScript encapsulates a script to be run to upgrade the database from one version to the next
Source Files