{"id":42130,"library":"tsbean-driver-mysql","title":"tsbean-driver-mysql","description":"MySQL driver for TSBean-ORM, a TypeScript ORM. Version 3.0.1 requires tsbean-orm 3.0.0 and Node >= 16. It uses mysql2 under the hood, provides automatic camelCase to snake_case mapping for database identifiers (configurable), and offers full TypeScript support with type enforcement.","status":"active","version":"3.0.1","language":"javascript","source_language":"en","source_url":"https://github.com/AgustinSRG/tsbean-driver-mysql","tags":["javascript","typescript"],"install":[{"cmd":"npm install tsbean-driver-mysql","lang":"bash","label":"npm"},{"cmd":"yarn add tsbean-driver-mysql","lang":"bash","label":"yarn"},{"cmd":"pnpm add tsbean-driver-mysql","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency: core ORM library required to use this driver.","package":"tsbean-orm","optional":false}],"imports":[{"note":"ESM or TypeScript: named import. CommonJS require works but is not recommended.","wrong":"const MySQLDriver = require('tsbean-driver-mysql')","symbol":"MySQLDriver","correct":"import { MySQLDriver } from 'tsbean-driver-mysql'"},{"note":"For type-only imports, use `import type` to avoid bundling issues in TypeScript.","wrong":"import { MySQLDriverConfig } from 'tsbean-driver-mysql'","symbol":"type MySQLDriverConfig","correct":"import type { MySQLDriverConfig } from 'tsbean-driver-mysql'"},{"note":"DataModel and related utilities are from tsbean-orm, not this driver.","wrong":"import { DataModel } from 'tsbean-driver-mysql'","symbol":"DataModel","correct":"import { DataModel, DataFinder, GenericRow, enforceType, DataSource } from 'tsbean-orm'"}],"quickstart":{"code":"import { DataSourceDriver, DataSource } from 'tsbean-orm';\nimport { MySQLDriver } from 'tsbean-driver-mysql';\n\nconst mySource = MySQLDriver.createDataSource({\n  host: process.env.MYSQL_HOST ?? 'localhost',\n  port: parseInt(process.env.MYSQL_PORT ?? '3306'),\n  user: process.env.MYSQL_USER ?? 'root',\n  password: process.env.MYSQL_PASSWORD ?? '',\n  database: process.env.MYSQL_DATABASE ?? 'my_database',\n});\n\nDataSource.set(DataSource.DEFAULT, mySource);\n\nexport { DataSource };","lang":"typescript","description":"Creates a MySQL data source using environment variables for connection parameters, registers it as the default data source with TSBean-ORM."},"warnings":[{"fix":"Set `disableIdentifierConversion: true` in the config to bypass conversion.","message":"Identifier conversion (camelCase ↔ snake_case) is enabled by default. Table/column names in queries and models must follow this mapping.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Install tsbean-orm@3.0.0 alongside this driver.","message":"Peer dependency tsbean-orm must be version 3.0.0 exactly. Incompatible with older or newer major versions.","severity":"breaking","affected_versions":"3.0.x"},{"fix":"Use `import { MySQLDriver } from 'tsbean-driver-mysql'` instead of `require`.","message":"Using `require` style imports may cause issues in TypeScript ESM projects. Prefer ESM imports.","severity":"deprecated","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'16':23 '3.0.0':20 '3.0.1':15 'automat':31 'camelcas':32 'case':35 'configur':40 'databas':38 'driver':3,6 'enforc':48 'full':43 'hood':29 'identifi':39 'javascript':49 'map':36 'mysql':4,5 'mysql2':26 'node':22 'offer':42 'orm':10,13,19 'provid':30 'requir':16 'snake':34 'support':45 'tsbean':2,9,18 'tsbean-driver-mysql':1 'tsbean-orm':8,17 'type':47 'typescript':12,44,50 'use':25 'version':14","created_at":"2026-06-04T18:55:45.890196+00:00","updated_at":"2026-06-04T18:55:45.890196+00:00","problems":[{"fix":"Run `npm install tsbean-driver-mysql tsbean-orm@3.0.0`","cause":"Package not installed or missing peer dependency tsbean-orm.","error":"Cannot find module 'tsbean-driver-mysql'"},{"fix":"Use `import { MySQLDriver } from 'tsbean-driver-mysql'`","cause":"Incorrect import (e.g., default instead of named import).","error":"TypeError: MySQLDriver.createDataSource is not a function"},{"fix":"Ensure the database exists and `database` property is correctly set in the connection options.","cause":"Database name does not exist or connection config missing.","error":"Error: ER_BAD_DB_ERROR: Unknown database '...'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/AgustinSRG/tsbean-driver-mysql","github":"https://github.com/AgustinSRG/tsbean-driver-mysql","docs":null,"changelog":null,"pypi":null,"npm":"tsbean-driver-mysql","openapi_spec":null,"status_page":null,"smithery":null,"categories":["database"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}