diff --git a/README.md b/README.md index 8cf47454..e4d76c62 100644 --- a/README.md +++ b/README.md @@ -19,5 +19,7 @@ Contains all the various `sqlcommenter-*` implementations. - [X] [Knex.js](nodejs/sqlcommenter-nodejs/packages/sqlcommenter-knex/README.md) - [X] [Sequelize.js](nodejs/sqlcommenter-nodejs/packages/sqlcommenter-sequelize/README.md) - [X] [Drizzle](nodejs/sqlcommenter-nodejs/packages/sqlcommenter-drizzle/README.md) + - [X] [TypeORM](nodejs/sqlcommenter-nodejs/packages/sqlcommenter-typeorm/README.md) + - [X] [MikroORM](nodejs/sqlcommenter-nodejs/packages/sqlcommenter-mikroorm/README.md) - [X] Php - [X] [Laravel](php/sqlcommenter-php/packages/sqlcommenter-laravel) diff --git a/nodejs/sqlcommenter-nodejs/README.md b/nodejs/sqlcommenter-nodejs/README.md index 2b6a812e..d4f8a948 100644 --- a/nodejs/sqlcommenter-nodejs/README.md +++ b/nodejs/sqlcommenter-nodejs/README.md @@ -1,6 +1,9 @@ # sqlcommenter -For drizzle changes, see [packages/sqlcommenter-drizzle](./packages/sqlcommenter-drizzle/README.md) +For Query Doctor packages, see: +- [sqlcommenter-drizzle](./packages/sqlcommenter-drizzle/README.md) +- [sqlcommenter-typeorm](./packages/sqlcommenter-typeorm/README.md) +- [sqlcommenter-mikroorm](./packages/sqlcommenter-mikroorm/README.md) sqlcommenter is a suite of plugins/middleware/wrappers to augment SQL statements from ORMs/Querybuilders with comments that can be used later to correlate user code with SQL statements. @@ -11,13 +14,16 @@ It supports Node v6 and above to use ES6 features. - Sequelize - Knex.js +- Drizzle +- TypeORM +- MikroORM ### Installation -Go into either of the packages [packages/knex](./packages/knex) or [packages/sequelize](./packages/sequelize) -and then you can run respectively - -| Middleware | Command | URL | -| ------------ | -------------------------------------------------- | ------------------------------------------------------------------ | -| Knex.js | `npm install @google-cloud/sqlcommenter-knex` | https://www.npmjs.com/package/@google-cloud/sqlcommenter-knex | -| Sequelize.js | `npm install @google-cloud/sqlcommenter-sequelize` | https://www.npmjs.com/package/@google-cloud/sqlcommenter-sequelize | +| Middleware | Command | URL | +| ------------ | --------------------------------------------------- | ------------------------------------------------------------------ | +| Knex.js | `npm install @google-cloud/sqlcommenter-knex` | https://www.npmjs.com/package/@google-cloud/sqlcommenter-knex | +| Sequelize.js | `npm install @google-cloud/sqlcommenter-sequelize` | https://www.npmjs.com/package/@google-cloud/sqlcommenter-sequelize | +| Drizzle | `npm install @query-doctor/sqlcommenter-drizzle` | https://www.npmjs.com/package/@query-doctor/sqlcommenter-drizzle | +| TypeORM | `npm install @query-doctor/sqlcommenter-typeorm` | https://www.npmjs.com/package/@query-doctor/sqlcommenter-typeorm | +| MikroORM | `npm install @query-doctor/sqlcommenter-mikroorm` | https://www.npmjs.com/package/@query-doctor/sqlcommenter-mikroorm |