Skip to content

docs: add TypeORM and MikroORM to READMEs #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
veksen merged 1 commit into from
Feb 26, 2026
Merged

docs: add TypeORM and MikroORM to READMEs #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
22 changes: 14 additions & 8 deletions nodejs/sqlcommenter-nodejs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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 |