sqlmorpheus 1.0.1 → 1.1.0

package/dist/index.cjs

@@ -134,6 +134,10 @@ function getTableStructureFromMetadata(metadata) {
 //#endregion
 //#region src/lib/TableStructureGenerator.ts
 /**
+* Postgres silently truncates longer identifiers, which would lead to differing index names in each migration
+*/
+const MAX_INDEX_NAME_LENGTH = 63;
+/**
 * Represents a generator for creating table structures based on specified database instructions
 */
 var TableStructureGenerator = class {
@@ -150,24 +154,55 @@ var TableStructureGenerator = class {
 	*/
 	generateTableStructure() {
 		const tables = {};
+		const indexNames = {};
 		for (const table of this.dbInstructions.tables) {
 			let structure;
+			let tableName;
 			if (TableObjHelper.isTableObj(table)) {
 				structure = table.tableStructure;
-				tables[table.tableName] = table.tableStructure;
+				tableName = table.tableName;
 			} else {
 				const classTable = table;
 				structure = getTableStructure(classTable);
-				tables[classTable.name] = structure;
+				tableName = classTable.name;
 			}
 			for (const key in structure.columns) {
 				const entry = structure.columns[key];
 				entry.defaultValue = entry.inputDefaultValue === null ? this.dialect.nullType : this.dialect.formatValueToSql(entry.inputDefaultValue, entry.inputType);
 				entry.sqlType = this.dialect.getSqlType(entry.inputType, entry);
 			}
+			const indexes = this.getIndexes(tableName, structure);
+			for (const index of indexes) {
+				if (indexNames[index.name]) throw new Error(`Index name "${index.name}" is used in ${indexNames[index.name]} and ${tableName}. Index names need to be unique.`);
+				indexNames[index.name] = tableName;
+			}
+			tables[tableName] = {
+				...structure,
+				indexes
+			};
 		}
 		return tables;
 	}
+	/**
+	* Validates the index definitions of a table and generates names for indexes that have none.
+	*
+	* @param tableName - The name of the table the indexes belong to.
+	* @param structure - The table structure containing the index definitions.
+	* @return The index definitions including their names.
+	*/
+	getIndexes(tableName, structure) {
+		return (structure.indexes ?? []).map((index) => {
+			if (!index.columns.length) throw new Error(`An index in ${tableName} has no columns.`);
+			for (const column of index.columns) if (!structure.columns[column]) throw new Error(`Index in ${tableName} uses column "${column}", which does not exist.`);
+			const name = index.name ?? `${tableName}_${index.columns.join("_")}_idx`;
+			if (name.length > MAX_INDEX_NAME_LENGTH) throw new Error(`Index name "${name}" is longer than ${MAX_INDEX_NAME_LENGTH} characters. Please provide a shorter name.`);
+			return {
+				name,
+				columns: index.columns,
+				isUnique: index.isUnique
+			};
+		});
+	}
 };
 //#endregion
 //#region src/lib/typings/AllowedMigrations.ts
@@ -290,6 +325,7 @@ var Migrations = class {
 	* @param tableName - The name of the table to check the migration against.
 	* @param type - The type of destructive migration being checked.
 	* @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+	* For "dropIndex", the index name is used instead.
 	*/
 	compareWithAllowedMigration(tableName, type, column = NO_COLUMN) {
 		const migrationEntry = this.migrationData[tableName];
@@ -391,6 +427,7 @@ var Migrations = class {
 	* @param tableName - The current table name in the database at the time of the migration version.
 	* @param allowedMigration - The keys representing the migrations to be allowed.
 	* @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+	* For "dropIndex", provide the index name instead.
 	*
 	* @throws Error if the provided column name is not valid for the specified migration.
 	*/
@@ -408,6 +445,7 @@ var Migrations = class {
 			case "dropColumn":
 			case "removeForeignKey":
 			case "alterForeignKey": throw new Error(`The ${allowedMigration} migration requires a column name. Please provide one.`);
+			case "dropIndex": throw new Error(`The ${allowedMigration} migration requires an index name. Please provide one.`);
 		}
 	}
 	/**
@@ -676,6 +714,26 @@ var DefaultSql = class {
 		return `ALTER TABLE ${this.formatIdentifier(tableName)} DROP COLUMN ${this.formatIdentifier(columnName)};`;
 	}
 	/**
+	* Statement to create an index on a specified table.
+	*
+	* @param tableName - The name of the table on which the index will be created.
+	* @param index - The index definition.
+	* @return The SQL statement as a string.
+	*/
+	createIndex(tableName, index) {
+		return `CREATE ${index.isUnique ? "UNIQUE " : ""}INDEX ${this.formatIdentifier(index.name)} ON ${this.formatIdentifier(tableName)} (${index.columns.map((column) => this.formatIdentifier(column)).join(", ")});`;
+	}
+	/**
+	* Statement to drop an index from a specified table.
+	*
+	* @param tableName - The name of the table the index belongs to.
+	* @param indexName - The name of the index to be dropped.
+	* @return The SQL statement as a string.
+	*/
+	dropIndex(tableName, indexName) {
+		return `DROP INDEX ${this.formatIdentifier(indexName)};`;
+	}
+	/**
 	* Statement to return data from a table.
 	*
 	* @param tableName - The name of the database table to select data from.
@@ -726,6 +784,24 @@ var DefaultSql = class {
 		]);
 	}
 	/**
+	* Combines rows (one row per indexed column, ordered by index name and column position) into a list of {@link IndexInfo}.
+	*
+	* @param rows - Rows containing the index name, whether the index is unique and the column name.
+	* @return An array of {@link IndexInfo}.
+	*/
+	rowsToIndexInfo(rows) {
+		const indexes = {};
+		for (const row of rows) {
+			if (!indexes[row.index_name]) indexes[row.index_name] = {
+				name: row.index_name,
+				columns: [],
+				isUnique: !!Number(row.is_unique)
+			};
+			indexes[row.index_name].columns.push(row.column_name);
+		}
+		return Object.values(indexes);
+	}
+	/**
 	* Ensures that the migration table exists in the database.
 	* If the table does not exist, it creates the table using the defined migration table query.
 	*
@@ -860,13 +936,22 @@ var MigrationManager = class {
 		} else {
 			Logger.log(`Creating migration SQL from version ${fromVersion} to ${toVersion}`);
 			this.existingTables = (await this.dialect.getTableNames()).filter((oldTableName) => oldTableName != MIGRATION_DATA_TABLE_NAME).map((oldTableName) => this.migrations.getNewestTableName(oldTableName));
+			const renameTablesChanges = this.renameTables();
+			const createAndDropTablesChanges = await this.createAndDropTables();
+			const foreignKeyChanges = await this.migrateForeignKeys();
+			const columnChanges = await this.migrateColumns();
+			const renameColumnsChanges = this.renameColumns();
+			const indexChanges = await this.migrateIndexes();
+			const recreateTablesChanges = await this.recreateTables();
 			[
-				this.renameTables(),
-				await this.createAndDropTables(),
-				await this.migrateForeignKeys(),
-				await this.migrateColumns(),
-				this.renameColumns(),
-				await this.recreateTables()
+				renameTablesChanges,
+				createAndDropTablesChanges,
+				indexChanges.dropped,
+				foreignKeyChanges,
+				columnChanges,
+				renameColumnsChanges,
+				indexChanges.created,
+				recreateTablesChanges
 			].forEach((entry) => {
 				changes.up += entry.up;
 				changes.down += entry.down;
@@ -927,13 +1012,14 @@ var MigrationManager = class {
 		for (const tableName in this.newTables) if (this.tableDoesNotExists(tableName)) {
 			const structure = this.newTables[tableName];
 			changes.up += `${this.createTableSql(tableName, structure.columns, structure.foreignKeys)}\n`;
+			changes.up += this.createIndexesSql(tableName, structure.indexes);
 			changes.down += `${this.dialect.dropTable(tableName)}\n`;
 		}
 		for (const tableName of this.existingTables) if (!this.newTables[tableName]) {
 			this.migrations.compareWithAllowedMigration(tableName, "dropTable");
 			const dbTableName = this.migrations.getOldTableName(tableName);
 			changes.up += `${this.dialect.dropTable(tableName)}\n`;
-			changes.down += this.createTableSql(tableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName));
+			changes.down += this.createTableSql(tableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName)) + "\n" + this.createIndexesSql(tableName, await this.dialect.getIndexes(dbTableName));
 		}
 		return changes;
 	}
@@ -957,6 +1043,16 @@ var MigrationManager = class {
 		return this.dialect.createTable(tableName, queryLines);
 	}
 	/**
+	* Generates an SQL string to create all provided indexes on a table.
+	*
+	* @param tableName - The name of the table the indexes belong to.
+	* @param indexes - The index definitions.
+	* @return The SQL string to create the indexes (one statement per line).
+	*/
+	createIndexesSql(tableName, indexes) {
+		return (indexes ?? []).map((index) => `${this.dialect.createIndex(tableName, index)}\n`).join("");
+	}
+	/**
 	* Checks if the specified table does not exist in the list of existing tables.
 	*
 	* @param tableName - The name of the table to check.
@@ -987,9 +1083,9 @@ var MigrationManager = class {
 			const backupTableName = `${tableName}__backup`;
 			const moveDataQuery = this.dialect.insert(backupTableName, this.dialect.insertValues(moveableColumns, this.dialect.select(tableName, moveableColumns))) + "\n" + this.dialect.dropTable(tableName) + "\n" + this.dialect.renameTable(backupTableName, tableName);
 			const structure = this.newTables[tableName];
-			changes.up += this.createTableSql(backupTableName, structure.columns, structure.foreignKeys) + "\n" + moveDataQuery + "\n\n";
+			changes.up += this.createTableSql(backupTableName, structure.columns, structure.foreignKeys) + "\n" + moveDataQuery + "\n" + this.createIndexesSql(tableName, structure.indexes) + "\n";
 			const dbTableName = this.migrations.getOldTableName(tableName);
-			changes.down += this.createTableSql(backupTableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName)) + "\n" + moveDataQuery;
+			changes.down += this.createTableSql(backupTableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName)) + "\n" + moveDataQuery + "\n" + this.createIndexesSql(tableName, await this.dialect.getIndexes(dbTableName));
 		}
 		return changes;
 	}
@@ -1103,6 +1199,71 @@ var MigrationManager = class {
 		return changes;
 	}
 	/**
+	* Compares the indexes of all existing tables with their new definitions.
+	* Indexes that are removed or changed have to be allowed (using "dropIndex").
+	* Indexes of tables that will be recreated are only checked, their SQL is generated in {@link recreateTables()}.
+	*
+	* @return SQL changes to drop indexes (needs to run before columns are migrated)
+	* and to create indexes (needs to run after columns were migrated and renamed).
+	*/
+	async migrateIndexes() {
+		const dropped = {
+			up: "\n\n-- Drop indexes\n",
+			down: "\n\n-- Drop indexes\n"
+		};
+		const created = {
+			up: "\n\n-- Create indexes\n",
+			down: "\n\n-- Create indexes\n"
+		};
+		for (const tableName in this.newTables) {
+			if (this.tableDoesNotExists(tableName)) continue;
+			const dbTableName = this.migrations.getOldTableName(tableName);
+			const newIndexes = this.newTables[tableName].indexes ?? [];
+			const oldIndexes = await this.dialect.getIndexes(dbTableName);
+			const isSameIndex = (oldIndex, newIndex) => oldIndex.isUnique == newIndex.isUnique && oldIndex.columns.length == newIndex.columns.length && oldIndex.columns.every((column, i) => this.migrations.getNewestColumnName(tableName, column) == newIndex.columns[i]);
+			const indexesToDrop = [];
+			const indexesToCreate = [];
+			const addedIndexes = newIndexes.filter((newIndex) => !oldIndexes.some((oldIndex) => oldIndex.name == newIndex.name));
+			for (const oldIndex of oldIndexes) {
+				const newIndex = newIndexes.find((entry) => entry.name == oldIndex.name);
+				if (newIndex) {
+					if (isSameIndex(oldIndex, newIndex)) continue;
+					Logger.log(`Index ${oldIndex.name} in ${tableName} will be changed!`);
+					this.migrations.compareWithAllowedMigration(tableName, "dropIndex", oldIndex.name);
+					indexesToCreate.push(newIndex);
+				} else {
+					const renamedIndex = addedIndexes.find((entry) => isSameIndex(oldIndex, entry));
+					if (renamedIndex) {
+						Logger.log(`Index ${oldIndex.name} in ${tableName} will be renamed to ${renamedIndex.name}!`);
+						addedIndexes.splice(addedIndexes.indexOf(renamedIndex), 1);
+						indexesToCreate.push(renamedIndex);
+					} else {
+						Logger.log(`Index ${oldIndex.name} in ${tableName} will be removed!`);
+						this.migrations.compareWithAllowedMigration(tableName, "dropIndex", oldIndex.name);
+					}
+				}
+				indexesToDrop.push(oldIndex);
+			}
+			for (const newIndex of addedIndexes) {
+				Logger.log(`Index ${newIndex.name} in ${tableName} will be added!`);
+				indexesToCreate.push(newIndex);
+			}
+			if (this.migrations.willBeRecreated(tableName)) continue;
+			for (const index of indexesToDrop) {
+				dropped.up += `${this.dialect.dropIndex(tableName, index.name)}\n`;
+				created.down += `${this.dialect.createIndex(dbTableName, index)}\n`;
+			}
+			for (const index of indexesToCreate) {
+				created.up += `${this.dialect.createIndex(tableName, index)}\n`;
+				dropped.down += `${this.dialect.dropIndex(dbTableName, index.name)}\n`;
+			}
+		}
+		return {
+			dropped,
+			created
+		};
+	}
+	/**
 	* Retrieves the name of the primary key column from a list of column information.
 	*
 	* @param columnInfoEntries - An array of ColumnInfo objects containing details about each column.
@@ -1184,7 +1345,8 @@ var TableObj = class TableObj {
 		table: "",
 		primaryKey: void 0,
 		columns: {},
-		foreignKeys: []
+		foreignKeys: [],
+		indexes: []
 	};
 	constructor(tableName, defaultValues) {
 		const addColumnEntry = (key, value) => {
@@ -1243,6 +1405,21 @@ var TableObj = class TableObj {
 		return this;
 	}
 	/**
+	* Creates an index on one or more columns of the current table.
+	*
+	* @param columns - The columns that will be part of the index (in order).
+	* @param options - Optional configurations for the index.
+	* If no name is provided, the name is generated from the table and column names.
+	*/
+	index(columns, options) {
+		this.tableStructure.indexes.push({
+			name: options?.name,
+			columns: columns.map((column) => column.toString()),
+			isUnique: !!options?.unique
+		});
+		return this;
+	}
+	/**
 	* An optional helper function to deal with `TS2589: Type instantiation is excessively deep and possibly infinite. when used as method parameter`
 	* Does nothing in runtime
 	*/
@@ -1292,6 +1469,26 @@ function ForeignKey(toTable, toColumn, options) {
 	};
 }
 //#endregion
+//#region src/lib/tableInfo/decorators/Index.ts
+/**
+* Decorator function to create an index on one or more columns of a table.
+* This decorator must be used at the head of the class.
+*
+* @param columns - The columns that will be part of the index (in order).
+* @param options - Additional options. If no name is provided, the name is generated from the table and column names.
+*/
+function Index(columns, options) {
+	return (table, context) => {
+		const tableInfo = context?.metadata ? getTableStructureFromMetadata(context.metadata) : getTableStructure(table);
+		if (!tableInfo.indexes) tableInfo.indexes = [];
+		tableInfo.indexes.push({
+			name: options?.name,
+			columns: columns.map((column) => column.toString()),
+			isUnique: !!options?.unique
+		});
+	};
+}
+//#endregion
 //#region src/lib/dialects/SqliteDialect.ts
 /**
 * SQLite-specific syntax for SQL queries
@@ -1360,6 +1557,13 @@ var SqliteDialect = class extends DefaultSql {
 			};
 		});
 	}
+	async getIndexes(tableName) {
+		const data = await this.db.runReadStatement(`SELECT il.name AS index_name, il."unique" AS is_unique, ii.name AS column_name
+			FROM pragma_index_list('${tableName}') AS il JOIN pragma_index_info(il.name) AS ii
+			WHERE il.origin = 'c'
+			ORDER BY il.name, ii.seqno;`);
+		return this.rowsToIndexInfo(data);
+	}
 	async setChanges(fromVersion, toVersion, changes) {
 		await this.db.runTransaction(`PRAGMA user_version = ${toVersion};`);
 		await super.setChanges(fromVersion, toVersion, changes);
@@ -1446,6 +1650,18 @@ var PostgresDialect = class extends DefaultSql {
 	removePrimaryKey(tableName, columnName) {
 		return `ALTER TABLE ${tableName} DROP CONSTRAINT ${columnName};\n`;
 	}
+	async getIndexes(tableName) {
+		const data = await this.db.runReadStatement(`SELECT i.relname AS index_name, ix.indisunique AS is_unique, a.attname AS column_name
+			FROM pg_index AS ix
+				JOIN pg_class AS t ON t.oid = ix.indrelid
+				JOIN pg_class AS i ON i.oid = ix.indexrelid
+				JOIN pg_namespace AS n ON n.oid = t.relnamespace
+				JOIN pg_attribute AS a ON a.attrelid = t.oid AND a.attnum = ANY(ix.indkey)
+			WHERE n.nspname = 'public' AND t.relname = '${tableName}' AND NOT ix.indisprimary
+				AND NOT EXISTS (SELECT 1 FROM pg_constraint AS c WHERE c.conindid = ix.indexrelid)
+			ORDER BY i.relname, array_position(ix.indkey::int2[], a.attnum);`);
+		return this.rowsToIndexInfo(data);
+	}
 	async getForeignKeys(tableName) {
 		return (await this.db.runReadStatement(`SELECT
 				tc.table_name AS child_table,
@@ -1538,6 +1754,21 @@ var MySqlDialect = class extends DefaultSql {
 			};
 		});
 	}
+	dropIndex(tableName, indexName) {
+		return `DROP INDEX ${this.formatIdentifier(indexName)} ON ${this.formatIdentifier(tableName)};`;
+	}
+	async getIndexes(tableName) {
+		const data = await this.db.runReadStatement(`SELECT s.INDEX_NAME AS index_name, s.NON_UNIQUE = 0 AS is_unique, s.COLUMN_NAME AS column_name
+			FROM information_schema.STATISTICS AS s
+			WHERE s.TABLE_SCHEMA = (SELECT DATABASE()) AND s.TABLE_NAME = '${tableName}' AND s.INDEX_NAME <> 'PRIMARY'
+				AND NOT EXISTS (
+					SELECT 1 FROM information_schema.KEY_COLUMN_USAGE AS k
+					WHERE k.TABLE_SCHEMA = s.TABLE_SCHEMA AND k.TABLE_NAME = s.TABLE_NAME AND k.REFERENCED_TABLE_NAME IS NOT NULL
+						AND (k.CONSTRAINT_NAME = s.INDEX_NAME OR k.COLUMN_NAME = s.INDEX_NAME)
+				)
+			ORDER BY s.INDEX_NAME, s.SEQ_IN_INDEX;`);
+		return this.rowsToIndexInfo(data);
+	}
 	async getTableNames() {
 		return (await this.db.runReadStatement("SHOW TABLES")).map((entry) => Object.values(entry)[0]);
 	}
@@ -1577,6 +1808,13 @@ function getDialect(db, dialect) {
 }
 //#endregion
 //#region src/index.ts
+/**
+* Executes a database migration based on the provided database connection and migration instructions.
+*
+* @param db - The database access object used to interact with the database.
+* @param dbInstructions - The migration instructions, including target version, logger mode, and dialect.
+* @return A promise that resolves when the migration process is successfully completed.
+*/
 async function runMigration(db, dbInstructions) {
 	Logger.setMode(dbInstructions.loggerMode);
 	const dialect = getDialect(db, dbInstructions.dialect);
@@ -1616,6 +1854,7 @@ async function rollback(dbAccess, toVersion, dialect, loggerMode) {
 //#endregion
 exports.DataType = DataType;
 exports.ForeignKey = ForeignKey;
+exports.Index = Index;
 exports.TableClass = TableClass;
 exports.TableObj = TableObj;
 exports.rollback = rollback;

package/dist/index.d.cts

@@ -27,6 +27,7 @@ interface AllowedMigrations {
   alterPrimaryKey?: Record<string, AllowedMigrationState>;
   removeForeignKey?: Record<string, AllowedMigrationState>;
   alterForeignKey?: Record<string, AllowedMigrationState>;
+  dropIndex?: Record<string, AllowedMigrationState>;
 }
 //#endregion
 //#region src/lib/typings/MigrationInstructions.d.ts
@@ -64,12 +65,26 @@ interface ForeignKeyInfo {
   onDelete?: ForeignKeyActions;
 }
 //#endregion
+//#region src/lib/typings/IndexInfo.d.ts
+interface IndexInfo {
+  name: string;
+  columns: string[];
+  isUnique: boolean;
+}
+/**
+ * Index definition as provided by the user. If no name is provided, a name is generated from the table and column names.
+ */
+interface InputIndexInfo extends Omit<IndexInfo, "name"> {
+  name?: string;
+}
+//#endregion
 //#region src/lib/typings/TableStructure.d.ts
 interface TableStructure {
   table: string;
   primaryKey?: string;
   columns: Record<string, ColumnInfo>;
   foreignKeys?: ForeignKeyInfo[];
+  indexes?: IndexInfo[];
 }
 //#endregion
 //#region src/lib/Migrations.d.ts
@@ -133,6 +148,7 @@ declare class Migrations {
    * @param tableName - The name of the table to check the migration against.
    * @param type - The type of destructive migration being checked.
    * @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+   * For "dropIndex", the index name is used instead.
    */
   compareWithAllowedMigration(tableName: string, type: keyof AllowedMigrations, column?: string): void;
   /**
@@ -205,6 +221,7 @@ declare class Migrations {
    * @param tableName - The current table name in the database at the time of the migration version.
    * @param allowedMigration - The keys representing the migrations to be allowed.
    * @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+   * For "dropIndex", provide the index name instead.
    *
    * @throws Error if the provided column name is not valid for the specified migration.
    */
@@ -263,8 +280,9 @@ interface InputColumnInfo extends ColumnInfo {
 }
 //#endregion
 //#region src/lib/typings/InputTableStructure.d.ts
-interface InputTableStructure extends TableStructure {
+interface InputTableStructure extends Omit<TableStructure, "indexes"> {
   columns: Record<string, InputColumnInfo>;
+  indexes?: InputIndexInfo[];
 }
 //#endregion
 //#region src/lib/tableInfo/TableObjHelper.d.ts
@@ -278,7 +296,7 @@ interface ColumnOptions {
 }
 type DataFormat = Record<string, AllowedTypes | [AllowedTypes, ColumnOptions]>;
 type GetColumns<T> = T extends PublicTableObj<infer Item> ? Item : never;
-type PublicTableObj<T extends DataFormat> = Pick<TableObj<T>, "foreignKey" | "sealType">;
+type PublicTableObj<T extends DataFormat> = Pick<TableObj<T>, "foreignKey" | "index" | "sealType">;
 type TableObjInput = PublicTableObj<DataFormat>;
 /**
  * Use this class to define tables for DatabaseInstructions
@@ -303,6 +321,17 @@ declare class TableObj<T extends DataFormat> {
     onUpdate?: ForeignKeyActions;
     onDelete?: ForeignKeyActions;
   }): PublicTableObj<T>;
+  /**
+   * Creates an index on one or more columns of the current table.
+   *
+   * @param columns - The columns that will be part of the index (in order).
+   * @param options - Optional configurations for the index.
+   * If no name is provided, the name is generated from the table and column names.
+   */
+  index(columns: (keyof T)[], options?: {
+    name?: string;
+    unique?: boolean;
+  }): PublicTableObj<T>;
   /**
    * An optional helper function to deal with `TS2589: Type instantiation is excessively deep and possibly infinite. when used as method parameter`
    * Does nothing in runtime
@@ -387,7 +416,27 @@ declare function ForeignKey<TOther extends TableClassInterface>(toTable: Class<T
   onUpdate?: ForeignKeyActions;
 }): (table: any, context: any) => void;
 //#endregion
+//#region src/lib/tableInfo/decorators/Index.d.ts
+/**
+ * Decorator function to create an index on one or more columns of a table.
+ * This decorator must be used at the head of the class.
+ *
+ * @param columns - The columns that will be part of the index (in order).
+ * @param options - Additional options. If no name is provided, the name is generated from the table and column names.
+ */
+declare function Index<T extends TableClassInterface>(columns: (keyof T)[], options?: {
+  name?: string;
+  unique?: boolean;
+}): (table: Class<T>, context?: any) => void;
+//#endregion
 //#region src/index.d.ts
+/**
+ * Executes a database migration based on the provided database connection and migration instructions.
+ *
+ * @param db - The database access object used to interact with the database.
+ * @param dbInstructions - The migration instructions, including target version, logger mode, and dialect.
+ * @return A promise that resolves when the migration process is successfully completed.
+ */
 export declare function runMigration(db: DatabaseAccess, dbInstructions: DatabaseInstructions): Promise<void>;
 /**
  * Rolls back the database to the provided toVersion
@@ -398,4 +447,4 @@ export declare function runMigration(db: DatabaseAccess, dbInstructions: Databas
  */
 export declare function rollback(dbAccess: DatabaseAccess, toVersion: number, dialect: DatabaseInstructions["dialect"], loggerMode?: DatabaseInstructions["loggerMode"]): Promise<number>;
 //#endregion
-export { DataType, type DatabaseAccess, type DatabaseInstructions, ForeignKey, type PublicMigrations, type SqlChanges, TableClass, TableObj };
+export { DataType, type DatabaseAccess, type DatabaseInstructions, ForeignKey, Index, type PublicMigrations, type SqlChanges, TableClass, TableObj };

package/dist/index.d.mts

@@ -27,6 +27,7 @@ interface AllowedMigrations {
   alterPrimaryKey?: Record<string, AllowedMigrationState>;
   removeForeignKey?: Record<string, AllowedMigrationState>;
   alterForeignKey?: Record<string, AllowedMigrationState>;
+  dropIndex?: Record<string, AllowedMigrationState>;
 }
 //#endregion
 //#region src/lib/typings/MigrationInstructions.d.ts
@@ -64,12 +65,26 @@ interface ForeignKeyInfo {
   onDelete?: ForeignKeyActions;
 }
 //#endregion
+//#region src/lib/typings/IndexInfo.d.ts
+interface IndexInfo {
+  name: string;
+  columns: string[];
+  isUnique: boolean;
+}
+/**
+ * Index definition as provided by the user. If no name is provided, a name is generated from the table and column names.
+ */
+interface InputIndexInfo extends Omit<IndexInfo, "name"> {
+  name?: string;
+}
+//#endregion
 //#region src/lib/typings/TableStructure.d.ts
 interface TableStructure {
   table: string;
   primaryKey?: string;
   columns: Record<string, ColumnInfo>;
   foreignKeys?: ForeignKeyInfo[];
+  indexes?: IndexInfo[];
 }
 //#endregion
 //#region src/lib/Migrations.d.ts
@@ -133,6 +148,7 @@ declare class Migrations {
    * @param tableName - The name of the table to check the migration against.
    * @param type - The type of destructive migration being checked.
    * @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+   * For "dropIndex", the index name is used instead.
    */
   compareWithAllowedMigration(tableName: string, type: keyof AllowedMigrations, column?: string): void;
   /**
@@ -205,6 +221,7 @@ declare class Migrations {
    * @param tableName - The current table name in the database at the time of the migration version.
    * @param allowedMigration - The keys representing the migrations to be allowed.
    * @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+   * For "dropIndex", provide the index name instead.
    *
    * @throws Error if the provided column name is not valid for the specified migration.
    */
@@ -263,8 +280,9 @@ interface InputColumnInfo extends ColumnInfo {
 }
 //#endregion
 //#region src/lib/typings/InputTableStructure.d.ts
-interface InputTableStructure extends TableStructure {
+interface InputTableStructure extends Omit<TableStructure, "indexes"> {
   columns: Record<string, InputColumnInfo>;
+  indexes?: InputIndexInfo[];
 }
 //#endregion
 //#region src/lib/tableInfo/TableObjHelper.d.ts
@@ -278,7 +296,7 @@ interface ColumnOptions {
 }
 type DataFormat = Record<string, AllowedTypes | [AllowedTypes, ColumnOptions]>;
 type GetColumns<T> = T extends PublicTableObj<infer Item> ? Item : never;
-type PublicTableObj<T extends DataFormat> = Pick<TableObj<T>, "foreignKey" | "sealType">;
+type PublicTableObj<T extends DataFormat> = Pick<TableObj<T>, "foreignKey" | "index" | "sealType">;
 type TableObjInput = PublicTableObj<DataFormat>;
 /**
  * Use this class to define tables for DatabaseInstructions
@@ -303,6 +321,17 @@ declare class TableObj<T extends DataFormat> {
     onUpdate?: ForeignKeyActions;
     onDelete?: ForeignKeyActions;
   }): PublicTableObj<T>;
+  /**
+   * Creates an index on one or more columns of the current table.
+   *
+   * @param columns - The columns that will be part of the index (in order).
+   * @param options - Optional configurations for the index.
+   * If no name is provided, the name is generated from the table and column names.
+   */
+  index(columns: (keyof T)[], options?: {
+    name?: string;
+    unique?: boolean;
+  }): PublicTableObj<T>;
   /**
    * An optional helper function to deal with `TS2589: Type instantiation is excessively deep and possibly infinite. when used as method parameter`
    * Does nothing in runtime
@@ -387,7 +416,27 @@ declare function ForeignKey<TOther extends TableClassInterface>(toTable: Class<T
   onUpdate?: ForeignKeyActions;
 }): (table: any, context: any) => void;
 //#endregion
+//#region src/lib/tableInfo/decorators/Index.d.ts
+/**
+ * Decorator function to create an index on one or more columns of a table.
+ * This decorator must be used at the head of the class.
+ *
+ * @param columns - The columns that will be part of the index (in order).
+ * @param options - Additional options. If no name is provided, the name is generated from the table and column names.
+ */
+declare function Index<T extends TableClassInterface>(columns: (keyof T)[], options?: {
+  name?: string;
+  unique?: boolean;
+}): (table: Class<T>, context?: any) => void;
+//#endregion
 //#region src/index.d.ts
+/**
+ * Executes a database migration based on the provided database connection and migration instructions.
+ *
+ * @param db - The database access object used to interact with the database.
+ * @param dbInstructions - The migration instructions, including target version, logger mode, and dialect.
+ * @return A promise that resolves when the migration process is successfully completed.
+ */
 export declare function runMigration(db: DatabaseAccess, dbInstructions: DatabaseInstructions): Promise<void>;
 /**
  * Rolls back the database to the provided toVersion
@@ -398,4 +447,4 @@ export declare function runMigration(db: DatabaseAccess, dbInstructions: Databas
  */
 export declare function rollback(dbAccess: DatabaseAccess, toVersion: number, dialect: DatabaseInstructions["dialect"], loggerMode?: DatabaseInstructions["loggerMode"]): Promise<number>;
 //#endregion
-export { DataType, type DatabaseAccess, type DatabaseInstructions, ForeignKey, type PublicMigrations, type SqlChanges, TableClass, TableObj };
+export { DataType, type DatabaseAccess, type DatabaseInstructions, ForeignKey, Index, type PublicMigrations, type SqlChanges, TableClass, TableObj };

package/dist/index.mjs

@@ -110,6 +110,10 @@ function getTableStructureFromMetadata(metadata) {
 //#endregion
 //#region src/lib/TableStructureGenerator.ts
 /**
+* Postgres silently truncates longer identifiers, which would lead to differing index names in each migration
+*/
+const MAX_INDEX_NAME_LENGTH = 63;
+/**
 * Represents a generator for creating table structures based on specified database instructions
 */
 var TableStructureGenerator = class {
@@ -126,24 +130,55 @@ var TableStructureGenerator = class {
 	*/
 	generateTableStructure() {
 		const tables = {};
+		const indexNames = {};
 		for (const table of this.dbInstructions.tables) {
 			let structure;
+			let tableName;
 			if (TableObjHelper.isTableObj(table)) {
 				structure = table.tableStructure;
-				tables[table.tableName] = table.tableStructure;
+				tableName = table.tableName;
 			} else {
 				const classTable = table;
 				structure = getTableStructure(classTable);
-				tables[classTable.name] = structure;
+				tableName = classTable.name;
 			}
 			for (const key in structure.columns) {
 				const entry = structure.columns[key];
 				entry.defaultValue = entry.inputDefaultValue === null ? this.dialect.nullType : this.dialect.formatValueToSql(entry.inputDefaultValue, entry.inputType);
 				entry.sqlType = this.dialect.getSqlType(entry.inputType, entry);
 			}
+			const indexes = this.getIndexes(tableName, structure);
+			for (const index of indexes) {
+				if (indexNames[index.name]) throw new Error(`Index name "${index.name}" is used in ${indexNames[index.name]} and ${tableName}. Index names need to be unique.`);
+				indexNames[index.name] = tableName;
+			}
+			tables[tableName] = {
+				...structure,
+				indexes
+			};
 		}
 		return tables;
 	}
+	/**
+	* Validates the index definitions of a table and generates names for indexes that have none.
+	*
+	* @param tableName - The name of the table the indexes belong to.
+	* @param structure - The table structure containing the index definitions.
+	* @return The index definitions including their names.
+	*/
+	getIndexes(tableName, structure) {
+		return (structure.indexes ?? []).map((index) => {
+			if (!index.columns.length) throw new Error(`An index in ${tableName} has no columns.`);
+			for (const column of index.columns) if (!structure.columns[column]) throw new Error(`Index in ${tableName} uses column "${column}", which does not exist.`);
+			const name = index.name ?? `${tableName}_${index.columns.join("_")}_idx`;
+			if (name.length > MAX_INDEX_NAME_LENGTH) throw new Error(`Index name "${name}" is longer than ${MAX_INDEX_NAME_LENGTH} characters. Please provide a shorter name.`);
+			return {
+				name,
+				columns: index.columns,
+				isUnique: index.isUnique
+			};
+		});
+	}
 };
 //#endregion
 //#region src/lib/typings/AllowedMigrations.ts
@@ -266,6 +301,7 @@ var Migrations = class {
 	* @param tableName - The name of the table to check the migration against.
 	* @param type - The type of destructive migration being checked.
 	* @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+	* For "dropIndex", the index name is used instead.
 	*/
 	compareWithAllowedMigration(tableName, type, column = NO_COLUMN) {
 		const migrationEntry = this.migrationData[tableName];
@@ -367,6 +403,7 @@ var Migrations = class {
 	* @param tableName - The current table name in the database at the time of the migration version.
 	* @param allowedMigration - The keys representing the migrations to be allowed.
 	* @param column - The column name for which the migration is allowed. Only needed for "dropColumn", "removeForeignKey" and "alterForeignKey".
+	* For "dropIndex", provide the index name instead.
 	*
 	* @throws Error if the provided column name is not valid for the specified migration.
 	*/
@@ -384,6 +421,7 @@ var Migrations = class {
 			case "dropColumn":
 			case "removeForeignKey":
 			case "alterForeignKey": throw new Error(`The ${allowedMigration} migration requires a column name. Please provide one.`);
+			case "dropIndex": throw new Error(`The ${allowedMigration} migration requires an index name. Please provide one.`);
 		}
 	}
 	/**
@@ -652,6 +690,26 @@ var DefaultSql = class {
 		return `ALTER TABLE ${this.formatIdentifier(tableName)} DROP COLUMN ${this.formatIdentifier(columnName)};`;
 	}
 	/**
+	* Statement to create an index on a specified table.
+	*
+	* @param tableName - The name of the table on which the index will be created.
+	* @param index - The index definition.
+	* @return The SQL statement as a string.
+	*/
+	createIndex(tableName, index) {
+		return `CREATE ${index.isUnique ? "UNIQUE " : ""}INDEX ${this.formatIdentifier(index.name)} ON ${this.formatIdentifier(tableName)} (${index.columns.map((column) => this.formatIdentifier(column)).join(", ")});`;
+	}
+	/**
+	* Statement to drop an index from a specified table.
+	*
+	* @param tableName - The name of the table the index belongs to.
+	* @param indexName - The name of the index to be dropped.
+	* @return The SQL statement as a string.
+	*/
+	dropIndex(tableName, indexName) {
+		return `DROP INDEX ${this.formatIdentifier(indexName)};`;
+	}
+	/**
 	* Statement to return data from a table.
 	*
 	* @param tableName - The name of the database table to select data from.
@@ -702,6 +760,24 @@ var DefaultSql = class {
 		]);
 	}
 	/**
+	* Combines rows (one row per indexed column, ordered by index name and column position) into a list of {@link IndexInfo}.
+	*
+	* @param rows - Rows containing the index name, whether the index is unique and the column name.
+	* @return An array of {@link IndexInfo}.
+	*/
+	rowsToIndexInfo(rows) {
+		const indexes = {};
+		for (const row of rows) {
+			if (!indexes[row.index_name]) indexes[row.index_name] = {
+				name: row.index_name,
+				columns: [],
+				isUnique: !!Number(row.is_unique)
+			};
+			indexes[row.index_name].columns.push(row.column_name);
+		}
+		return Object.values(indexes);
+	}
+	/**
 	* Ensures that the migration table exists in the database.
 	* If the table does not exist, it creates the table using the defined migration table query.
 	*
@@ -836,13 +912,22 @@ var MigrationManager = class {
 		} else {
 			Logger.log(`Creating migration SQL from version ${fromVersion} to ${toVersion}`);
 			this.existingTables = (await this.dialect.getTableNames()).filter((oldTableName) => oldTableName != MIGRATION_DATA_TABLE_NAME).map((oldTableName) => this.migrations.getNewestTableName(oldTableName));
+			const renameTablesChanges = this.renameTables();
+			const createAndDropTablesChanges = await this.createAndDropTables();
+			const foreignKeyChanges = await this.migrateForeignKeys();
+			const columnChanges = await this.migrateColumns();
+			const renameColumnsChanges = this.renameColumns();
+			const indexChanges = await this.migrateIndexes();
+			const recreateTablesChanges = await this.recreateTables();
 			[
-				this.renameTables(),
-				await this.createAndDropTables(),
-				await this.migrateForeignKeys(),
-				await this.migrateColumns(),
-				this.renameColumns(),
-				await this.recreateTables()
+				renameTablesChanges,
+				createAndDropTablesChanges,
+				indexChanges.dropped,
+				foreignKeyChanges,
+				columnChanges,
+				renameColumnsChanges,
+				indexChanges.created,
+				recreateTablesChanges
 			].forEach((entry) => {
 				changes.up += entry.up;
 				changes.down += entry.down;
@@ -903,13 +988,14 @@ var MigrationManager = class {
 		for (const tableName in this.newTables) if (this.tableDoesNotExists(tableName)) {
 			const structure = this.newTables[tableName];
 			changes.up += `${this.createTableSql(tableName, structure.columns, structure.foreignKeys)}\n`;
+			changes.up += this.createIndexesSql(tableName, structure.indexes);
 			changes.down += `${this.dialect.dropTable(tableName)}\n`;
 		}
 		for (const tableName of this.existingTables) if (!this.newTables[tableName]) {
 			this.migrations.compareWithAllowedMigration(tableName, "dropTable");
 			const dbTableName = this.migrations.getOldTableName(tableName);
 			changes.up += `${this.dialect.dropTable(tableName)}\n`;
-			changes.down += this.createTableSql(tableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName));
+			changes.down += this.createTableSql(tableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName)) + "\n" + this.createIndexesSql(tableName, await this.dialect.getIndexes(dbTableName));
 		}
 		return changes;
 	}
@@ -933,6 +1019,16 @@ var MigrationManager = class {
 		return this.dialect.createTable(tableName, queryLines);
 	}
 	/**
+	* Generates an SQL string to create all provided indexes on a table.
+	*
+	* @param tableName - The name of the table the indexes belong to.
+	* @param indexes - The index definitions.
+	* @return The SQL string to create the indexes (one statement per line).
+	*/
+	createIndexesSql(tableName, indexes) {
+		return (indexes ?? []).map((index) => `${this.dialect.createIndex(tableName, index)}\n`).join("");
+	}
+	/**
 	* Checks if the specified table does not exist in the list of existing tables.
 	*
 	* @param tableName - The name of the table to check.
@@ -963,9 +1059,9 @@ var MigrationManager = class {
 			const backupTableName = `${tableName}__backup`;
 			const moveDataQuery = this.dialect.insert(backupTableName, this.dialect.insertValues(moveableColumns, this.dialect.select(tableName, moveableColumns))) + "\n" + this.dialect.dropTable(tableName) + "\n" + this.dialect.renameTable(backupTableName, tableName);
 			const structure = this.newTables[tableName];
-			changes.up += this.createTableSql(backupTableName, structure.columns, structure.foreignKeys) + "\n" + moveDataQuery + "\n\n";
+			changes.up += this.createTableSql(backupTableName, structure.columns, structure.foreignKeys) + "\n" + moveDataQuery + "\n" + this.createIndexesSql(tableName, structure.indexes) + "\n";
 			const dbTableName = this.migrations.getOldTableName(tableName);
-			changes.down += this.createTableSql(backupTableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName)) + "\n" + moveDataQuery;
+			changes.down += this.createTableSql(backupTableName, await this.dialect.getColumnInformation(dbTableName), await this.dialect.getForeignKeys(dbTableName)) + "\n" + moveDataQuery + "\n" + this.createIndexesSql(tableName, await this.dialect.getIndexes(dbTableName));
 		}
 		return changes;
 	}
@@ -1079,6 +1175,71 @@ var MigrationManager = class {
 		return changes;
 	}
 	/**
+	* Compares the indexes of all existing tables with their new definitions.
+	* Indexes that are removed or changed have to be allowed (using "dropIndex").
+	* Indexes of tables that will be recreated are only checked, their SQL is generated in {@link recreateTables()}.
+	*
+	* @return SQL changes to drop indexes (needs to run before columns are migrated)
+	* and to create indexes (needs to run after columns were migrated and renamed).
+	*/
+	async migrateIndexes() {
+		const dropped = {
+			up: "\n\n-- Drop indexes\n",
+			down: "\n\n-- Drop indexes\n"
+		};
+		const created = {
+			up: "\n\n-- Create indexes\n",
+			down: "\n\n-- Create indexes\n"
+		};
+		for (const tableName in this.newTables) {
+			if (this.tableDoesNotExists(tableName)) continue;
+			const dbTableName = this.migrations.getOldTableName(tableName);
+			const newIndexes = this.newTables[tableName].indexes ?? [];
+			const oldIndexes = await this.dialect.getIndexes(dbTableName);
+			const isSameIndex = (oldIndex, newIndex) => oldIndex.isUnique == newIndex.isUnique && oldIndex.columns.length == newIndex.columns.length && oldIndex.columns.every((column, i) => this.migrations.getNewestColumnName(tableName, column) == newIndex.columns[i]);
+			const indexesToDrop = [];
+			const indexesToCreate = [];
+			const addedIndexes = newIndexes.filter((newIndex) => !oldIndexes.some((oldIndex) => oldIndex.name == newIndex.name));
+			for (const oldIndex of oldIndexes) {
+				const newIndex = newIndexes.find((entry) => entry.name == oldIndex.name);
+				if (newIndex) {
+					if (isSameIndex(oldIndex, newIndex)) continue;
+					Logger.log(`Index ${oldIndex.name} in ${tableName} will be changed!`);
+					this.migrations.compareWithAllowedMigration(tableName, "dropIndex", oldIndex.name);
+					indexesToCreate.push(newIndex);
+				} else {
+					const renamedIndex = addedIndexes.find((entry) => isSameIndex(oldIndex, entry));
+					if (renamedIndex) {
+						Logger.log(`Index ${oldIndex.name} in ${tableName} will be renamed to ${renamedIndex.name}!`);
+						addedIndexes.splice(addedIndexes.indexOf(renamedIndex), 1);
+						indexesToCreate.push(renamedIndex);
+					} else {
+						Logger.log(`Index ${oldIndex.name} in ${tableName} will be removed!`);
+						this.migrations.compareWithAllowedMigration(tableName, "dropIndex", oldIndex.name);
+					}
+				}
+				indexesToDrop.push(oldIndex);
+			}
+			for (const newIndex of addedIndexes) {
+				Logger.log(`Index ${newIndex.name} in ${tableName} will be added!`);
+				indexesToCreate.push(newIndex);
+			}
+			if (this.migrations.willBeRecreated(tableName)) continue;
+			for (const index of indexesToDrop) {
+				dropped.up += `${this.dialect.dropIndex(tableName, index.name)}\n`;
+				created.down += `${this.dialect.createIndex(dbTableName, index)}\n`;
+			}
+			for (const index of indexesToCreate) {
+				created.up += `${this.dialect.createIndex(tableName, index)}\n`;
+				dropped.down += `${this.dialect.dropIndex(dbTableName, index.name)}\n`;
+			}
+		}
+		return {
+			dropped,
+			created
+		};
+	}
+	/**
 	* Retrieves the name of the primary key column from a list of column information.
 	*
 	* @param columnInfoEntries - An array of ColumnInfo objects containing details about each column.
@@ -1160,7 +1321,8 @@ var TableObj = class TableObj {
 		table: "",
 		primaryKey: void 0,
 		columns: {},
-		foreignKeys: []
+		foreignKeys: [],
+		indexes: []
 	};
 	constructor(tableName, defaultValues) {
 		const addColumnEntry = (key, value) => {
@@ -1219,6 +1381,21 @@ var TableObj = class TableObj {
 		return this;
 	}
 	/**
+	* Creates an index on one or more columns of the current table.
+	*
+	* @param columns - The columns that will be part of the index (in order).
+	* @param options - Optional configurations for the index.
+	* If no name is provided, the name is generated from the table and column names.
+	*/
+	index(columns, options) {
+		this.tableStructure.indexes.push({
+			name: options?.name,
+			columns: columns.map((column) => column.toString()),
+			isUnique: !!options?.unique
+		});
+		return this;
+	}
+	/**
 	* An optional helper function to deal with `TS2589: Type instantiation is excessively deep and possibly infinite. when used as method parameter`
 	* Does nothing in runtime
 	*/
@@ -1268,6 +1445,26 @@ function ForeignKey(toTable, toColumn, options) {
 	};
 }
 //#endregion
+//#region src/lib/tableInfo/decorators/Index.ts
+/**
+* Decorator function to create an index on one or more columns of a table.
+* This decorator must be used at the head of the class.
+*
+* @param columns - The columns that will be part of the index (in order).
+* @param options - Additional options. If no name is provided, the name is generated from the table and column names.
+*/
+function Index(columns, options) {
+	return (table, context) => {
+		const tableInfo = context?.metadata ? getTableStructureFromMetadata(context.metadata) : getTableStructure(table);
+		if (!tableInfo.indexes) tableInfo.indexes = [];
+		tableInfo.indexes.push({
+			name: options?.name,
+			columns: columns.map((column) => column.toString()),
+			isUnique: !!options?.unique
+		});
+	};
+}
+//#endregion
 //#region src/lib/dialects/SqliteDialect.ts
 /**
 * SQLite-specific syntax for SQL queries
@@ -1336,6 +1533,13 @@ var SqliteDialect = class extends DefaultSql {
 			};
 		});
 	}
+	async getIndexes(tableName) {
+		const data = await this.db.runReadStatement(`SELECT il.name AS index_name, il."unique" AS is_unique, ii.name AS column_name
+			FROM pragma_index_list('${tableName}') AS il JOIN pragma_index_info(il.name) AS ii
+			WHERE il.origin = 'c'
+			ORDER BY il.name, ii.seqno;`);
+		return this.rowsToIndexInfo(data);
+	}
 	async setChanges(fromVersion, toVersion, changes) {
 		await this.db.runTransaction(`PRAGMA user_version = ${toVersion};`);
 		await super.setChanges(fromVersion, toVersion, changes);
@@ -1422,6 +1626,18 @@ var PostgresDialect = class extends DefaultSql {
 	removePrimaryKey(tableName, columnName) {
 		return `ALTER TABLE ${tableName} DROP CONSTRAINT ${columnName};\n`;
 	}
+	async getIndexes(tableName) {
+		const data = await this.db.runReadStatement(`SELECT i.relname AS index_name, ix.indisunique AS is_unique, a.attname AS column_name
+			FROM pg_index AS ix
+				JOIN pg_class AS t ON t.oid = ix.indrelid
+				JOIN pg_class AS i ON i.oid = ix.indexrelid
+				JOIN pg_namespace AS n ON n.oid = t.relnamespace
+				JOIN pg_attribute AS a ON a.attrelid = t.oid AND a.attnum = ANY(ix.indkey)
+			WHERE n.nspname = 'public' AND t.relname = '${tableName}' AND NOT ix.indisprimary
+				AND NOT EXISTS (SELECT 1 FROM pg_constraint AS c WHERE c.conindid = ix.indexrelid)
+			ORDER BY i.relname, array_position(ix.indkey::int2[], a.attnum);`);
+		return this.rowsToIndexInfo(data);
+	}
 	async getForeignKeys(tableName) {
 		return (await this.db.runReadStatement(`SELECT
 				tc.table_name AS child_table,
@@ -1514,6 +1730,21 @@ var MySqlDialect = class extends DefaultSql {
 			};
 		});
 	}
+	dropIndex(tableName, indexName) {
+		return `DROP INDEX ${this.formatIdentifier(indexName)} ON ${this.formatIdentifier(tableName)};`;
+	}
+	async getIndexes(tableName) {
+		const data = await this.db.runReadStatement(`SELECT s.INDEX_NAME AS index_name, s.NON_UNIQUE = 0 AS is_unique, s.COLUMN_NAME AS column_name
+			FROM information_schema.STATISTICS AS s
+			WHERE s.TABLE_SCHEMA = (SELECT DATABASE()) AND s.TABLE_NAME = '${tableName}' AND s.INDEX_NAME <> 'PRIMARY'
+				AND NOT EXISTS (
+					SELECT 1 FROM information_schema.KEY_COLUMN_USAGE AS k
+					WHERE k.TABLE_SCHEMA = s.TABLE_SCHEMA AND k.TABLE_NAME = s.TABLE_NAME AND k.REFERENCED_TABLE_NAME IS NOT NULL
+						AND (k.CONSTRAINT_NAME = s.INDEX_NAME OR k.COLUMN_NAME = s.INDEX_NAME)
+				)
+			ORDER BY s.INDEX_NAME, s.SEQ_IN_INDEX;`);
+		return this.rowsToIndexInfo(data);
+	}
 	async getTableNames() {
 		return (await this.db.runReadStatement("SHOW TABLES")).map((entry) => Object.values(entry)[0]);
 	}
@@ -1553,6 +1784,13 @@ function getDialect(db, dialect) {
 }
 //#endregion
 //#region src/index.ts
+/**
+* Executes a database migration based on the provided database connection and migration instructions.
+*
+* @param db - The database access object used to interact with the database.
+* @param dbInstructions - The migration instructions, including target version, logger mode, and dialect.
+* @return A promise that resolves when the migration process is successfully completed.
+*/
 async function runMigration(db, dbInstructions) {
 	Logger.setMode(dbInstructions.loggerMode);
 	const dialect = getDialect(db, dbInstructions.dialect);
@@ -1590,4 +1828,4 @@ async function rollback(dbAccess, toVersion, dialect, loggerMode) {
 	return version;
 }
 //#endregion
-export { DataType, ForeignKey, TableClass, TableObj, rollback, runMigration };
+export { DataType, ForeignKey, Index, TableClass, TableObj, rollback, runMigration };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqlmorpheus",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "author": "JodliDev",
   "keywords": [],
   "license": "MIT",