CHANGELOG

​0.3.10 (2022-09-19)

Bug Fixes

  • "Cannot commit, no transaction is active" error in sql.js (#9234) (749809a), closes #9100​
  • add missing support for primaryKeyConstraintName property in EntitySchema (cc63961)
  • malformed query when selecting deeply nested embedded entities (#9273) (83f7b88)
  • prototype pollution issue (e3aac27)
  • typescript 4.8 type issues #9331 (#9357) (a1960e1)
  • Update RelationIdLoader to use DriverUtils.getAlias (#9380) (a917d65), closes #9379​

Features

  • orphanedRowAction=disabled (rebase of PR 8285) (#8678) (de15df1)
  • sqlite - deferrable options for foreign keys (#9360) (773a4fe)
  • unify Pool max connection size in supported Drivers (#9305) (48976c2), closes #3388​
  • update db image versions in docker compose (#9367) (f24b262), closes #9326​

​0.3.9 (2022-08-28)

  • fixed regression introduced in 0.3.8 - broken CLI because of #8917 (#9332), closes #9330​

​0.3.8 (2022-08-26)

Bug Fixes

  • allow space and no-space syntaxes for SQLite constraints (#9238) (bb07244), closes #9237​
  • allow where IsNull for ManyToOne relations (#9031) (72728f1), closes #8890​
  • change postgres driver version checking query (#9319) (c4f4650), closes #9318 #9318​
  • don't use temporary table name to create foreign key, unique, check constraint with SQLite (#9185) (e519910), closes #9176​
  • dropIndex now works when providing a tableIndex without name (#8937) (de8aaac)
  • entity manager remove using entity schemas (#9221) (f045536)
  • find query mongodb properly with @DeleteDateColumn() (#9262) (e49d0c8)
  • handle inherited relations insert order (#9242) (14dfadb), closes #9241​
  • handle inherited relations insert order (#9321) (3671887), closes #9242 #9241​
  • pass error to pgpool release (#9209) (eb8f0c6), closes #7792 #5112​
  • QueryBuilder update handles Date objects wrong on a ManyToOne relationship (#8748) (88d0ced), closes #8747​
  • resolve FindOptionsOrder.nulls to allow FIRST/LAST in uppercase (#8978) (5e5abbd), closes #8970​
  • resolve issues with new synonymous for GeometryCollection type in MySQL 8 (#8927) (5ebc626)
  • sqlite temporary tables now honor withoutRowid (#8431) (b8d04dc), closes #8430​
  • support async import for DataSource in CLI #8914 (#8917) (15f90e0)
  • update date utils to parse year correctly for years 1-999 (#9236) (72a0147), closes #9230​

Features

​0.3.7 (2022-06-29)

Bug Fixes

Features

  • add for_key_share ("FOR KEY SHARE") lock mode for postgres driver (#8879) (4687be8), closes #8878​
  • add nativeBinding option to better-sqlite3 driver (#9157) (bcdddc3)
  • add spanner as a db option for the init command (#9121) (e61cade)
  • allow explicitly named primary keys, foreign keys, and indices (#8900) (78df84c), closes #1355​
  • Cloud Spanner support (#8730) (62518ae)
  • fix issues with generated columns and add support in other drivers (#8806) (0418ebc), closes #8761​
  • implement support for relationids in entity schemas (#9129) (e24cced)
  • support TS 4.7+ node16/nodenext module mode (#9043) (862a402)
  • upgrade ioredis to v5 (#8997) (723f1e5)

Performance Improvements

​0.3.6 (2022-04-12)

Features

  • add for_key_share ("FOR KEY SHARE") lock mode for postgres driver (#8879) (4687be8), closes #8878​
  • new driver: Cloud Spanner (#8730) (62518ae)

​0.3.5 (2022-04-05)

Bug Fixes

  • .save repository method not returning generated uuids for aurora-postgres (#8825) (ed06f4c)
  • allow hstore type to use transformers in driver postgres (#8823) (b1a0107)
  • broken shebang parameters of cli-ts-node-commonjs and cli-ts-node-esm on some linux distros (#8821) (c5dfc11), closes #8818​
  • find select object api should support false values #8796 (#8807) (9ac8e9e)
  • resolve missing ConnectionOptions export in index.ts (#8850) (1693a17), closes #8837​
  • save correct discriminator with STI (#8819) (9d1e246), closes #2927​
  • Update DeepPartial for usage of generics with Repository class (#8817) (8ba742e)
  • fixed issue with typeorm init command (#8820)

​0.3.4 (2022-03-26)

Bug Fixes

  • BaseEntity.reload method regression and made findOne to throw error on missing conditions in runtime (#8801) (ee8c1ec)
  • improve DeepPartial recursion (#8732) (0494008), closes #8681​
  • missing timestamp in created migrations filenames (#8802) (ceee439)
  • PoolConnection leaked by MysqlDriver (#8803) (d2cfd22)
  • remove console.log calls from SelectQueryBuilder (#8795) (54c7db4), closes #8792​
  • stop crashing when redis is offline and ignoreErrors on cache options is set (#8725) (edc39d1)

Features

​0.3.3 (2022-03-23)

Bug Fixes

  • improve initialization of custom repository (#8782) (52a641c)
  • resolve entities correctly in datasource when globs are specified (#8778) (a641c5d)

Features

​0.3.2 (2022-03-22)

Bug Fixes

  • broken CLI in ESM projects since version 0.3.0 (#8773) (97699e8)

Features

  • add typeorm CLI variations that include ts-node (#8776) (05fc744)
  • allows user to specify which mysql package should be used (#8771) (35106df)

Reverts

​0.3.1 (2022-03-21)

Bug Fixes

Features

  • new array find operators (ArrayContains, ArrayContainedBy, ArrayOverlap) (#8766) (9f1b8e3):

BREAKING CHANGES

  • we do not call JSON.stringify() to json/jsonb column types in Postgres. Instead, we delegate value directly to underlying pg driver. This is a correct way of handling jsons.
  • array: true must be explicitly defined for array json/jsonb values
  • strings being JSON-stringified must be manually escaped

​0.3.0 (2022-03-17)

Changes in the version includes changes from the next branch and [email protected] version. They were pending their migration from 2018. Finally, they are in the master branch and master version.

Features

  • compilation target now is es2020. This requires Node.JS version 14+
  • TypeORM now properly works when installed within different node_modules contexts (often happen if TypeORM is a dependency of another library or TypeORM is heavily used in monorepo projects)
  • Connection was renamed to DataSource. Old Connection is still there, but now it's deprecated. It will be completely removed in next version. New API:
export const dataSource = new DataSource({
// ... options ...
})
​
// load entities, establish db connection, sync schema, etc.
await dataSource.connect()
Previously, you could use new Connection(), createConnection(), getConnectionManager().create(), etc. They all deprecated in favour of new syntax you can see above.
New way gives you more flexibility and simplicity in usage.
  • new custom repositories syntax:
export const UserRepository = myDataSource.getRepository(UserEntity).extend({
findUsersWithPhotos() {
return this.find({
relations: {
photos: true
}
})
}
})
Old ways of custom repository creation were dropped.
  • added new option on relation load strategy called relationLoadStrategy. Relation load strategy is used on entity load and determines how relations must be loaded when you query entities and their relations from the database. Used on find* methods and QueryBuilder. Value can be set to join or query.
    • join - loads relations using SQL JOIN expression
    • query - executes separate SQL queries for each relation
Default is join, but default can be set in ConnectionOptions:
createConnection({
/* ... */
relationLoadStrategy: "query"
})
Also, it can be set per-query in find* methods:
userRepository.find({
relations: {
photos: true
}
})
And QueryBuilder:
userRepository
.createQueryBuilder()
.setRelationLoadStrategy("query")
For queries returning big amount of data, we recommend to use query strategy, because it can be a more performant approach to query relations.
  • added new findOneBy, findOneByOrFail, findBy, countBy, findAndCountBy methods to BaseEntity, EntityManager and Repository:
const users = await userRepository.findBy({
name: "Michael"
})
Overall find* and count* method signatures where changed, read the "breaking changes" section for more info.
  • new select type signature in FindOptions (used in find* methods):
userRepository.find({
select: {
id: true,
firstName: true,
lastName: true,
}
})
Also, now it's possible to specify select columns of the loaded relations:
userRepository.find({
select: {
id: true,
firstName: true,
lastName: true,
photo: {
id: true,
filename: true,
album: {
id: true,
name: true,
}
}
}
})
  • new relations type signature in FindOptions (used in find* methods):
userRepository.find({
relations: {
contacts: true,
photos: true,
}
})
To load nested relations use a following signature:
userRepository.find({
relations: {
contacts: true,
photos: {
album: true,
},
}
})
  • new order type signature in FindOptions (used in find* methods):
userRepository.find({
order: {
id: "ASC"
}
})
Now supports nested order by-s:
userRepository.find({
order: {
photos: {
album: {
name: "ASC"
},
},
}
})
  • new where type signature in FindOptions (used in find* methods) now allows to build nested statements with conditional relations, for example:
userRepository.find({
where: {
photos: {
album: {
name: "profile"
}
}
}
})
Gives you users who have photos in their "profile" album.
  • FindOperator-s can be applied for relations in where statement, for example:
userRepository.find({
where: {
photos: MoreThan(10),
}
})
Gives you users with more than 10 photos.
  • boolean can be applied for relations in where statement, for example:
userRepository.find({
where: {
photos: true
}
})

BREAKING CHANGES

  • minimal Node.JS version requirement now is 14+
  • drop ormconfig support. ormconfig still works if you use deprecated methods, however we do not recommend using it anymore, because it's support will be completely dropped in 0.4.0. If you want to have your connection options defined in a separate file, you can still do it like this:
import ormconfig from "./ormconfig.json"
​
const MyDataSource = new DataSource(require("./ormconfig.json"))
Or even more type-safe approach with resolveJsonModule in tsconfig.json enabled:
import ormconfig from "./ormconfig.json"
​
const MyDataSource = new DataSource(ormconfig)
But we do not recommend use this practice, because from 0.4.0 you'll only be able to specify entities / subscribers / migrations using direct references to entity classes / schemas (see "deprecations" section).
We won't be supporting all ormconfig extensions (e.g. json, js, ts, yaml, xml, env).
  • support for previously deprecated migrations:* commands was removed. Use migration:* commands instead.
  • all commands were re-worked. Please refer to new CLI documentation.
  • cli option from BaseConnectionOptions (now BaseDataSourceOptions options) was removed (since CLI commands were re-worked).
  • now migrations are running before schema synchronization if you have both pending migrations and schema synchronization pending (it works if you have both migrationsRun and synchronize enabled in connection options).
  • aurora-data-api driver now is called aurora-mysql
  • aurora-data-api-pg driver now is called aurora-postgres
  • EntityManager.connection is now EntityManager.dataSource
  • Repository now has a constructor (breaks classes extending Repository with custom constructor)
  • @TransactionRepository, @TransactionManager, @Transaction decorators were completely removed. These decorators do the things out of the TypeORM scope.
  • Only junction table names shortened.
MOTIVATION: We must shorten only table names generated by TypeORM. It's user responsibility to name tables short if their RDBMS limit table name length since it won't make sense to have table names as random hashes. It's really better if user specify custom table name into @Entity decorator. Also, for junction table it's possible to set a custom name using @JoinTable decorator.
  • findOne() signature without parameters was dropped. If you need a single row from the db you can use a following syntax:
const [user] = await userRepository.find()
This change was made to prevent user confusion. See this issue for details.
  • findOne(id) signature was dropped. Use following syntax instead:
const user = await userRepository.findOneBy({
id: id // where id is your column name
})
This change was made to provide a more type-safe approach for data querying. Due to this change you might need to refactor the way you load entities using MongoDB driver.
  • findOne, findOneOrFail, find, count, findAndCount methods now only accept FindOptions as parameter, e.g.:
const users = await userRepository.find({
where: { /* conditions */ },
relations: { /* relations */ }
})
To supply where conditions directly without FindOptions new methods were added: findOneBy, findOneByOrFail, findBy, countBy, findAndCountBy. Example:
const users = await userRepository.findBy({
name: "Michael"
})
This change was required to simply current find* and count* methods typings, improve type safety and prevent user confusion.
  • findByIds was deprecated, use findBy method instead in conjunction with In operator, for example:
userRepository.findBy({
id: In([1, 2, 3])
})
This change was made to provide a more type-safe approach for data querying.
  • findOne and QueryBuilder.getOne() now return null instead of undefined in the case if it didn't find anything in the database. Logically it makes more sense to return null.
  • findOne now limits returning rows to 1 at database level.
NOTE: FOR UPDATE locking does not work with findOne in Oracle since FOR UPDATE cannot be used with FETCH NEXT in a single query.
  • where in FindOptions (e.g. find({ where: { ... })) is more sensitive to input criteria now.
  • FindConditions (where in FindOptions) was renamed to FindOptionsWhere.
  • null as value in where used in find* methods is not supported anymore. Now you must explicitly use IsNull() operator.
Before:
userRepository.find({
where: {
photo: null
}
})
After:
userRepository.find({
where: {
photo: IsNull()
}
})
This change was made to make it more transparent on how to add "IS NULL" statement to final SQL, because before it bring too much confusion for ORM users.
  • if you had entity properties of a non-primitive type (except Buffer) defined as columns, then you won't be able to use it in find*'s where. Example:
Before for the @Column(/*...*/) membership: MembershipKind you could have a query like:
userRepository.find({
membership: new MembershipKind("premium")
})
now, you need to wrap this value into Equal operator:
userRepository.find({
membership: Equal(new MembershipKind("premium"))
})
This change is due to type-safety improvement new where signature brings.
  • order in FindOptions (used in find* methods) doesn't support ordering by relations anymore. Define relation columns, and order by them instead.
  • where in FindOptions (used in find* methods) previously supported ObjectLiteral and string types. Now both signatures were removed. ObjectLiteral was removed because it seriously breaks the type safety, and string doesn't make sense in the context of FindOptions. Use QueryBuilder instead.
  • MongoRepository and MongoEntityManager now use new types called MongoFindManyOptions and MongoFindOneOptions for their find* methods.
  • primary relation (e.g. @ManyToOne(() => User, { primary: true }) user: User) support is removed. You still have an ability to use foreign keys as your primary keys, however now you must explicitly define a column marked as primary.
Example, before:
@ManyToOne(() => User, { primary: true })
user: User
Now:
@PrimaryColumn()
userId: number
​
@ManyToOne(() => User)
user: User
Primary column name must match the relation name + join column name on related entity. If related entity has multiple primary keys, and you want to point to multiple primary keys, you can define multiple primary columns the same way:
@PrimaryColumn()
userFirstName: string
​
@PrimaryColumn()
userLastName: string
​
@ManyToOne(() => User)
user: User
This change was required to simplify ORM internals and introduce new features.
  • prefix relation id columns contained in embedded entities (#7432)
  • find by Date object in sqlite driver (#7538)
  • issue with non-reliable new Date(ISOString) parsing (#7796)

DEPRECATIONS

  • all CLI commands do not support ormconfig anymore. You must specify a file with data source instance instead.
  • entities, migrations, subscribers options inside DataSourceOptions accepting string directories support is deprecated. You'll be only able to pass entity references in the future versions.
  • all container-related features (UseContainerOptions, ContainedType, ContainerInterface, defaultContainer, useContainer, getFromContainer) are deprecated.
  • EntityManager's getCustomRepository used within transactions is deprecated. Use withRepository method instead.
  • Connection.isConnected is deprecated. Use .isInitialized instead.
  • select in FindOptions (used in find* methods) used as an array of property names is deprecated. Now you should use a new object-literal notation. Example:
Deprecated way of loading entity relations:
userRepository.find({
select: ["id", "firstName", "lastName"]
})
New way of loading entity relations:
userRepository.find({
select: {
id: true,
firstName: true,
lastName: true,
}
})
This change is due to type-safety improvement new select signature brings.
  • relations in FindOptions (used in find* methods) used as an array of relation names is deprecated. Now you should use a new object-literal notation. Example:
Deprecated way of loading entity relations:
userRepository.find({
relations: ["contacts", "photos", "photos.album"]
})
New way of loading entity relations:
userRepository.find({
relations: {
contacts: true,
photos: {
album: true
}
}
})
This change is due to type-safety improvement new relations signature brings.
  • join in FindOptions (used in find* methods) is deprecated. Use QueryBuilder to build queries containing manual joins.
  • Connection, ConnectionOptions are deprecated, new names to use are: DataSource and DataSourceOptions. To create the same connection you had before use a new syntax: new DataSource({ /*...*/ }).
  • createConnection(), createConnections() are deprecated, since Connection is called DataSource now, to create a connection and connect to the database simply do:
const myDataSource = new DataSource({ /*...*/ })
await myDataSource.connect()
  • getConnection() is deprecated. To have a globally accessible connection, simply export your data source and use it in places you need it:
export const myDataSource = new DataSource({ /*...*/ })
// now you can use myDataSource anywhere in your application
  • getManager(), getMongoManager(), getSqljsManager(), getRepository(), getTreeRepository(), getMongoRepository(), createQueryBuilder() are all deprecated now. Use globally accessible data source instead:
export const myDataSource = new DataSource({ /*...*/ })
export const Manager = myDataSource.manager
export const UserRepository = myDataSource.getRepository(UserEntity)
export const PhotoRepository = myDataSource.getRepository(PhotoEntity)
// ...
  • getConnectionManager() and ConnectionManager itself are deprecated - now Connection is called DataSource, and each data source can be defined in exported variable. If you want to have a collection of data sources, just define them in a variable, simply as:
const dataSource1 = new DataSource({ /*...*/ })
const dataSource2 = new DataSource({ /*...*/ })
const dataSource3 = new DataSource({ /*...*/ })
​
export const MyDataSources = {
dataSource1,
dataSource2,
dataSource3,
}
  • getConnectionOptions() is deprecated - in next version we are going to implement different mechanism of connection options loading
  • AbstractRepository is deprecated. Use new way of custom repositories creation.
  • Connection.name and BaseConnectionOptions.name are deprecated. Connections don't need names anymore since we are going to drop all related methods relying on this property.
  • all deprecated signatures will be removed in 0.4.0

EXPERIMENTAL FEATURES NOT PORTED FROM NEXT BRANCH

  • observers - we will consider returning them back with new API in future versions
  • alternative find operators - using $any, $in, $like and other operators in where condition.

​0.2.45 (2022-03-04)

Bug Fixes

  • allow clearing database inside a transaction (#8712) (f3cfdd2), closes #8527​
  • discard duplicated columns on update (#8724) (0fc093d), closes #8723​
  • fix entityManager.getId for custom join table (#8676) (33b2bd7), closes #7736​
  • force web bundlers to ignore index.mjs and use the browser ESM version directly (#8710) (411fa54), closes #8709​

Features

​0.2.44 (2022-02-23)

Bug Fixes

  • alter relation loader to use transforms when present (#8691) (2c2fb29), closes #8690​
  • cannot read properties of undefined (reading 'joinEagerRelations') (136015b)
  • expo driver doesn't work properly because of new beforeMigration() afterMigration() callbacks (#8683) (5a71803)
  • ng webpack default import (#8688) (2d3374b), closes #8674​
  • support imports of absolute paths of ESM files on Windows (#8669) (12cbfcd), closes #8651​

Features

  • add option to upsert to skip update if the row already exists and no values would be changed (#8679) (8744395)
  • allow {delete,insert}().returning() on MariaDB (#8673) (7facbab), closes #7235 #7235​
  • Implement deferrable foreign keys for SAP HANA (#6104) (1f54c70)

​0.2.43 (2022-02-17)

Bug Fixes

  • support require to internal files without explicitly writing .js in the path (#8660) (96aed8a), closes #8656​

Features

Reverts

  • Revert "feat: soft delete recursive cascade (#8436)" (#8654) (6b0b15b), closes #8436 #8654​

​0.2.42 (2022-02-16)

Bug Fixes

  • proper column comment mapping from database to metadata in aurora-data-api (baa5880)
  • add referencedSchema to PostgresQueryRunner (#8566) (c490319)
  • adding/removing @Generated() will now generate a migration to add/remove the DEFAULT value (#8274) (4208393), closes #5898​
  • adds entity-schema support for createForeignKeyConstraints (#8606) (f224f24), closes #8489​
  • allow special keyword as column name for simple-enum type on sqlite (#8645) (93bf96e)
  • correctly handle multiple-row insert for SAP HANA driver (#7957) (8f2ae71)
  • disable SQLite FK checks in synchronize / migrations (#7922) (f24822e)
  • find descendants of a non-existing tree parent (#8557) (cbb61eb), closes #8556​
  • For MS SQL Server use lowercase "sys"."columns" reference. (#8400) (#8401) (e8a0f92)
  • improve DeepPartial type (#8187) (b93416d)
  • Lock peer dependencies versions (#8597) (600bd4e)
  • make EntityMetadataValidator comply with entitySkipConstructor, cover with test (#8445) (3d6c5da), closes #8444​
  • materialized path being computed as "undefined1." (#8526) (09f54e0)
  • MongoConnectionOptions sslCA type mismatch (#8628) (02400da)
  • mongodb repository.find filters soft deleted rows (#8581) (f7c1f7d), closes #7113​
  • [email protected] compatibility support (#8412) (531013b)
  • must invoke key pragma before any other interaction if SEE setted (#8478) (546b3ed), closes #8475​
  • nested eager relations in a lazy-loaded entity are not loaded (#8564) (1cfd7b9)
  • QueryFailedError when tree entity with JoinColumn (#8443) (#8447) (a11c50d)
  • relation id and afterAll hook performance fixes (#8169) (31f0b55)
  • replaced custom uuid generator with uuid library (#8642) (8898a71)
  • single table inheritance returns the same discriminator value error for unrelated tables where their parents extend from the same entity (#8525) (6523fcc), closes #8522​
  • updating with only update: false columns shouldn't trigger @UpdateDateColumn column updation (2834729), closes #8394 #8394 #8394​
  • upsert should find unique index created by one-to-one relation (#8618) (c8c00ba)

Features

Reverts

  • migration:show command must exist with zero status code (Fixes #7349) (#8185) (e0adeee)

BREAKING CHANGES

  • update listeners and subscriber no longer triggered by soft-remove and recover

​0.2.41 (2021-11-18)