Class MysqlEngine

src/database-engines/mysql-engine.ts:7–134

export type MysqlConnectionDetails = { host: string, port: number, username: string, password: string, database: string }

export class MysqlEngine implements DatabaseEngine {

	public connection: knexlib.Knex | null = null;

	constructor(connector: knexlib.Knex) {
		this.connection = connector;
	}

	getType(): KnexClient {
		return 'mysql2';
	}

	getConnection(): knexlib.Knex | null {
		return this.connection
	}

	async isOkay(): Promise<boolean> {
		if (!this.connection) return false;

		try {
			await this.connection.raw('SELECT VERSION()');
			return true;
		} catch {
			return false;
		}
	}

	async disconnect() {
		if (this.connection) this.connection.destroy(() => null);
	}

	async getTableCreationSql(table: string): Promise<string> {
		if (!this.connection) return '';

		const creationSql = (await this.connection.raw(`SHOW CREATE TABLE ??`, [table]))[0];

		const sql = (creationSql[0] as any)['Create Table'];

		/**
		 * Comes formatted, and any attempt to use format(...)
		 * from the sql-formatter package causes an issue whereby
		 * newline is added between "CHARACTER SET", which is still
		 * readable but largely odd.
		 */
		return sql
	}

	async getTables(): Promise<string[]> {
		if (!this.connection) return [];

		const tables = ((await this.connection.raw('SHOW TABLES'))[0]).map((entry: Record<string, string>) => Object.values(entry)[0]);

		return tables;
	}

	async getColumns(table: string): Promise<Column[]> {
		if (!this.connection) return [];