Merge c5a621f into c49e0e4

.gitignore

@@ -2,6 +2,7 @@
 /dist
 /coverage
 /temp
+/tests/generated-entities
 /.idea
 /yarn-error.log
 /.coveralls.yml

ROADMAP.md

@@ -11,16 +11,15 @@ discuss specifics.
 
 - Association scopes
 - Value transformers (e.g. mapping of `Date` object to formatted string)
-- Support for connection pooling in MySQL and PostgresQL
-- Computing schema difference based on current database state
 - Schema sync (allow automatic synchronization during development)
-- Allow generating entities from existing database schema
 - Migrations via `umzug`
 - Improved support for data types like date, time, enum, timestamp
 - Support for RegExp search in SQL drivers
 - Collection expressions - support querying parts of collection
 - Collection pagination
 - Eager loading of associations (allow having some relationship always fetched)
+- Composite primary keys
+- Map collections
+- Single table inheritance #33
 - Embedded entities (allow in-lining child entity into parent one with prefixed keys)
 - Slow query log
-- Optional query params logging

docs/collections.md

@@ -42,7 +42,7 @@ console.log(author.books.contains(book)); // false
 console.log(author.books.count()); // 0
 console.log(author.books.getItems()); // Book[]
 console.log(author.books.getIdentifiers()); // array of string | number
-console.log(author.books.getIdentifiers('_id')); // array of ObjectID
+console.log(author.books.getIdentifiers('_id')); // array of ObjectId
 
 // array access works as well
 console.log(author.books[1]); // Book
@@ -58,7 +58,7 @@ console.log(author.books[12345]); // undefined, even if the collection is not in
 export class Book {
 
   @PrimaryKey()
-  _id: ObjectID;
+  _id: ObjectId;
 
   @ManyToOne()
   author: Author;
@@ -69,7 +69,7 @@ export class Book {
 export class Author {
 
   @PrimaryKey()
-  _id: ObjectID;
+  _id: ObjectId;
 
   @OneToMany({ entity: () => Book, mappedBy: 'author' })
   books = new Collection<Book>(this);
@@ -80,7 +80,7 @@ export class Author {
 ## ManyToMany collections
 
 As opposed to SQL databases, with MongoDB we do not need to have join tables for `ManyToMany` relations. 
-All references are stored as an array of `ObjectID`s on owning entity. 
+All references are stored as an array of `ObjectId`s on owning entity. 
 
 ### Unidirectional
 

docs/defining-entities.md

@@ -15,7 +15,7 @@ to [use entity constructors](entity-constructors.md), just do not forget to spec
 export class Book {
 
   @PrimaryKey()
-  _id: ObjectID;
+  _id: ObjectId;
 
   @Property()
   createdAt = new Date();
@@ -65,7 +65,7 @@ Here is another example of `Author` entity, that was referenced from the `Book`
 export class Author {
 
   @PrimaryKey()
-  _id: ObjectID;
+  _id: ObjectId;
 
   @Property()
   createdAt = new Date();
@@ -141,7 +141,7 @@ primary key and created/updated time.
 export abstract class BaseEntity {
 
   @PrimaryKey()
-  _id: ObjectID;
+  _id: ObjectId;
 
   @Property()
   createdAt = new Date();
@@ -154,7 +154,7 @@ export abstract class BaseEntity {
 
 ## Note about SQL drivers and @PrimaryKey
 
-All entities described above were defined with `_id: ObjectID` primary key - those were Mongo
+All entities described above were defined with `_id: ObjectId` primary key - those were Mongo
 entities. 
 
 For SQL drivers, you will want to define your primary key as `id: number` instead:

docs/entity-constructors.md

@@ -15,7 +15,7 @@ but `publisher` will be optional:
 export class Book {
 
   @PrimaryKey()
-  _id: ObjectID;
+  _id: ObjectId;
 
   @Property()
   title: string;

docs/lifecycle-hooks.md

@@ -6,7 +6,10 @@
 You can use lifecycle hooks to run some code when entity gets persisted. You can mark any of
 entity methods with them, you can also mark multiple methods with same hook.
 
-All hooks support async methods.
+All hooks support async methods with one exception - `@OnInit`.
+
+- `@OnInit` is fired when new instance of entity is created, either manually `em.create()`, or 
+automatically when new entities are loaded from database
 
 - `@BeforeCreate()` and `@BeforeUpdate()` is fired right before we persist the entity in database
 
@@ -20,4 +23,6 @@ removing entity or entity reference, not when deleting records by query.
 - `@AfterDelete()` is fired right after the record gets deleted from database and it is unset from 
 the identity map.
 
+> `@OnInit` is not fired when you create the entity manually via its constructor (`new MyEntity()`)
+
 [← Back to table of contents](index.md#table-of-contents)

docs/usage-with-mongo.md

@@ -22,27 +22,27 @@ When defining entity, do not forget to define primary key like this:
 
 ```typescript
 @PrimaryKey()
-_id: ObjectID;
+_id: ObjectId;
 ```
 
-## ObjectID and string id duality
+## ObjectId and string id duality
 
-Every entity has both `ObjectID` and `string` id available, also all methods of `EntityManager` 
+Every entity has both `ObjectId` and `string` id available, also all methods of `EntityManager` 
 and `EntityRepository` supports querying by both of them. 
 
 ```typescript
 const author = orm.em.getReference('...id...');
 console.log(author.id);  // returns '...id...'
-console.log(author._id); // returns ObjectID('...id...')
+console.log(author._id); // returns ObjectId('...id...')
 
 // all of those will return the same results
 const article = '...article id...'; // string id
 const book = '...book id...'; // string id
 const repo = orm.em.getRepository(Author);
 const foo1 = await repo.find({ id: { $in: [article] }, favouriteBook: book });
-const bar1 = await repo.find({ id: { $in: [new ObjectID(article)] }, favouriteBook: new ObjectID(book) });
+const bar1 = await repo.find({ id: { $in: [new ObjectId(article)] }, favouriteBook: new ObjectId(book) });
 const foo2 = await repo.find({ _id: { $in: [article] }, favouriteBook: book });
-const bar2 = await repo.find({ _id: { $in: [new ObjectID(article)] }, favouriteBook: new ObjectID(book) });
+const bar2 = await repo.find({ _id: { $in: [new ObjectId(article)] }, favouriteBook: new ObjectId(book) });
 ```
 
 ## ManyToMany collections with inlined pivot array