# Cloud SQL Node.js Connector Examples

Welcome to the **Cloud SQL Node.js Connector** examples directory. Here you can
find a collection of ready-to-use samples showing how to use the library with
some of the most popular database libraries and frameworks.

## Available Examples

### Prisma

- [MySQL (CommonJS)](./prisma/mysql/connect.cjs)
- [MySQL (ESM)](./prisma/mysql/connect.mjs)
- [MySQL (TypeScript)](./prisma/mysql/connect.ts)
- [PostgreSQL (CommonJS)](./prisma/postgresql/connect.cjs)
- [PostgreSQL (ESM)](./prisma/postgresql/connect.mjs)
- [PostgreSQL (TypeScript)](./prisma/postgresql/connect.ts)

### Knex

- [MySQL (CommonJS)](./knex/mysql2/connect.cjs)
- [MySQL (ESM)](./knex/mysql2/connect.mjs)
- [MySQL (TypeScript)](./knex/mysql2/connect.ts)
- [PostgreSQL (CommonJS)](./knex/pg/connect.cjs)
- [PostgreSQL (ESM)](./knex/pg/connect.mjs)
- [PostgreSQL (TypeScript)](./knex/pg/connect.ts)
- [SQL Server (CommonJS)](./knex/tedious/connect.cjs)
- [SQL Server (ESM)](./knex/tedious/connect.mjs)
- [SQL Server (TypeScript)](./knex/tedious/connect.ts)

### Sequelize

> [!WARNING]
> Sequelize examples require Sequelize >=v7.0.0-alpha.27 (`npm install @sequelize/core`)

- [MySQL (CommonJS)](./sequelize/mysql2/connect.cjs)
- [MySQL (ESM)](./sequelize/mysql2/connect.mjs)
- [MySQL (TypeScript)](./sequelize/mysql2/connect.ts)
- [PostgreSQL (CommonJS)](./sequelize/pg/connect.cjs)
- [PostgreSQL (ESM)](./sequelize/pg/connect.mjs)
- [PostgreSQL (TypeScript)](./sequelize/pg/connect.ts)
- [SQL Server (CommonJS)](./sequelize/tedious/connect.cjs)
- [SQL Server (ESM)](./sequelize/tedious/connect.mjs)
- [SQL Server (TypeScript)](./sequelize/tedious/connect.ts)

### TypeORM

- [MySQL (CommonJS)](./typeorm/mysql2/connect.cjs)
- [MySQL (ESM)](./typeorm/mysql2/connect.mjs)
- [MySQL (TypeScript)](./typeorm/mysql2/connect.ts)
- [PostgreSQL (CommonJS)](./typeorm/pg/connect.cjs)
- [PostgreSQL (ESM)](./typeorm/pg/connect.mjs)
- [PostgreSQL (TypeScript)](./typeorm/pg/connect.ts)
- [SQL Server (CommonJS)](./typeorm/tedious/connect.cjs)
- [SQL Server (ESM)](./typeorm/tedious/connect.mjs)
- [SQL Server (TypeScript)](./typeorm/tedious/connect.ts)