Classes
struct	SetupOptions
struct	SetupPlan
struct	SetupRuntimeContext
struct	SetupState
struct	SqlStatementContext
struct	SqlUpdateFile

Functions
bool	ApplyPendingSetupUpdates (MYSQL *setupConnection, SetupOptions const &options, SetupPlan const &plan, SetupRuntimeContext const &context)
bool	BaselineSetupUpdates (MYSQL *setupConnection, SetupOptions const &options, SetupPlan const &plan, SetupRuntimeContext const &context)
SetupPlan	BuildAuthDatabaseSetupPlan (SetupOptions const &options, SetupState const &state, bool baseSqlExists, std::vector< SqlUpdateFile > const &updates)
SetupPlan	BuildCharacterDatabaseSetupPlan (SetupOptions const &options, SetupState const &state, bool baseSqlExists, std::vector< SqlUpdateFile > const &updates)
std::string	BuildCreateDatabaseSql (std::string const &databaseName)
SetupPlan	BuildDatabaseSetupPlan (SetupOptions const &options, SetupState const &state, bool baseSqlExists, std::vector< SqlUpdateFile > const &updates)
std::string	BuildDbUpdateAuditInsertSql (std::string const &filename)
std::string	BuildDbUpdateAuditTableSql ()
std::string	BuildSetupPlanSummary (std::string const &databaseName, SetupPlan const &plan, std::size_t discoveredUpdateCount, bool appliesRequiredSql)
std::vector< SqlUpdateFile >	BuildSortedSqlUpdateList (std::vector< std::string > const &names, std::string const &directory)
std::string	BuildUpdateTrackingInsertSql (std::string const &domain, std::string const &filename, std::string const &hash)
std::string	BuildUpdateTrackingTableSql ()
SetupPlan	BuildWorldDatabaseSetupPlan (SetupOptions const &options, SetupState const &state, bool externalBaseSqlExists, bool requiredBaseSqlExists, std::vector< SqlUpdateFile > const &updates)
std::string	CalculateStableSqlHash (std::string const &sql)
bool	ConnectToMySQLServer (MySQLConnectionInfo const &connectionInfo, char const databaseName, MYSQL &handle, SetupRuntimeContext const &context)
std::vector< SqlUpdateFile >	DiscoverSqlUpdates (SetupOptions const &options)
bool	EnsureDatabaseExists (MySQLConnectionInfo const &connectionInfo, SetupOptions const &options, SetupRuntimeContext const &context)
bool	EnsureSetupTrackingTables (MYSQL *setupConnection, SetupRuntimeContext const &context)
std::string	EscapeSqlIdentifier (std::string const &identifier)
std::string	EscapeSqlString (std::string const &value)
bool	ExecuteSqlFile (MYSQL *setupConnection, std::filesystem::path const &path, std::string &contents, SetupRuntimeContext const &context)
bool	ExecuteSqlScript (std::string const &sql, std::function< bool(std::string const &)> const &executor)
bool	ExecuteSqlStream (std::istream &input, std::uintmax_t totalBytes, std::function< bool(std::string const &, SqlStatementContext const &)> const &executor)
std::filesystem::path	GetDatabaseBaseSqlPath (SetupOptions const &options)
std::filesystem::path	GetDatabaseBaseSqlPath (SetupOptions const &options, std::string const &baseFileName)
bool	LoadDatabaseSetupState (MYSQL *setupConnection, SetupOptions const &options, SetupState &state, SetupRuntimeContext const &context)
void	LogSetupPlan (SetupPlan const &plan, std::size_t discoveredUpdateCount, bool appliesRequiredSql, SetupRuntimeContext const &context)
SetupOptions	MakeAuthDatabaseSetupOptions (bool autoSetup, bool autoCreate, bool autoBaseline, std::string sqlPath)
SetupOptions	MakeAuthDatabaseSetupOptions (bool autoSetup, bool autoCreate, std::string sqlPath)
SetupOptions	MakeCharacterDatabaseSetupOptions (bool autoSetup, bool autoCreate, bool autoBaseline, std::string sqlPath)
SetupOptions	MakeCharacterDatabaseSetupOptions (bool autoSetup, bool autoCreate, std::string sqlPath)
SetupOptions	MakeWorldDatabaseSetupOptions (bool autoSetup, bool autoCreate, bool autoBaseline, std::string sqlPath, std::string externalBaseFile)
SetupOptions	MakeWorldDatabaseSetupOptions (bool autoSetup, bool autoCreate, std::string sqlPath, std::string externalBaseFile)
std::vector< std::string >	SplitSqlStatements (std::string const &sql)

Function Documentation

◆ ApplyPendingSetupUpdates()

bool Skyfire::Database::ApplyPendingSetupUpdates	(	MYSQL *	setupConnection,
		SetupOptions const &	options,
		SetupPlan const &	plan,
		SetupRuntimeContext const &	context )

Definition at line 688 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupRuntimeContext::DatabaseName, ExecuteSqlFile(), Skyfire::Database::SqlUpdateFile::Hash, Skyfire::Database::SetupRuntimeContext::LogFilter, Skyfire::Database::SqlUpdateFile::Name, Skyfire::Database::SqlUpdateFile::Path, Skyfire::Database::SetupPlan::PendingUpdates, SF_LOG_ERROR, and SF_LOG_INFO.

◆ BaselineSetupUpdates()

bool Skyfire::Database::BaselineSetupUpdates	(	MYSQL *	setupConnection,
		SetupOptions const &	options,
		SetupPlan const &	plan,
		SetupRuntimeContext const &	context )

Definition at line 662 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupPlan::BaselineUpdates, Skyfire::Database::SetupRuntimeContext::ConfigPrefix, Skyfire::Database::SetupRuntimeContext::DatabaseName, Skyfire::Database::SqlUpdateFile::Hash, Skyfire::Database::SetupRuntimeContext::LogFilter, Skyfire::Database::SqlUpdateFile::Name, SF_LOG_ERROR, SF_LOG_WARN, and Skyfire::Database::SetupPlan::ShouldBaselineUpdates.

◆ BuildAuthDatabaseSetupPlan()

SetupPlan Skyfire::Database::BuildAuthDatabaseSetupPlan	(	SetupOptions const &	options,
		SetupState const &	state,
		bool	baseSqlExists,
		std::vector< SqlUpdateFile > const &	updates )

Definition at line 644 of file DatabaseSetup.cpp.

References BuildDatabaseSetupPlan().

◆ BuildCharacterDatabaseSetupPlan()

SetupPlan Skyfire::Database::BuildCharacterDatabaseSetupPlan	(	SetupOptions const &	options,
		SetupState const &	state,
		bool	baseSqlExists,
		std::vector< SqlUpdateFile > const &	updates )

Definition at line 650 of file DatabaseSetup.cpp.

References BuildDatabaseSetupPlan().

◆ BuildCreateDatabaseSql()

std::string Skyfire::Database::BuildCreateDatabaseSql ( std::string const & databaseName )

Definition at line 490 of file DatabaseSetup.cpp.

References EscapeSqlIdentifier().

Referenced by EnsureDatabaseExists().

◆ BuildDatabaseSetupPlan()

SetupPlan Skyfire::Database::BuildDatabaseSetupPlan	(	SetupOptions const &	options,
		SetupState const &	state,
		bool	baseSqlExists,
		std::vector< SqlUpdateFile > const &	updates )

Definition at line 554 of file DatabaseSetup.cpp.

Referenced by BuildAuthDatabaseSetupPlan(), BuildCharacterDatabaseSetupPlan(), and BuildWorldDatabaseSetupPlan().

◆ BuildDbUpdateAuditInsertSql()

std::string Skyfire::Database::BuildDbUpdateAuditInsertSql ( std::string const & filename )

Definition at line 524 of file DatabaseSetup.cpp.

References EscapeSqlString().

◆ BuildDbUpdateAuditTableSql()

std::string Skyfire::Database::BuildDbUpdateAuditTableSql ( )

Definition at line 515 of file DatabaseSetup.cpp.

Referenced by EnsureSetupTrackingTables().

◆ BuildSetupPlanSummary()

std::string Skyfire::Database::BuildSetupPlanSummary	(	std::string const &	databaseName,
		SetupPlan const &	plan,
		std::size_t	discoveredUpdateCount,
		bool	appliesRequiredSql )

Definition at line 530 of file DatabaseSetup.cpp.

References Skyfire::Database::SetupPlan::BaselineUpdates, Skyfire::Database::SetupPlan::HashMismatchedUpdates, Skyfire::Database::SetupPlan::PendingUpdates, Skyfire::Database::SetupPlan::ShouldBaselineUpdates, and Skyfire::Database::SetupPlan::ShouldInstallBase.

Referenced by LogSetupPlan().

◆ BuildSortedSqlUpdateList()

std::vector< SqlUpdateFile > Skyfire::Database::BuildSortedSqlUpdateList	(	std::vector< std::string > const &	names,
		std::string const &	directory )

Definition at line 259 of file DatabaseSetup.cpp.

Referenced by DiscoverSqlUpdates().

◆ BuildUpdateTrackingInsertSql()

std::string Skyfire::Database::BuildUpdateTrackingInsertSql	(	std::string const &	domain,
		std::string const &	filename,
		std::string const &	hash )

Definition at line 507 of file DatabaseSetup.cpp.

References EscapeSqlString().

◆ BuildUpdateTrackingTableSql()

std::string Skyfire::Database::BuildUpdateTrackingTableSql ( )

Definition at line 496 of file DatabaseSetup.cpp.

Referenced by EnsureSetupTrackingTables().

◆ BuildWorldDatabaseSetupPlan()

SetupPlan Skyfire::Database::BuildWorldDatabaseSetupPlan	(	SetupOptions const &	options,
		SetupState const &	state,
		bool	externalBaseSqlExists,
		bool	requiredBaseSqlExists,
		std::vector< SqlUpdateFile > const &	updates )

Definition at line 656 of file DatabaseSetup.cpp.

References BuildDatabaseSetupPlan(), Skyfire::Database::SetupPlan::Error, Skyfire::Database::SetupOptions::ExternalBaseFile, Skyfire::Database::SetupPlan::IsValid(), and Skyfire::Database::SetupPlan::ShouldInstallBase.

◆ CalculateStableSqlHash()

std::string Skyfire::Database::CalculateStableSqlHash ( std::string const & sql )

Definition at line 443 of file DatabaseSetup.cpp.

Referenced by DiscoverSqlUpdates().

◆ ConnectToMySQLServer()

bool Skyfire::Database::ConnectToMySQLServer	(	MySQLConnectionInfo const &	connectionInfo,
		char const *	databaseName,
		MYSQL *&	handle,
		SetupRuntimeContext const &	context )

Definition at line 420 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupRuntimeContext::LogFilter, and SF_LOG_ERROR.

Referenced by EnsureDatabaseExists().

◆ DiscoverSqlUpdates()

std::vector< SqlUpdateFile > Skyfire::Database::DiscoverSqlUpdates ( SetupOptions const & options )

Definition at line 280 of file DatabaseSetup.cpp.

References BuildSortedSqlUpdateList(), CalculateStableSqlHash(), Skyfire::Database::SetupOptions::ImportPendingUpdates, Skyfire::Database::SetupOptions::PendingUpdatesDirectory, Skyfire::Database::SetupOptions::SqlPath, and Skyfire::Database::SetupOptions::UpdatesDirectory.

◆ EnsureDatabaseExists()

bool Skyfire::Database::EnsureDatabaseExists	(	MySQLConnectionInfo const &	connectionInfo,
		SetupOptions const &	options,
		SetupRuntimeContext const &	context )

Definition at line 470 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupOptions::AutoCreate, Skyfire::Database::SetupOptions::AutoSetup, BuildCreateDatabaseSql(), Skyfire::Database::SetupRuntimeContext::ConfigPrefix, ConnectToMySQLServer(), Skyfire::Database::SetupRuntimeContext::DatabaseName, Skyfire::Database::SetupRuntimeContext::DatabaseNameTitle, Skyfire::Database::SetupRuntimeContext::DatabaseNameWithArticle, Skyfire::Database::SetupRuntimeContext::LogFilter, SF_LOG_ERROR, and SF_LOG_INFO.

◆ EnsureSetupTrackingTables()

bool Skyfire::Database::EnsureSetupTrackingTables	(	MYSQL *	setupConnection,
		SetupRuntimeContext const &	context )

Definition at line 641 of file DatabaseSetupRuntime.cpp.

References BuildDbUpdateAuditTableSql(), BuildUpdateTrackingTableSql(), Skyfire::Database::SetupRuntimeContext::DatabaseName, Skyfire::Database::SetupRuntimeContext::LogFilter, and SF_LOG_ERROR.

◆ EscapeSqlIdentifier()

std::string Skyfire::Database::EscapeSqlIdentifier ( std::string const & identifier )

Definition at line 474 of file DatabaseSetup.cpp.

Referenced by BuildCreateDatabaseSql().

◆ EscapeSqlString()

std::string Skyfire::Database::EscapeSqlString ( std::string const & value )

Definition at line 458 of file DatabaseSetup.cpp.

Referenced by BuildDbUpdateAuditInsertSql(), BuildUpdateTrackingInsertSql(), and LoadDatabaseSetupState().

◆ ExecuteSqlFile()

bool Skyfire::Database::ExecuteSqlFile	(	MYSQL *	setupConnection,
		std::filesystem::path const &	path,
		std::string &	contents,
		SetupRuntimeContext const &	context )

Definition at line 557 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SqlStatementContext::BytesRead, Skyfire::Database::SetupRuntimeContext::DatabaseName, ExecuteSqlStream(), Skyfire::Database::SetupRuntimeContext::LogFilter, SF_LOG_ERROR, SF_LOG_INFO, Skyfire::Database::SetupRuntimeContext::SqlExecutionContext, and Skyfire::Database::SqlStatementContext::StatementCount.

Referenced by ApplyPendingSetupUpdates().

◆ ExecuteSqlScript()

bool Skyfire::Database::ExecuteSqlScript	(	std::string const &	sql,
		std::function< bool(std::string const &)> const &	executor )

Definition at line 381 of file DatabaseSetup.cpp.

References ExecuteSqlStream().

◆ ExecuteSqlStream()

bool Skyfire::Database::ExecuteSqlStream	(	std::istream &	input,
		std::uintmax_t	totalBytes,
		std::function< bool(std::string const &, SqlStatementContext const &)> const &	executor )

Definition at line 391 of file DatabaseSetup.cpp.

References Skyfire::Database::SqlStatementContext::BytesRead, Skyfire::Database::SqlStatementContext::StatementCount, and Skyfire::Database::SqlStatementContext::TotalBytes.

Referenced by ExecuteSqlFile(), and ExecuteSqlScript().

◆ GetDatabaseBaseSqlPath() [1/2]

std::filesystem::path Skyfire::Database::GetDatabaseBaseSqlPath ( SetupOptions const & options )

Definition at line 408 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupOptions::BaseFileName, and GetDatabaseBaseSqlPath().

Referenced by GetDatabaseBaseSqlPath().

◆ GetDatabaseBaseSqlPath() [2/2]

std::filesystem::path Skyfire::Database::GetDatabaseBaseSqlPath	(	SetupOptions const &	options,
		std::string const &	baseFileName )

Definition at line 413 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupOptions::SqlPath.

◆ LoadDatabaseSetupState()

bool Skyfire::Database::LoadDatabaseSetupState	(	MYSQL *	setupConnection,
		SetupOptions const &	options,
		SetupState &	state,
		SetupRuntimeContext const &	context )

Definition at line 501 of file DatabaseSetupRuntime.cpp.

References Skyfire::Database::SetupState::AppliedUpdateHashes, Skyfire::Database::SetupState::AppliedUpdates, Skyfire::Database::SetupState::DatabaseExists, Skyfire::Database::SetupRuntimeContext::DatabaseName, Skyfire::Database::SetupOptions::Domain, EscapeSqlString(), Skyfire::Database::SetupRuntimeContext::LogFilter, Skyfire::Database::SetupState::SchemaTableCount, SF_LOG_ERROR, and Skyfire::Database::SetupState::UpdateTrackingExists.

◆ LogSetupPlan()

void Skyfire::Database::LogSetupPlan	(	SetupPlan const &	plan,
		std::size_t	discoveredUpdateCount,
		bool	appliesRequiredSql,
		SetupRuntimeContext const &	context )

Definition at line 626 of file DatabaseSetupRuntime.cpp.

References BuildSetupPlanSummary(), Skyfire::Database::SetupRuntimeContext::ConfigPrefix, Skyfire::Database::SetupRuntimeContext::DatabaseNameTitle, Skyfire::Database::SetupPlan::HashMismatchedUpdates, Skyfire::Database::SetupRuntimeContext::LogFilter, Skyfire::Database::SqlUpdateFile::Name, SF_LOG_INFO, and SF_LOG_WARN.

◆ MakeAuthDatabaseSetupOptions() [1/2]

SetupOptions Skyfire::Database::MakeAuthDatabaseSetupOptions	(	bool	autoSetup,
		bool	autoCreate,
		bool	autoBaseline,
		std::string	sqlPath )

Definition at line 200 of file DatabaseSetup.cpp.

References Skyfire::Database::SetupOptions::AutoBaseline, Skyfire::Database::SetupOptions::AutoCreate, Skyfire::Database::SetupOptions::AutoSetup, Skyfire::Database::SetupOptions::BaseFileName, Skyfire::Database::SetupOptions::Domain, Skyfire::Database::SetupOptions::PendingUpdatesDirectory, Skyfire::Database::SetupOptions::SqlPath, and Skyfire::Database::SetupOptions::UpdatesDirectory.

◆ MakeAuthDatabaseSetupOptions() [2/2]

SetupOptions Skyfire::Database::MakeAuthDatabaseSetupOptions	(	bool	autoSetup,
		bool	autoCreate,
		std::string	sqlPath )

Definition at line 195 of file DatabaseSetup.cpp.

References MakeAuthDatabaseSetupOptions().

Referenced by MakeAuthDatabaseSetupOptions().

◆ MakeCharacterDatabaseSetupOptions() [1/2]

SetupOptions Skyfire::Database::MakeCharacterDatabaseSetupOptions	(	bool	autoSetup,
		bool	autoCreate,
		bool	autoBaseline,
		std::string	sqlPath )

Definition at line 220 of file DatabaseSetup.cpp.

References Skyfire::Database::SetupOptions::AutoBaseline, Skyfire::Database::SetupOptions::AutoCreate, Skyfire::Database::SetupOptions::AutoSetup, Skyfire::Database::SetupOptions::BaseFileName, Skyfire::Database::SetupOptions::Domain, Skyfire::Database::SetupOptions::PendingUpdatesDirectory, Skyfire::Database::SetupOptions::SqlPath, and Skyfire::Database::SetupOptions::UpdatesDirectory.

◆ MakeCharacterDatabaseSetupOptions() [2/2]

SetupOptions Skyfire::Database::MakeCharacterDatabaseSetupOptions	(	bool	autoSetup,
		bool	autoCreate,
		std::string	sqlPath )

Definition at line 215 of file DatabaseSetup.cpp.

References MakeCharacterDatabaseSetupOptions().

Referenced by MakeCharacterDatabaseSetupOptions().

◆ MakeWorldDatabaseSetupOptions() [1/2]

SetupOptions Skyfire::Database::MakeWorldDatabaseSetupOptions	(	bool	autoSetup,
		bool	autoCreate,
		bool	autoBaseline,
		std::string	sqlPath,
		std::string	externalBaseFile )

Definition at line 242 of file DatabaseSetup.cpp.

References Skyfire::Database::SetupOptions::AutoBaseline, Skyfire::Database::SetupOptions::AutoCreate, Skyfire::Database::SetupOptions::AutoSetup, Skyfire::Database::SetupOptions::Domain, Skyfire::Database::SetupOptions::ExternalBaseFile, Skyfire::Database::SetupOptions::PendingUpdatesDirectory, Skyfire::Database::SetupOptions::RequiredBaseFileNames, Skyfire::Database::SetupOptions::SqlPath, and Skyfire::Database::SetupOptions::UpdatesDirectory.

◆ MakeWorldDatabaseSetupOptions() [2/2]

SetupOptions Skyfire::Database::MakeWorldDatabaseSetupOptions	(	bool	autoSetup,
		bool	autoCreate,
		std::string	sqlPath,
		std::string	externalBaseFile )

Definition at line 235 of file DatabaseSetup.cpp.

References MakeWorldDatabaseSetupOptions().

Referenced by MakeWorldDatabaseSetupOptions().

◆ SplitSqlStatements()

std::vector< std::string > Skyfire::Database::SplitSqlStatements ( std::string const & sql )

Definition at line 340 of file DatabaseSetup.cpp.

Classes

Functions