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

added lazy relations

Browse Source
This commit is contained in:
Kononnable 2018-04-22 20:26:59 +02:00
parent 2782efb694
commit 8d18027adf
11 changed files with 140 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -27,25 +27,26 @@ Usage: typeorm-model-generator -h <host> -d <database> -p [port] -u <user> -x
[password] -e [engine]
Options:
-h, --host IP adress/Hostname for database server. [required]
-d, --database Database name. [required]
-u, --user Username for database server. [required]
-x, --pass Password for database server. [required]
-p, --port Port number for database server.
-e, --engine Database engine.
-h, --host IP adress/Hostname for database server. [required]
-d, --database Database name. [required]
-u, --user Username for database server. [required]
-x, --pass Password for database server. [required]
-p, --port Port number for database server.
-e, --engine Database engine.
[choices: "mssql", "postgres", "mysql", "mariadb", "oracle"]
[default: "mssql"]
-o, --output Where to place generated models.
-s, --schema Schema name to create model from. Only for mssql and postgres.
--ssl [boolean] [default: false]
--noConfig Doesn't create tsconfig.json and ormconfig.json
-o, --output Where to place generated models.
-s, --schema Schema name to create model from. Only for mssql and postgres.
--ssl [boolean] [defau lt: false]
--noConfig Doesn't create tsconfig.json and ormconfig.json
[boolean] [default: false]
--cf, --case-file Convert file names to specified case
--cf, --case-file Convert file names to specified case
[choices: "pascal", "param", "camel", "none"] [default: "none"]
--ce, --case-entity Convert class names to specified case
--ce, --case-entity Convert class names to specified case
[choices: "pascal", "camel", "none"] [default: "none"]
--cp, --case-property Convert property names to specified case
[choices: "pascal", "camel", "none"] [default: "none"]
--lazy Generate lazy relations [boolean] [default: false]
```
### Examples

8
src/Engine.ts
View File

@ -124,6 +124,9 @@ export class Engine {
}
return retStr;
});
Handlebars.registerHelper("concat", (stra, strb) => {
return stra + strb;
});
Handlebars.registerHelper("toFileName", str => {
let retStr = "";
switch (this.Options.convertCaseFile) {
@ -160,6 +163,10 @@ export class Engine {
Handlebars.registerHelper("toLowerCase", str => {
return str.toLowerCase();
});
Handlebars.registerHelper("toLazy", str => {
if (this.Options.lazy) return `Promise<${str}>`;
else return str;
});
Handlebars.registerHelper({
eq: function(v1, v2) {
return v1 === v2;
@ -263,4 +270,5 @@ export interface EngineOptions {
convertCaseFile: "pascal" | "param" | "camel" | "none";
convertCaseEntity: "pascal" | "camel" | "none";
convertCaseProperty: "pascal" | "camel" | "none";
lazy: boolean;
}

32
src/drivers/MssqlDriver.ts
View File

@ -284,8 +284,8 @@ ORDER BY
ForeignKeyColumn: string;
TableReferenced: string;
ForeignKeyColumnReferenced: string;
onDelete: "RESTRICT" | "CASCADE" | "SET NULL" | "NO_ACTION";
onUpdate: "RESTRICT" | "CASCADE" | "SET NULL" | "NO_ACTION";
onDelete: "RESTRICT" | "CASCADE" | "SET_NULL" | "NO_ACTION";
onUpdate: "RESTRICT" | "CASCADE" | "SET_NULL" | "NO_ACTION";
object_id: number;
}[] = (await request.query(`select
parentTable.name as TableWithForeignKey,
@ -323,10 +323,30 @@ order by
rels = <RelationTempInfo>{};
rels.ownerColumnsNames = [];
rels.referencedColumnsNames = [];
rels.actionOnDelete =
resp.onDelete == "NO_ACTION" ? null : resp.onDelete;
rels.actionOnUpdate =
resp.onUpdate == "NO_ACTION" ? null : resp.onUpdate;
switch (resp.onDelete) {
case "NO_ACTION":
rels.actionOnDelete = null;
break;
case "SET_NULL":
rels.actionOnDelete = "SET NULL";
break;
default:
rels.actionOnDelete = resp.onDelete;
break;
}
switch (resp.onUpdate) {
case "NO_ACTION":
rels.actionOnUpdate = null;
break;
case "SET_NULL":
rels.actionOnUpdate = "SET NULL";
break;
default:
rels.actionOnUpdate = resp.onUpdate;
break;
}
rels.object_id = resp.object_id;
rels.ownerTable = resp.TableWithForeignKey;
rels.referencedTable = resp.TableReferenced;

4
src/entity.mst
View File

@ -26,8 +26,8 @@ import {Index,Entity, PrimaryColumn, Column, OneToOne, OneToMany, ManyToOne, Man
{{/relations}}{{#relations}}
@{{relationType}}(type=>{{toEntityName relatedTable}}, {{toPropertyName ../name}}=>{{toPropertyName ../name}}.{{#if isOwner}}{{toPropertyName ownerColumn}},{ {{#../isPrimary}}primary:true,{{/../isPrimary}}{{^../is_nullable}} nullable:false,{{/../is_nullable}}{{#actionOnDelete}}onDelete: '{{.}}'{{/actionOnDelete}} }{{else}}{{toPropertyName relatedColumn}}{{#actionOnDelete}},{ onDelete: '{{.}}' }{{/actionOnDelete}}{{/if}}){{#isOwner}}
{{#if isManyToMany}}@JoinTable(){{else}}@JoinColumn({ name:'{{ ../name}}'}){{/if}}{{/isOwner}}
{{#if (or isOneToMany isManyToMany)}}{{toPropertyName ../name}}:{{toEntityName relatedTable}}[];
{{else}}{{toPropertyName ../name}}:{{toEntityName relatedTable}};
{{#if (or isOneToMany isManyToMany)}}{{toPropertyName ../name}}:{{toLazy (concat (toEntityName relatedTable) "[]")}};
{{else}}{{toPropertyName ../name}}:{{toLazy (toEntityName relatedTable)}};
{{/if}}{{/relations}}
{{/Columns}}
}

8
src/index.ts
View File

@ -78,6 +78,11 @@ var argv = Yargs.usage(
describe: "Convert property names to specified case",
choices: ["pascal", "camel", "none"],
default: "none"
})
.option("lazy", {
describe: "Generate lazy relations",
boolean: true,
default: false
}).argv;
var driver: AbstractDriver;
@ -124,7 +129,8 @@ let engine = new Engine(driver, {
noConfigs: argv.noConfig,
convertCaseFile: argv.cf,
convertCaseEntity: argv.ce,
convertCaseProperty: argv.cp
convertCaseProperty: argv.cp,
lazy: argv.ssl
});
console.log(

25
test/integration/examples/sample18-lazy-relations/entity/Author.ts Normal file
View File

@ -0,0 +1,25 @@
import { Column, Entity, Index, PrimaryGeneratedColumn, OneToMany } from "typeorm"
import {Post} from "./Post";
@Entity("Author")
export class Author {
@PrimaryGeneratedColumn()
id: number;
@Column()
name: string;
@OneToMany(type => Post, post => post.author, {
// cascade: true
})
posts: Promise<Post[]>;
// /**
// * You can add this helper method.
// */
// asPromise() {
// return Promise.resolve(this);
// }
}

16
test/integration/examples/sample18-lazy-relations/entity/Category.ts Normal file
View File

@ -0,0 +1,16 @@
import { Column, Entity, Index, PrimaryGeneratedColumn, VersionColumn, ManyToMany } from "typeorm"
import {Post} from "./Post";
@Entity("Category")
export class Category {
@PrimaryGeneratedColumn()
id: number;
@Column()
name: string;
@ManyToMany(type => Post, post => post.Category)
Post: Promise<Post[]>;
}

29
test/integration/examples/sample18-lazy-relations/entity/Post.ts Normal file
View File

@ -0,0 +1,29 @@
import { Column, Entity, Index, PrimaryGeneratedColumn, ManyToOne, ManyToMany, JoinTable } from "typeorm"
import {Author} from "./Author";
import {Category} from "./Category";
@Entity("Post")
export class Post {
@PrimaryGeneratedColumn()
id: number;
@Column()
title: string;
@Column()
text: string;
@ManyToOne(type => Author, author => author.posts, {
// cascade: ["insert"],
onDelete: "SET NULL"
})
author: Promise<Author|null>;
@ManyToMany(type => Category, category => category.Post, {
// cascade: true
})
@JoinTable()
Category: Promise<Category[]>;
}

4
test/integration/integration.test.ts
View File

@ -65,7 +65,9 @@ describe("TypeOrm examples", async function () {
engine = <Engine>{}
break;
}
if (folder=='sample18-lazy-relations') {
engine.Options.lazy=true;
}
let result = await engine.createModelFromDatabase()

7
test/utils/EntityFileToJson.ts
View File

@ -301,7 +301,12 @@ export class EntityFileToJson {
} else if (trimmedLine.split(':').length - 1 > 0) {
retVal.columns[retVal.columns.length - 1].columnName = trimmedLine.split(':')[0].trim();
//TODO:Should check if null only column is nullable?
retVal.columns[retVal.columns.length - 1].columnTypes = trimmedLine.split(':')[1].split(';')[0].trim().split('|').map(function (x) {
let colTypes=trimmedLine.split(':')[1].split(';')[0].trim();
if (colTypes.startsWith('Promise<')) {
colTypes=colTypes.substring(8,colTypes.length-1)
retVal.columns[retVal.columns.length - 1].columnOptions.isLazy=true;
}
retVal.columns[retVal.columns.length - 1].columnTypes = colTypes.split('|').map(function (x) {
if (x == 'any') {
x = 'string' //for json columns
}

5
test/utils/GeneralTestUtils.ts
View File

@ -63,6 +63,7 @@ export async function createMSSQLModels(filesOrgPath: string, resultsPath: strin
convertCaseEntity: 'none',
convertCaseFile: 'none',
convertCaseProperty: 'none',
lazy:false
});
conn = await createConnection(connOpt)
@ -126,6 +127,7 @@ export async function createPostgresModels(filesOrgPath: string, resultsPath: st
convertCaseEntity: 'none',
convertCaseFile: 'none',
convertCaseProperty: 'none',
lazy:false
});
conn = await createConnection(connOpt)
@ -182,6 +184,7 @@ export async function createMysqlModels(filesOrgPath: string, resultsPath: strin
convertCaseEntity: 'none',
convertCaseFile: 'none',
convertCaseProperty: 'none',
lazy:false
});
@ -231,6 +234,7 @@ export async function createMariaDBModels(filesOrgPath: string, resultsPath: str
convertCaseEntity: 'none',
convertCaseFile: 'none',
convertCaseProperty: 'none',
lazy:false
});
@ -282,6 +286,7 @@ export async function createOracleDBModels(filesOrgPath: string, resultsPath: st
convertCaseEntity: 'none',
convertCaseFile: 'none',
convertCaseProperty: 'none',
lazy:false
});
return engine;