@mikro-orm/better-sqlite 6.0.0-dev.46 → 6.0.0-dev.47

package/BetterSqliteConnection.js

@@ -11,6 +11,7 @@ class BetterSqliteConnection extends knex_1.AbstractSqlConnection {
         this.getPatchedDialect();
         this.client = this.createKnexClient('better-sqlite3');
         await this.client.raw('pragma foreign_keys = on');
+        this.connected = true;
     }
     getDefaultClientUrl() {
         return '';
@@ -146,6 +147,6 @@ class BetterSqliteConnection extends knex_1.AbstractSqlConnection {
         }
     }
 }
-exports.BetterSqliteConnection = BetterSqliteConnection;
 BetterSqliteConnection.RUN_QUERY_RE = /^insert into|^update|^delete|^truncate/;
-BetterSqliteConnection.RUN_QUERY_RETURNING = /^insert into .* returning .*/;
+BetterSqliteConnection.RUN_QUERY_RETURNING = /^insert into ([\s\S])* returning .*/;
+exports.BetterSqliteConnection = BetterSqliteConnection;

package/BetterSqliteMikroORM.d.ts

@@ -10,6 +10,10 @@ export declare class BetterSqliteMikroORM extends MikroORM<BetterSqliteDriver> {
      * @inheritDoc
      */
     static init<D extends IDatabaseDriver = BetterSqliteDriver>(options?: Options<D>): Promise<MikroORM<D>>;
+    /**
+     * @inheritDoc
+     */
+    static initSync<D extends IDatabaseDriver = BetterSqliteDriver>(options: Options<D>): MikroORM<D>;
 }
 export type BetterSqliteOptions = Options<BetterSqliteDriver>;
 export declare function defineBetterSqliteConfig(options: BetterSqliteOptions): Options<BetterSqliteDriver>;

package/BetterSqliteMikroORM.js

@@ -13,9 +13,15 @@ class BetterSqliteMikroORM extends core_1.MikroORM {
     static async init(options) {
         return super.init(options);
     }
+    /**
+     * @inheritDoc
+     */
+    static initSync(options) {
+        return super.initSync(options);
+    }
 }
-exports.BetterSqliteMikroORM = BetterSqliteMikroORM;
 BetterSqliteMikroORM.DRIVER = BetterSqliteDriver_1.BetterSqliteDriver;
+exports.BetterSqliteMikroORM = BetterSqliteMikroORM;
 /* istanbul ignore next */
 function defineBetterSqliteConfig(options) {
     return (0, core_1.defineConfig)({ driver: BetterSqliteDriver_1.BetterSqliteDriver, ...options });

package/README.md

@@ -2,9 +2,7 @@
   <a href="https://mikro-orm.io"><img src="https://raw.githubusercontent.com/mikro-orm/mikro-orm/master/docs/static/img/logo-readme.svg?sanitize=true" alt="MikroORM" /></a>
 </h1>
 
-TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) 
-and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, 
-MariaDB, PostgreSQL and SQLite databases. 
+TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL and SQLite databases. 
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Nextras Orm](https://nextras.org/orm/).
 
@@ -31,13 +29,9 @@ So what benefits does it bring to us?
 
 ### Implicit Transactions
 
-First and most important implication of having Unit of Work is that it allows handling
-transactions automatically. 
+First and most important implication of having Unit of Work is that it allows handling transactions automatically. 
 
-When you call `em.flush()`, all computed changes are queried inside a database
-transaction (if supported by given driver). This means that you can control the boundaries 
-of transactions simply by calling `em.persistLater()` and once all your changes 
-are ready, calling `flush()` will run them inside a transaction. 
+When you call `em.flush()`, all computed changes are queried inside a database transaction (if supported by given driver). This means that you can control the boundaries of transactions simply by calling `em.persistLater()` and once all your changes are ready, calling `flush()` will run them inside a transaction. 
 
 > You can also control the transaction boundaries manually via `em.transactional(cb)`.
 
@@ -55,9 +49,7 @@ await em.flush();
 
 ### ChangeSet based persistence
 
-MikroORM allows you to implement your domain/business logic directly in the entities. 
-To maintain always valid entities, you can use constructors to mark required properties. 
-Let's define the `User` entity used in previous example:
+MikroORM allows you to implement your domain/business logic directly in the entities. To maintain always valid entities, you can use constructors to mark required properties. Let's define the `User` entity used in previous example:
 
 ```typescript
 @Entity()
@@ -69,10 +61,10 @@ export class User {
   @Property()
   name!: string;
 
-  @OneToOne()
+  @OneToOne(() => Address)
   address?: Address;
 
-  @ManyToMany()
+  @ManyToMany(() => Car)
   cars = new Collection<Car>(this);
 
   constructor(name: string) {
@@ -95,7 +87,9 @@ then call `em.flush()`. This will trigger computing of change sets. Only entitie
 no transaction will be started.
 
 ```typescript
-const user = await em.findOneOrFail(User, 1, ['cars', 'address']);
+const user = await em.findOneOrFail(User, 1, {
+  populate: ['cars', 'address.city'],
+});
 user.title = 'Mr.';
 user.address.street = '10 Downing Street'; // address is 1:1 relation of Address entity
 user.cars.getItems().forEach(car => car.forSale = true); // cars is 1:m collection of Car entities
@@ -110,53 +104,49 @@ await em.flush();
 
 ```sql
 begin;
-update user set title = 'Mr.' where id = 1;
-update user_address set street = '10 Downing Street' where id = 123;
-update car set for_sale = true where id = 1;
-update car set for_sale = true where id = 2;
-update car set for_sale = true where id = 3;
-insert into car (brand, owner) values ('VW', 1);
+update "user" set "title" = 'Mr.' where "id" = 1;
+update "user_address" set "street" = '10 Downing Street' where "id" = 123;
+update "car"
+  set "for_sale" = case
+    when ("id" = 1) then true
+    when ("id" = 2) then true
+    when ("id" = 3) then true
+    else "for_sale" end
+  where "id" in (1, 2, 3)
+insert into "car" ("brand", "owner") values ('VW', 1);
 commit;
 ```
 
-### Only One Instance of Entity
+### Identity Map
 
-Thanks to Identity Map, you will always have only one instance of given entity in one context. 
-This allows for some optimizations (skipping loading of already loaded entities), as well as 
-comparison by identity (`ent1 === ent2`). 
+Thanks to Identity Map, you will always have only one instance of given entity in one context. This allows for some optimizations (skipping loading of already loaded entities), as well as comparison by identity (`ent1 === ent2`). 
 
 ## 📖 Documentation
 
-MikroORM v4 documentation, included in this repo in the root directory, is built with 
-[Jekyll](https://jekyllrb.com/) and publicly hosted on GitHub Pages at https://mikro-orm.io.
-
-There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit messages 
-(via `semantic-release`). 
+MikroORM documentation, included in this repo in the root directory, is built with [Docusaurus](https://docusaurus.io) and publicly hosted on GitHub Pages at https://mikro-orm.io.
 
-> You can browse MikroORM v3 docs at [https://mikro-orm.io/docs/3.6/installation](https://mikro-orm.io/docs/3.6/installation).
-
-> To upgrade to v4, please see the [upgrading guide](https://mikro-orm.io/docs/upgrading-v3-to-v4).
+There is also auto-generated [CHANGELOG.md](CHANGELOG.md) file based on commit messages (via `semantic-release`). 
 
 ## ✨ Core Features
 
-- [Clean and Simple Entity Definition](https://mikro-orm.io/docs/defining-entities/)
-- [Identity Map](https://mikro-orm.io/docs/identity-map/)
-- [Entity References](https://mikro-orm.io/docs/entity-references/)
-- [Using Entity Constructors](https://mikro-orm.io/docs/using-entity-constructors/)
-- [Modelling Relationships](https://mikro-orm.io/docs/relationships/)
-- [Collections](https://mikro-orm.io/docs/collections/)
-- [Unit of Work](https://mikro-orm.io/docs/unit-of-work/)
-- [Transactions](https://mikro-orm.io/docs/transactions/)
-- [Cascading persist and remove](https://mikro-orm.io/docs/cascading/)
-- [Composite and Foreign Keys as Primary Key](https://mikro-orm.io/docs/composite-keys/)
-- [Filters](https://mikro-orm.io/docs/filters/)
-- [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder/)
-- [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate/)
-- [Property Validation](https://mikro-orm.io/docs/property-validation/)
-- [Lifecycle Hooks](https://mikro-orm.io/docs/lifecycle-hooks/)
-- [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js/)
-- [Schema Generator](https://mikro-orm.io/docs/schema-generator/)
-- [Entity Generator](https://mikro-orm.io/docs/entity-generator/)
+- [Clean and Simple Entity Definition](https://mikro-orm.io/docs/defining-entities)
+- [Identity Map](https://mikro-orm.io/docs/identity-map)
+- [Entity References](https://mikro-orm.io/docs/entity-references)
+- [Using Entity Constructors](https://mikro-orm.io/docs/entity-constructors)
+- [Modelling Relationships](https://mikro-orm.io/docs/relationships)
+- [Collections](https://mikro-orm.io/docs/collections)
+- [Unit of Work](https://mikro-orm.io/docs/unit-of-work)
+- [Transactions](https://mikro-orm.io/docs/transactions)
+- [Cascading persist and remove](https://mikro-orm.io/docs/cascading)
+- [Composite and Foreign Keys as Primary Key](https://mikro-orm.io/docs/composite-keys)
+- [Filters](https://mikro-orm.io/docs/filters)
+- [Using `QueryBuilder`](https://mikro-orm.io/docs/query-builder)
+- [Preloading Deeply Nested Structures via populate](https://mikro-orm.io/docs/nested-populate)
+- [Property Validation](https://mikro-orm.io/docs/property-validation)
+- [Lifecycle Hooks](https://mikro-orm.io/docs/lifecycle-hooks)
+- [Vanilla JS Support](https://mikro-orm.io/docs/usage-with-js)
+- [Schema Generator](https://mikro-orm.io/docs/schema-generator)
+- [Entity Generator](https://mikro-orm.io/docs/entity-generator)
 
 ## 📦 Example Integrations
 
@@ -173,27 +163,14 @@ You can find example integrations for some popular frameworks in the [`mikro-orm
 - [NextJS + MySQL](https://github.com/jonahallibone/mikro-orm-nextjs)
 
 ### JavaScript Examples 
-- [Express + MongoDB](https://github.com/mikro-orm/express-js-example-app)
 
-## Articles
-
-- Introducing MikroORM, TypeScript data-mapper ORM with Identity Map
-  - on [medium.com](https://medium.com/dailyjs/introducing-mikro-orm-typescript-data-mapper-orm-with-identity-map-9ba58d049e02)
-  - on [dev.to](https://dev.to/b4nan/introducing-mikroorm-typescript-data-mapper-orm-with-identity-map-pc8)
-- Handling transactions and concurrency in MikroORM
-  - on [medium.com](https://medium.com/dailyjs/handling-transactions-and-concurrency-in-mikro-orm-ba80d0a65805)
-  - on [dev.to](https://dev.to/b4nan/handling-transactions-and-concurrency-in-mikroorm-2cfj)
-- MikroORM 3: Knex.js, CLI, Schema Updates, Entity Generator and more…
-  - on [medium.com](https://medium.com/dailyjs/mikro-orm-3-knex-js-cli-schema-updates-entity-generator-and-more-e51ecbbc508c)
-  - on [dev.to](https://dev.to/b4nan/mikroorm-3-knex-js-cli-schema-updates-entity-generator-and-more-3g56)
+- [Express + MongoDB](https://github.com/mikro-orm/express-js-example-app)
 
 ## 🚀 Quick Start
 
 First install the module via `yarn` or `npm` and do not forget to install the database driver as well:
 
-> Since v4, you should install the driver package, but not the db connector itself,
-> e.g. install `@mikro-orm/sqlite`, but not `sqlite3` as that is already included
-> in the driver package.
+> Since v4, you should install the driver package, but not the db connector itself, e.g. install `@mikro-orm/sqlite`, but not `sqlite3` as that is already included in the driver package.
 
 ```sh
 yarn add @mikro-orm/core @mikro-orm/mongodb     # for mongo
@@ -213,8 +190,7 @@ npm i -s @mikro-orm/core @mikro-orm/postgresql  # for postgresql
 npm i -s @mikro-orm/core @mikro-orm/sqlite      # for sqlite
 ```
 
-Next you will need to enable support for [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html)
-as well as `esModuleInterop` in `tsconfig.json` via:
+Next, if you want to use decorators for your entity definition, you will need to enable support for [decorators](https://www.typescriptlang.org/docs/handbook/decorators.html) as well as `esModuleInterop` in `tsconfig.json` via:
 
 ```json
 "experimentalDecorators": true,
@@ -222,11 +198,11 @@ as well as `esModuleInterop` in `tsconfig.json` via:
 "esModuleInterop": true,
 ```
 
+Alternatively, you can use [`EntitySchema`](https://mikro-orm.io/docs/entity-schema).
+
 Then call `MikroORM.init` as part of bootstrapping your app:
 
-> To access driver specific methods like `em.createQueryBuilder()` we need to specify
-> the driver type when calling `MikroORM.init()`. Alternatively we can cast the 
-> `orm.em` to `EntityManager` exported from the driver package:
+> To access driver specific methods like `em.createQueryBuilder()` we need to specify the driver type when calling `MikroORM.init()`. Alternatively we can cast the `orm.em` to `EntityManager` exported from the driver package:
 > 
 > ```ts
 > import { EntityManager } from '@mikro-orm/postgresql';
@@ -245,14 +221,11 @@ const orm = await MikroORM.init<PostgreSqlDriver>({
 console.log(orm.em); // access EntityManager via `em` property
 ```
 
-There are more ways to configure your entities, take a look at 
-[installation page](https://mikro-orm.io/docs/installation/).
+There are more ways to configure your entities, take a look at [installation page](https://mikro-orm.io/docs/installation/).
 
 > Read more about all the possible configuration options in [Advanced Configuration](https://mikro-orm.io/docs/configuration) section.
 
-Then you will need to fork entity manager for each request so their 
-[identity maps](https://mikro-orm.io/docs/identity-map/) will not collide. 
-To do so, use the `RequestContext` helper:
+Then you will need to fork entity manager for each request so their [identity maps](https://mikro-orm.io/docs/identity-map/) will not collide. To do so, use the `RequestContext` helper:
 
 ```typescript
 const app = express();
@@ -262,15 +235,11 @@ app.use((req, res, next) => {
 });
 ```
 
-> You should register this middleware as the last one just before request handlers and before
-> any of your custom middleware that is using the ORM. There might be issues when you register 
-> it before request processing middleware like `queryParser` or `bodyParser`, so definitely 
-> register the context after them. 
+> You should register this middleware as the last one just before request handlers and before any of your custom middleware that is using the ORM. There might be issues when you register it before request processing middleware like `queryParser` or `bodyParser`, so definitely register the context after them. 
 
 More info about `RequestContext` is described [here](https://mikro-orm.io/docs/identity-map/#request-context).
 
-Now you can start defining your entities (in one of the `entities` folders). This is how
-simple entity can look like in mongo driver:
+Now you can start defining your entities (in one of the `entities` folders). This is how simple entity can look like in mongo driver:
 
 **`./entities/MongoBook.ts`**
 
@@ -287,10 +256,10 @@ export class MongoBook {
   @Property()
   title: string;
 
-  @ManyToOne()
+  @ManyToOne(() => Author)
   author: Author;
 
-  @ManyToMany()
+  @ManyToMany(() => BookTag)
   tags = new Collection<BookTag>(this);
 
   constructor(title: string, author: Author) {
@@ -331,15 +300,11 @@ export class UuidBook {
 }
 ```
 
-More information can be found in
-[defining entities section](https://mikro-orm.io/docs/defining-entities/) in docs.
+More information can be found in [defining entities section](https://mikro-orm.io/docs/defining-entities/) in docs.
 
-When you have your entities defined, you can start using ORM either via `EntityManager`
-or via `EntityRepository`s.
+When you have your entities defined, you can start using ORM either via `EntityManager` or via `EntityRepository`s.
 
-To save entity state to database, you need to persist it. Persist takes care or deciding 
-whether to use `insert` or `update` and computes appropriate change-set. Entity references
-that are not persisted yet (does not have identifier) will be cascade persisted automatically. 
+To save entity state to database, you need to persist it. Persist takes care or deciding whether to use `insert` or `update` and computes appropriate change-set. Entity references that are not persisted yet (does not have identifier) will be cascade persisted automatically. 
 
 ```typescript
 // use constructors in your entities for required parameters
@@ -356,13 +321,13 @@ const book3 = new Book('My Life on The Wall, part 3', author);
 book3.publisher = publisher;
 
 // just persist books, author and publisher will be automatically cascade persisted
-await orm.em.persistAndFlush([book1, book2, book3]);
+await em.persistAndFlush([book1, book2, book3]);
 ```
 
 To fetch entities from database you can use `find()` and `findOne()` of `EntityManager`: 
 
 ```typescript
-const authors = orm.em.find(Author, {});
+const authors = em.find(Author, {}, { populate: ['books'] });
 
 for (const author of authors) {
   console.log(author); // instance of Author entity
@@ -375,16 +340,11 @@ for (const author of authors) {
 }
 ```
 
-More convenient way of fetching entities from database is by using `EntityRepository`, that
-carries the entity name so you do not have to pass it to every `find` and `findOne` calls:
+More convenient way of fetching entities from database is by using `EntityRepository`, that carries the entity name, so you do not have to pass it to every `find` and `findOne` calls:
 
 ```typescript
-const booksRepository = orm.em.getRepository(Book);
-
-// with sorting, limit and offset parameters, populating author references
-const books = await booksRepository.find({ author: '...' }, ['author'], { title: QueryOrder.DESC }, 2, 1);
+const booksRepository = em.getRepository(Book);
 
-// or with options object
 const books = await booksRepository.find({ author: '...' }, { 
   populate: ['author'],
   limit: 1,
@@ -392,17 +352,14 @@ const books = await booksRepository.find({ author: '...' }, {
   orderBy: { title: QueryOrder.DESC },
 });
 
-console.log(books); // Book[]
+console.log(books); // Loaded<Book, 'author'>[]
 ```
 
-Take a look at docs about [working with `EntityManager`](https://mikro-orm.io/docs/entity-manager/)
-or [using `EntityRepository` instead](https://mikro-orm.io/docs/repositories/).
+Take a look at docs about [working with `EntityManager`](https://mikro-orm.io/docs/entity-manager/) or [using `EntityRepository` instead](https://mikro-orm.io/docs/repositories/).
 
 ## 🤝 Contributing
 
-Contributions, issues and feature requests are welcome. Please read 
-[CONTRIBUTING.md](CONTRIBUTING.md) 
-for details on the process for submitting pull requests to us.
+Contributions, issues and feature requests are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for submitting pull requests to us.
 
 ## Authors
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/better-sqlite",
-  "version": "6.0.0-dev.46",
+  "version": "6.0.0-dev.47",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "index.js",
   "module": "index.mjs",
@@ -58,15 +58,15 @@
     "access": "public"
   },
   "dependencies": {
-    "@mikro-orm/knex": "~6.0.0-dev.46",
-    "better-sqlite3": "8.1.0",
+    "@mikro-orm/knex": "~6.0.0-dev.47",
+    "better-sqlite3": "8.2.0",
     "fs-extra": "11.1.0",
     "sqlstring-sqlite": "0.1.1"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^5.6.12"
+    "@mikro-orm/core": "^5.6.15"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "~6.0.0-dev.46"
+    "@mikro-orm/core": "~6.0.0-dev.47"
   }
 }