f.spilla/typeorm-model-generator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #296 from pc3b3r/relevantTables

Browse Source 
Relevant tables
This commit is contained in:
Paweł Kotarski 2020-09-07 00:46:51 +02:00 committed by GitHub
commit b31081deed
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 153 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/IConnectionOptions.ts
View File

@ -17,6 +17,7 @@ export default interface IConnectionOptions {
schemaName: string;
ssl: boolean;
skipTables: string[];
onlyTables: string[];
}
export function getDefaultConnectionOptions(): IConnectionOptions {
@ -30,6 +31,7 @@ export function getDefaultConnectionOptions(): IConnectionOptions {
schemaName: "",
ssl: false,
skipTables: [],
onlyTables: [],
};
return connectionOptions;
}

34
src/drivers/AbstractDriver.ts
View File

@ -69,8 +69,7 @@ export default abstract class AbstractDriver {
public abstract GetAllTablesQuery: (
schema: string,
dbNames: string,
tableNames: string[]
dbNames: string
) => Promise<
{
TABLE_SCHEMA: string;
@ -188,8 +187,7 @@ export default abstract class AbstractDriver {
);
dbModel = await this.GetAllTables(
sqlEscapedSchema,
connectionOptions.databaseName,
connectionOptions.skipTables
connectionOptions.databaseName
);
await this.GetCoulmnsFromEntity(
dbModel,
@ -210,21 +208,35 @@ export default abstract class AbstractDriver {
);
await this.DisconnectFromServer();
dbModel = AbstractDriver.FindManyToManyRelations(dbModel);
dbModel = AbstractDriver.FilterGeneratedTables(
dbModel,
connectionOptions.skipTables,
connectionOptions.onlyTables
);
return dbModel;
}
static FilterGeneratedTables(
dbModel: Entity[],
skipTables: string[],
onlyTables: string[]
): Entity[] {
return dbModel
.filter((table) => !skipTables.includes(table.sqlName))
.filter(
(table) =>
onlyTables.length === 0 ||
onlyTables.includes(table.sqlName)
);
}
public abstract async ConnectToServer(connectionOptons: IConnectionOptions);
public async GetAllTables(
schema: string,
dbNames: string,
tableNames: string[]
dbNames: string
): Promise<Entity[]> {
const response = await this.GetAllTablesQuery(
schema,
dbNames,
tableNames
);
const response = await this.GetAllTablesQuery(schema, dbNames);
const ret: Entity[] = [] as Entity[];
response.forEach((val) => {
ret.push({

12
src/drivers/MssqlDriver.ts
View File

@ -37,16 +37,8 @@ export default class MssqlDriver extends AbstractDriver {
}
}
public GetAllTablesQuery = async (
schema: string,
dbNames: string,
tableNames: string[]
) => {
public GetAllTablesQuery = async (schema: string, dbNames: string) => {
const request = new this.MSSQL.Request(this.Connection);
const tableCondition =
tableNames.length > 0
? ` AND NOT TABLE_NAME IN ('${tableNames.join("','")}')`
: "";
const response: {
TABLE_SCHEMA: string;
TABLE_NAME: string;
@ -56,7 +48,7 @@ export default class MssqlDriver extends AbstractDriver {
`SELECT TABLE_SCHEMA,TABLE_NAME, table_catalog as "DB_NAME" FROM INFORMATION_SCHEMA.TABLES
WHERE TABLE_TYPE='BASE TABLE' and TABLE_SCHEMA in (${schema}) AND TABLE_CATALOG in (${MssqlDriver.escapeCommaSeparatedList(
dbNames
)}) ${tableCondition}`
)})`
)
).recordset;
return response;

12
src/drivers/MysqlDriver.ts
View File

@ -39,15 +39,7 @@ export default class MysqlDriver extends AbstractDriver {
}
}
public GetAllTablesQuery = async (
schema: string,
dbNames: string,
tableNames: string[]
) => {
const tableCondition =
tableNames.length > 0
? ` AND NOT TABLE_NAME IN ('${tableNames.join("','")}')`
: "";
public GetAllTablesQuery = async (schema: string, dbNames: string) => {
const response = this.ExecQuery<{
TABLE_SCHEMA: string;
TABLE_NAME: string;
@ -57,7 +49,7 @@ export default class MysqlDriver extends AbstractDriver {
WHERE table_type='BASE TABLE'
AND table_schema IN (${MysqlDriver.escapeCommaSeparatedList(
dbNames
)}) ${tableCondition}`);
)})`);
return response;
};

12
src/drivers/OracleDriver.ts
View File

@ -38,22 +38,14 @@ export default class OracleDriver extends AbstractDriver {
}
}
public GetAllTablesQuery = async (
schema: string,
dbNames: string,
tableNames: string[]
) => {
const tableCondition =
tableNames.length > 0
? ` AND NOT TABLE_NAME IN ('${tableNames.join("','")}')`
: "";
public GetAllTablesQuery = async (schema: string, dbNames: string) => {
const response = (
await this.Connection.execute<{
TABLE_SCHEMA: string;
TABLE_NAME: string;
DB_NAME: string;
}>(
`SELECT NULL AS TABLE_SCHEMA, TABLE_NAME, NULL AS DB_NAME FROM all_tables WHERE owner = (select user from dual) ${tableCondition}`
`SELECT NULL AS TABLE_SCHEMA, TABLE_NAME, NULL AS DB_NAME FROM all_tables WHERE owner = (select user from dual)`
)
).rows!;
return response;

12
src/drivers/PostgresDriver.ts
View File

@ -37,22 +37,14 @@ export default class PostgresDriver extends AbstractDriver {
}
}
public GetAllTablesQuery = async (
schema: string,
dbNames: string,
tableNames: string[]
) => {
const tableCondition =
tableNames.length > 0
? ` AND NOT table_name IN ('${tableNames.join("','")}')`
: "";
public GetAllTablesQuery = async (schema: string, dbNames: string) => {
const response: {
TABLE_SCHEMA: string;
TABLE_NAME: string;
DB_NAME: string;
}[] = (
await this.Connection.query(
`SELECT table_schema as "TABLE_SCHEMA",table_name as "TABLE_NAME", table_catalog as "DB_NAME" FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND table_schema in (${schema}) ${tableCondition}`
`SELECT table_schema as "TABLE_SCHEMA",table_name as "TABLE_NAME", table_catalog as "DB_NAME" FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_TYPE='BASE TABLE' AND table_schema in (${schema})`
)
).rows;
return response;

9
src/drivers/SqliteDriver.ts
View File

@ -46,17 +46,12 @@ export default class SqliteDriver extends AbstractDriver {
public async GetAllTables(
schema: string,
dbNames: string,
tableNames: string[]
dbNames: string
): Promise<Entity[]> {
const ret: Entity[] = [] as Entity[];
const tableCondition =
tableNames.length > 0
? ` AND NOT tbl_name IN ('${tableNames.join("','")}')`
: "";
// eslint-disable-next-line camelcase
const rows = await this.ExecQuery<{ tbl_name: string; sql: string }>(
`SELECT tbl_name, sql FROM "sqlite_master" WHERE "type" = 'table' AND name NOT LIKE 'sqlite_%' ${tableCondition}`
`SELECT tbl_name, sql FROM "sqlite_master" WHERE "type" = 'table' AND name NOT LIKE 'sqlite_%'`
);
rows.forEach((val) => {
if (val.sql.includes("AUTOINCREMENT")) {

57
src/index.ts
View File

@ -7,8 +7,8 @@ import IConnectionOptions, {
import IGenerationOptions, {
getDefaultGenerationOptions,
} from "./IGenerationOptions";
import fs = require("fs-extra");
import inquirer = require("inquirer");
import path = require("path");
@ -270,6 +270,12 @@ function checkYargsParameters(options: options): options {
describe:
"Skip schema generation for specific tables. You can pass multiple values separated by comma",
},
tables: {
string: true,
default: options.connectionOptions.onlyTables.join(","),
describe:
"Generate specific tables. You can pass multiple values separated by comma",
},
strictMode: {
choices: ["none", "?", "!"],
default: options.generationOptions.strictMode,
@ -305,7 +311,12 @@ function checkYargsParameters(options: options): options {
if (skipTables.length === 1 && skipTables[0] === "") {
skipTables = []; // #252
}
let tables = argv.tables.split(",");
if (tables.length === 1 && tables[0] === "") {
tables = [];
}
options.connectionOptions.skipTables = skipTables;
options.connectionOptions.onlyTables = tables;
options.generationOptions.activeRecord = argv.a;
options.generationOptions.generateConstructor = argv.generateConstructor;
options.generationOptions.convertCaseEntity = argv.ce as IGenerationOptions["convertCaseEntity"];
@ -441,23 +452,43 @@ async function useInquirer(options: options): Promise<options> {
? "All of them"
: "Ignore specific tables",
message: "Generate schema for tables:",
choices: ["All of them", "Ignore specific tables"],
choices: [
"All of them",
"Ignore specific tables",
"Select specific tables",
],
name: "specyficTables",
type: "list",
},
])
).specyficTables;
if (ignoreSpecyficTables === "Ignore specific tables") {
const { tableNames } = await inquirer.prompt({
default: options.connectionOptions.skipTables.join(","),
message: "Table names(separated by comma)",
name: "tableNames",
type: "input",
});
options.connectionOptions.skipTables = tableNames.split(",");
} else {
options.connectionOptions.skipTables = [];
}
const optionsMapper = {
"All of them": () => {
options.connectionOptions.skipTables = [];
options.connectionOptions.onlyTables = [];
},
"Ignore specific tables": async () => {
const { tableNames } = await inquirer.prompt({
default: options.connectionOptions.skipTables.join(","),
message: "Table names(separated by comma)",
name: "tableNames",
type: "input",
});
options.connectionOptions.skipTables = tableNames.split(",");
},
"Select specific tables": async () => {
const { tableNames } = await inquirer.prompt({
default: options.connectionOptions.onlyTables.join(","),
message: "Table names(separated by comma)",
name: "tableNames",
type: "input",
});
options.connectionOptions.onlyTables = tableNames.split(",");
},
};
await optionsMapper[ignoreSpecyficTables]();
options.generationOptions.resultsPath = (
await inquirer.prompt([

74
test/integration/runTestsFromPath.test.ts
View File

@ -38,22 +38,57 @@ describe("TypeOrm examples", async () => {
const testPartialPath = "test/integration/examples";
await runTestsFromPath(testPartialPath, false);
});
describe("Filtering tables", async () => {
const testPartialPath = "test/integration/examples";
it("skipTables",async ()=>{
const dbDrivers: string[] = GTU.getEnabledDbDrivers();
const modelGenerationPromises = dbDrivers.map(async dbDriver => {
const {
generationOptions,
driver,
connectionOptions
} = await prepareTestRuns(testPartialPath, "sample2-one-to-one", dbDriver);
const dbModel = await dataCollectionPhase(
driver,
{...connectionOptions,
skipTables:["Post"]},
generationOptions
);
expect(dbModel.length).to.equal(6);
// eslint-disable-next-line no-unused-expressions
expect(dbModel.find(x=>x.sqlName==="Post")).to.be.undefined;
});
await Promise.all(modelGenerationPromises);
});
it("onlyTables",async ()=>{
const dbDrivers: string[] = GTU.getEnabledDbDrivers();
const modelGenerationPromises = dbDrivers.map(async dbDriver => {
const {
generationOptions,
driver,
connectionOptions
} = await prepareTestRuns(testPartialPath, "sample2-one-to-one", dbDriver);
const dbModel = await dataCollectionPhase(
driver,
{...connectionOptions,
onlyTables:["Post"]},
generationOptions
);
expect(dbModel.length).to.equal(1);
// eslint-disable-next-line no-unused-expressions
expect(dbModel.find(x=>x.sqlName==="Post")).to.not.be.undefined;
});
await Promise.all(modelGenerationPromises);
})
});
async function runTestsFromPath(
testPartialPath: string,
isDbSpecific: boolean
) {
const resultsPath = path.resolve(process.cwd(), `output`);
if (!fs.existsSync(resultsPath)) {
fs.mkdirSync(resultsPath);
}
const dbDrivers: string[] = GTU.getEnabledDbDrivers();
dbDrivers.forEach(dbDriver => {
const newDirPath = path.resolve(resultsPath, dbDriver);
if (!fs.existsSync(newDirPath)) {
fs.mkdirSync(newDirPath);
}
});
createOutputDirs(dbDrivers);
const files = fs.readdirSync(path.resolve(process.cwd(), testPartialPath));
if (isDbSpecific) {
await runTest(dbDrivers, testPartialPath, files);
@ -64,6 +99,19 @@ async function runTestsFromPath(
}
}
function createOutputDirs(dbDrivers: string[]) {
const resultsPath = path.resolve(process.cwd(), `output`);
if (!fs.existsSync(resultsPath)) {
fs.mkdirSync(resultsPath);
}
dbDrivers.forEach(dbDriver => {
const newDirPath = path.resolve(resultsPath, dbDriver);
if (!fs.existsSync(newDirPath)) {
fs.mkdirSync(newDirPath);
}
});
}
function runTestForMultipleDrivers(
testName: string,
dbDrivers: string[],
@ -350,7 +398,8 @@ async function prepareTestRuns(
databaseType: "mysql",
schemaName: "ignored",
ssl: yn(process.env.MYSQL_SSL, { default: false }),
skipTables: []
skipTables: [],
onlyTables: [],
};
break;
case "mariadb":
@ -363,7 +412,8 @@ async function prepareTestRuns(
databaseType: "mariadb",
schemaName: "ignored",
ssl: yn(process.env.MARIADB_SSL, { default: false }),
skipTables: []
skipTables: [],
onlyTables: []
};
break;

18
test/utils/GeneralTestUtils.ts
View File

@ -31,7 +31,8 @@ export async function createMSSQLModels(
databaseType: "mssql",
schemaName: "dbo,sch1,sch2",
ssl: yn(process.env.MSSQL_SSL, { default: false }),
skipTables: []
skipTables: [],
onlyTables: []
};
await driver.ConnectToServer(connectionOptions);
connectionOptions.databaseName = String(process.env.MSSQL_Database);
@ -83,7 +84,8 @@ export async function createPostgresModels(
databaseType: "postgres",
schemaName: "public,sch1,sch2",
ssl: yn(process.env.POSTGRES_SSL, { default: false }),
skipTables: ["spatial_ref_sys"]
skipTables: ["spatial_ref_sys"],
onlyTables: []
};
await driver.ConnectToServer(connectionOptions);
connectionOptions.databaseName = String(process.env.POSTGRES_Database);
@ -134,7 +136,8 @@ export async function createSQLiteModels(
databaseType: "sqlite",
schemaName: "",
ssl: false,
skipTables: []
skipTables: [],
onlyTables: []
};
const connOpt: ConnectionOptions = {
@ -169,7 +172,8 @@ export async function createMysqlModels(
databaseType: "mysql",
schemaName: "ignored",
ssl: yn(process.env.MYSQL_SSL, { default: false }),
skipTables: []
skipTables: [],
onlyTables: []
};
await driver.ConnectToServer(connectionOptions);
@ -212,7 +216,8 @@ export async function createMariaDBModels(
databaseType: "mariadb",
schemaName: "ignored",
ssl: yn(process.env.MARIADB_SSL, { default: false }),
skipTables: []
skipTables: [],
onlyTables: []
};
await driver.ConnectToServer(connectionOptions);
@ -257,7 +262,8 @@ export async function createOracleDBModels(
databaseType: "oracle",
schemaName: String(process.env.ORACLE_Username),
ssl: yn(process.env.ORACLE_SSL, { default: false }),
skipTables: []
skipTables: [],
onlyTables: []
};
await driver.ConnectToServer(connectionOptions);
connectionOptions.user = String(process.env.ORACLE_Username);