myorm_pg 1.2.3 → 2.1.0

package/README.md

@@ -11,121 +11,15 @@ npm install myorm_pg
 ```
 
 
-## Usage
+# Usage
 This ORM is based on https://www.nuget.org/packages/Adr.MyORMForPostgreSQL for .NET. The usage is similar.
 
-### ./entities/Person.ts
-
-```typescript
-import { Table, Column, PrimaryKey, DataType, OneToMany, OneToOne, ManyToMany, DBTypes} from 'myorm_pg';
-import { Message } from './Message';
-
-@Table("person_tb")
-export class Person
-{
-    @PrimaryKey()
-    @Column()
-    @DataType(DBTypes.SERIAL)
-    public Id : number;
-
-    @Column()
-    public Name : string;
-
-    @Column("email_address")
-    public Email : string;
-
-    @Column()    
-    public Age : number; 
-    
-
-    @Column()
-    @DataType(DBTypes.INTEGER)
-    public CEP : number; 
-
-
-    @Column()
-    @DataType(DBTypes.TEXTARRAY)
-    public PhoneNumbers : string[];
-
-    @Column()
-    @DataType(DBTypes.INTEGERARRAY)
-    public Documents : number[];
-
-    @Column()
-    @DataType(DBTypes.DATE)
-    public Birth : Date;
-
-
-    @Column()
-    @OneToMany(()=> Message, "From")
-    public MessagesWriten? : Message[];
-
-    @Column()
-    @OneToMany(()=> Message, "To")
-    public MessagesReceived? : Message[];
-
-  
-    constructor(name : string = "", email : string = "", age : number = 1)
-    {
-        this.Id = -1;
-        this.Name = name;
-        this.Email = email;
-        this.Age = age;
-        this.CEP = -1;
-        this.PhoneNumbers = [];
-        this.Birth = new Date(1992,4,23);       
-        this.Documents = []; 
-        this.MessagesReceived = [];
-        this.MessagesWriten = [];
-       
-    }
-       
-
-}
-```
-
-### ./entities/Message.ts
-
-```typescript
-import { Table, Column, PrimaryKey, DataType, ManyToOne, ManyToMany, DBTypes} from 'myorm_pg';
-import { Person } from './Person';
-
-@Table("message_tb")
-export class Message
-{
-    @PrimaryKey()
-    @Column()
-    @DataType(DBTypes.SERIAL)
-    public Id : number = -1;
-
-    @Column()
-    public Message : string;
-
-    @Column()
-    @ManyToOne(()=> Person, "MessagesWriten")
-    public From? : Person;
-
-    @Column()  
-    @ManyToMany(()=> Person, "MessagesReceived")  
-    public To? : Person[];     
-
-
-    constructor(message : string, from? : Person, to? : Person[])
-    {
-        this.Message = message;
-        this.From = from;
-        this.To = to;       
-    }
-       
-
-}
-```
 
 ### Context.ts
 
 ```typescript
 import { PGDBManager, PGDBContext, PGDBSet} from 'myorm_pg';
-import { Message } from './entities/Message';
+import { Message } from './entities/Message'; 
 import { Person } from './entities/Person';
 
 
@@ -143,18 +37,35 @@ export default class Context extends PGDBContext
 }
 ```
 
-### Create a instance of context and update or creare database
-
+# Create a instance of context and update or creare database
+### Create with explicts parameters
+ 
 ```typescript
 
 var context = new Context(PGDBManager.Build("localhost", 5432, "test_db", "username", "password"));
 
 await context.UpdateDatabaseAsync();
 
+```
+
+### Create with enviroment variables 
+
+this method will try get values from __process.env__ keys. The ORM will search for __DB_HOST__, __DB_PORT__, __DB_NAME__, __DB_USER__ and __DB_PASS__
+
+ 
+ 
+```typescript
+
+var context = new Context(PGDBManager.BuildFromEnviroment());
+
+await context.UpdateDatabaseAsync();
+
 
 ```
 
-### Insert entities
+
+
+## Insert entities
 
 ```typescript
 
@@ -170,68 +81,187 @@ await context.Persons.AddAsync(person);
 ```
 
 
-### Insert entities with relation
+## Insert entities with relation
 In this case, all persons will be saved automatically. All persons of __Message.To__ property will have a reference to this message on property 
 __Person.MessagesReceived__ and the person of __Message.From__ will have a reference to this message on __Person.MessagesWriten__ property
 
 ```typescript
-let msg = new Message(
-               "some message to my friends", 
+let msg = new Message("some message to my friends", 
                 new Person("Adriano", "adriano@test.com"), 
                 [
                     new Person("Camila", "camila@test.com"), 
                     new Person("Juliana", "juliana@test.com"), 
                     new Person("Andre", "andre@test.com")
-
-                ]
-                );
+                ]);
 
 await context.Messages.AddAsync(msg);
 
 ```
 
+# where
+
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Value : 'Adriano'
+                                         })
+                                   .ToListAsync();
+
+```
+
+# And
+
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Value : 'Adriano'
+                                         })
+                                    .And({
+                                          Field : 'Email',
+                                          Value : 'adriano@test.com'
+                                         })
+                                   .ToListAsync();
+
+```
+
+
+# Or
+
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Value : 'Adriano'
+                                         })
+                                    .Or({
+                                          Field : 'Email',
+                                          Value : 'adriano@test.com'
+                                         })
+                                   .ToListAsync();
+
+```
+
 
-### Quering entities
+# Operations
+
+### Equals
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Value : 'Adriano'
+                                         })
+                                   .ToListAsync();
+
+```
+
+
+### Not equals
 
 ```typescript
 
-let persons = await context.Persons
-                                     .Where(
-                                           {
-                                                Field : 'Name',                                                 
-                                                Value : 'Adriano'
-                                            })
-                                        .ToListAsync();
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Kind : Operation.NOTEQUALS,
+                                          Value : 'Adriano'
+                                         })
+                                   .ToListAsync();
+
+```
+
+### Contains
+
+```typescript
 
+let persons = await context.Persons.Where({
+                                          Field : 'Email',
+                                          Kind : Operation.CONTAINS,
+                                          Value : 'test@.com'
+                                         })
+                                   .ToListAsync();
 ```
 
 
-### Join
+### Starts with
 
 ```typescript
 
-let persons = await context.Persons
-                                     .Where(
-                                           {
-                                                Field : 'Name',                                                 
-                                                Value : 'Adriano'
-                                            })
-                                        .Join("MessagesReceived")
-                                        .ToListAsync();
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Kind : Operation.STARTWITH,
+                                          Value : 'Adriano'
+                                         })
+                                   .ToListAsync();
+```
+
+
+### Ends with
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Kind : Operation.ENDWITH,
+                                          Value : 'Adriano'
+                                         })
+                                   .ToListAsync();
+```
+
+### Greater 
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Age',
+                                          Kind : Operation.GREATER,
+                                          Value : 30
+                                         })
+                                   .ToListAsync();
+```
+
+### Smaller
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                          Field : 'Name',
+                                          Kind : Operation.SMALLER,
+                                          Value : 'Adriano'
+                                         })
+                                   .ToListAsync();
+
+```
+
+# Join
+
+```typescript
+
+let persons = await context.Persons.Where({
+                                           Field : 'Name',
+                                           Value : 'Adriano'
+                                           })
+                                   .Join("MessagesReceived")
+                                   .ToListAsync(); 
 
 ```
 This query will retrieve from database all persons with name "Adriano" and load all mensagens that this persons are in "To" list.
 
 
-### Order by
+## Order by
 
 ```typescript
 let all = await context.Persons
-                              .OrderBy('Name')
-                              .ToListAsync();
+                       .OrderBy('Name')
+                       .ToListAsync();
 ```
 
-### Order by descending
+## Order by descending
 
 ```typescript
 let all = await context.Persons
@@ -240,7 +270,7 @@ let all = await context.Persons
 ```
 
 
-### Limit
+## Limit
 
 ```typescript
 let all = await context.Persons
@@ -249,59 +279,215 @@ let all = await context.Persons
                               .ToListAsync();
 ```
 
-### Get first or default 
+## Get first or default 
 
 ```typescript
-let person : Person | undefined = await context.Persons
-                              .Where(
-                                     {
+let person  = await context.Persons.Where({
                                         Field : 'Name',                                                 
                                         Value : 'Adriano'
-                                     })
-                              .FirstOrDefaultAsync();
+                                         })
+                                  .FirstOrDefaultAsync();
 ```
 
 
-### Update person
+## Update person
 
 ```typescript
-let person : Person | undefined = await context.Persons
-                              .Where(
-                                     {
-                                        Field : 'Name',                                                 
-                                        Value : 'Adriano'
-                                     })
-   
-                           .FirstOrDefaultAsync();
+let person = await context.Persons.Where({
+                                         Field : 'Name',                                                 
+                                         Value : 'Adriano'
+                                        })   
+                                  .FirstOrDefaultAsync();
 
-if(person)
-{
-     person.Name = "Adriano Marino";
+person.Name = "Adriano Marino";
+await context.Persons.UpdateAsync(person);
 
-     await context.Persons.UpdateAsync(person);
-}
 ```
 
 
 
 
-### Delete
+## Delete
 
 ```typescript
-let person : Person | undefined = await context.Persons
-                              .Where(
-                                     {
-                                        Field : 'Name',                                                 
-                                        Value : 'Adriano'
-                                     })
-   
-                           .FirstOrDefaultAsync();
+let person = await context.Persons.Where({
+                                         Field : 'Name',                                                 
+                                         Value : 'Adriano'
+                                        }).FirstOrDefaultAsync();
+
+await context.Persons.DeleteAsync(person);
+```
+
+
+# Fluent query methods
+
+## Where
+
+```typescript 
+let persons= await context.Persons.WhereField("Name").Constains("Adriano")
+                                  .AndLoadAll("MessagesReceived")
+                                  .ToListAsync();
+```
+
+## And and Or
+
+```typescript 
+ let persons = await context.Persons.WhereField("Name").Constains("Adriano")
+                                    .AndField("Age").IsGreaterThan(30)
+                                    .OrField("Email").Constains("@test.com")
+                                    .AndLoadAll("MessagesReceived")
+                                    .ToListAsync();
+```
+
+## IsInsideIn
+
+```typescript 
+ let persons = await context.Persons.WhereField("Age").IsInsideIn([1,30, 12, 40, 120]).ToListAsync();
+```
+
+### This is equilalent to : 
+
+```typescript 
+let persons  = await context.Persons.Where({Field : 'Age', Value : 1})
+                                    .Or({Field : 'Age', Value : 30})
+                                    .Or({Field : "Age" , Value : 12})
+                                    .Or({Field : "Age" , Value : 40})
+                                    .Or({Field : "Age" , Value : 120})
+                                    .ToListAsync();
+```
+
+## Get null
+
+```typescript
+let persons = await context.Persons.WhereField("MessagesReceived").IsNull().ToListAsync();      
+```  
+
+# Free hand query
+
+```typescript
+ let persons = await context.Persons.WhereAsString(`age > 30 or name ilike '%adriano%'`).ToListAsync();
+
+```
+
+
+# Method to run queries with connection manager system
+
+```typescript
+ let pg_result = await context.ExecuteQuery("select now()");
+
+```
+
+
+# Entities used in this example
+
+
+### ./entities/Person.ts
+
+```typescript
+import { Table, Column, PrimaryKey, DataType, OneToMany, OneToOne, ManyToMany, DBTypes} from 'myorm_pg';
+import { Message } from './Message';
+
+@Table("person_tb")
+export class Person
+{
+    @PrimaryKey()
+    @Column()
+    @DataType(DBTypes.SERIAL)
+    public Id : number;
+
+    @Column()
+    public Name : string;
+
+    @Column("email_address")
+    public Email : string;
+
+    @Column()    
+    public Age : number; 
+    
 
-if(person)
+    @Column()
+    @DataType(DBTypes.INTEGER)
+    public CEP : number; 
+
+
+    @Column()
+    @DataType(DBTypes.TEXTARRAY)
+    public PhoneNumbers : string[];
+
+    @Column()
+    @DataType(DBTypes.INTEGERARRAY)
+    public Documents : number[];
+
+    @Column()
+    @DataType(DBTypes.DATE)
+    public Birth : Date;
+
+
+    @Column()
+    @OneToMany(()=> Message, "From")
+    public MessagesWriten? : Message[];
+
+    @Column()
+    @OneToMany(()=> Message, "To")
+    public MessagesReceived? : Message[];
+
+  
+    constructor(name : string = "", email : string = "", age : number = 1)
+    {
+        this.Id = -1;
+        this.Name = name;
+        this.Email = email;
+        this.Age = age;
+        this.CEP = -1;
+        this.PhoneNumbers = [];
+        this.Birth = new Date(1992,4,23);       
+        this.Documents = []; 
+        this.MessagesReceived = [];
+        this.MessagesWriten = [];
+       
+    }
+       
+
+}
+```
+
+### ./entities/Message.ts
+
+```typescript
+import { Table, Column, PrimaryKey, DataType, ManyToOne, ManyToMany, DBTypes} from 'myorm_pg';
+import { Person } from './Person';
+
+@Table("message_tb")
+export class Message
 {
-     await context.Persons.DeleteAsync(person);
+    @PrimaryKey()
+    @Column()
+    @DataType(DBTypes.SERIAL)
+    public Id : number = -1;
+
+    @Column()
+    public Message : string;
+
+    @Column()
+    @ManyToOne(()=> Person, "MessagesWriten")
+    public From? : Person;
+
+    @Column()  
+    @ManyToMany(()=> Person, "MessagesReceived")  
+    public To? : Person[];     
+
+
+    constructor(message : string, from? : Person, to? : Person[])
+    {
+        this.Message = message;
+        this.From = from;
+        this.To = to;       
+    }
+       
+
 }
 ```
+
 ## Contributing
 
 Pull requests are welcome. For major changes, please open an issue first

package/lib/core/decorators/SchemasDecorators.d.ts

@@ -7,10 +7,13 @@ export default class SchemasDecorators {
     private static _dataTypeAttribute;
     private static _primaryKeyAttribute;
     private static _relationAttribute;
+    private static _notNullAttribute;
     static Table(name?: string): (target: Object) => void;
     static GetTableAttribute(target: Object): string | undefined;
     static Column(name?: string): (target: Object, propertyName: string) => void;
     static GetColumnAttribute(cTor: Function, propertyName: string): string | undefined;
+    static NotNull(): (target: Object, propertyName: string) => void;
+    static AllowNullValue(cTor: Function, propertyName: string): boolean;
     static OneToOne<T>(lazyBuilder: () => {
         new (...args: any[]): T;
     }, property?: keyof T & string): (target: Object, propertyName: string) => void;

package/lib/core/decorators/SchemasDecorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemasDecorators.d.ts","sourceRoot":"","sources":["../../../src/core/decorators/SchemasDecorators.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAElC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAmC;IACjE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAoC;IACnE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAsC;IACvE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAwC;IAC3E,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0C;WAI7D,KAAK,CAAC,IAAI,CAAC,EAAG,MAAM,YAEJ,MAAM;WAMtB,iBAAiB,CAAC,MAAM,EAAG,MAAM,GAAI,MAAM,GAAG,SAAS;WAMvD,MAAM,CAAC,IAAI,CAAC,EAAG,MAAM,YAEL,MAAM,gBAAiB,MAAM;WAM7C,kBAAkB,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,MAAM,GAAG,SAAS;WAM/E,QAAQ,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;WAKzF,SAAS,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;WAK1F,SAAS,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;WAK1F,UAAU,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;IAKzG,OAAO,CAAC,MAAM,CAAC,QAAQ;WAQT,oBAAoB,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI;QAAE,WAAW,EAAE,MAAM;YAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,OAAO,CAAA;SAAC,CAAC;QAAC,QAAQ,EAAG,YAAY,CAAC;QAAC,KAAK,CAAC,EAAG,MAAM,CAAA;KAAE,GAAG,SAAS;WAO5K,UAAU,aAEM,MAAM,gBAAiB,MAAM;WAM7C,YAAY,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,OAAO;WAK9D,iBAAiB,CAAC,IAAI,EAAG;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,OAAO,CAAA;KAAC,GAAI,MAAM,GAAG,SAAS;WAY/E,QAAQ,CAAC,IAAI,EAAG,OAAO,YAEP,MAAM,gBAAiB,MAAM;WAM7C,oBAAoB,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,OAAO,GAAG,SAAS;CAWnG"}
+{"version":3,"file":"SchemasDecorators.d.ts","sourceRoot":"","sources":["../../../src/core/decorators/SchemasDecorators.ts"],"names":[],"mappings":"AACA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,CAAC,OAAO,OAAO,iBAAiB;IAIlC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAmC;IACjE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAoC;IACnE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAsC;IACvE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAwC;IAC3E,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAA0C;IAC3E,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAqC;WAGvD,KAAK,CAAC,IAAI,CAAC,EAAG,MAAM,YAEJ,MAAM;WAOtB,iBAAiB,CAAC,MAAM,EAAG,MAAM,GAAI,MAAM,GAAG,SAAS;WAWvD,MAAM,CAAC,IAAI,CAAC,EAAG,MAAM,YAEL,MAAM,gBAAiB,MAAM;WAO7C,kBAAkB,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,MAAM,GAAG,SAAS;WAU/E,OAAO,aAES,MAAM,gBAAiB,MAAM;WAO7C,cAAc,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,OAAO;WAWhE,QAAQ,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;WAKzF,SAAS,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;WAK1F,SAAS,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;WAK1F,UAAU,CAAC,CAAC,EAAE,WAAW,EAAG,MAAO;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,CAAC,CAAA;KAAC,EAAE,QAAQ,CAAC,EAAG,MAAM,CAAC,GAAG,MAAM;IAKzG,OAAO,CAAC,MAAM,CAAC,QAAQ;WAST,oBAAoB,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI;QAAE,WAAW,EAAE,MAAM;YAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,OAAO,CAAA;SAAC,CAAC;QAAC,QAAQ,EAAG,YAAY,CAAC;QAAC,KAAK,CAAC,EAAG,MAAM,CAAA;KAAE,GAAG,SAAS;WAY5K,UAAU,aAEM,MAAM,gBAAiB,MAAM;WAO7C,YAAY,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,OAAO;WAgB9D,iBAAiB,CAAC,IAAI,EAAG;QAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAI,OAAO,CAAA;KAAC,GAAI,MAAM,GAAG,SAAS;WAY/E,QAAQ,CAAC,IAAI,EAAG,OAAO,YAEP,MAAM,gBAAiB,MAAM;WAO7C,oBAAoB,CAAC,IAAI,EAAG,QAAQ,EAAE,YAAY,EAAG,MAAM,GAAI,OAAO,GAAG,SAAS;CAcnG"}