{"id":24811242,"url":"https://github.com/lukks/like-mysql","last_synced_at":"2025-07-01T12:03:54.706Z","repository":{"id":44645050,"uuid":"219451040","full_name":"LuKks/like-mysql","owner":"LuKks","description":"Simple and intuitive ORM for MySQL","archived":false,"fork":false,"pushed_at":"2024-04-26T00:34:46.000Z","size":107,"stargazers_count":25,"open_issues_count":2,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-15T02:17:26.015Z","etag":null,"topics":["intuitive","like","mysql","mysql2","orm","simple"],"latest_commit_sha":null,"homepage":"https://npmjs.com/like-mysql","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LuKks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-04T08:21:49.000Z","updated_at":"2025-01-10T13:19:17.000Z","dependencies_parsed_at":"2024-11-15T04:53:50.578Z","dependency_job_id":"6b6f0950-2e12-40eb-8116-c6f730eaf922","html_url":"https://github.com/LuKks/like-mysql","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LuKks/like-mysql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuKks%2Flike-mysql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuKks%2Flike-mysql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuKks%2Flike-mysql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuKks%2Flike-mysql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LuKks","download_url":"https://codeload.github.com/LuKks/like-mysql/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuKks%2Flike-mysql/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262959563,"owners_count":23391057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["intuitive","like","mysql","mysql2","orm","simple"],"created_at":"2025-01-30T12:19:44.090Z","updated_at":"2025-07-01T12:03:54.678Z","avatar_url":"https://github.com/LuKks.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# like-mysql\n\nSimple and intuitive ORM for MySQL\n\n![](https://img.shields.io/npm/v/like-mysql.svg) ![](https://img.shields.io/npm/dt/like-mysql.svg) ![](https://img.shields.io/badge/tested_with-tape-e683ff.svg) ![](https://img.shields.io/github/license/LuKks/like-mysql.svg)\n\n```javascript\nconst mysql = require('like-mysql')\n\n// create a pool easily with good defaults\nconst db = mysql('127.0.0.1:3306', 'root', 'secret', 'myapp')\n\n// wait until a connection is established\nawait db.ready()\n\n// INSERT INTO `ips` (`addr`, `hits`) VALUES (?, ?)\nconst id = await db.insert('ips', { addr: req.ip, hits: 0 })\n\n// SELECT `addr`, `hits` FROM `ips` WHERE addr = ?\nconst rows = await db.select('ips', ['addr', 'hits'], 'addr = ?', req.ip)\n\n// SELECT `addr`, `hits` FROM `ips` WHERE addr = ? LIMIT 1\nconst row = await db.selectOne('ips', ['addr', 'hits'], 'addr = ?', req.ip)\n\n// SELECT EXISTS(SELECT 1 FROM `ips` WHERE addr = ? LIMIT 1)\nconst exists = await db.exists('ips', 'addr = ?', req.ip)\n\n// SELECT COUNT(1) FROM `ips` WHERE addr = ?\nconst count = await db.count('ips', 'addr = ?', req.ip)\n\n// UPDATE `ips` SET `hits` = ? WHERE addr = ? LIMIT 1\nawait db.update('ips', { hits: 1 }, 'addr = ? LIMIT 1', req.ip)\n\n// UPDATE `ips` SET `hits` = hits + ? WHERE addr = ?\nawait db.update('ips', [{ hits: 'hits + ?' }, 1], 'addr = ?', req.ip)\n\n// DELETE FROM `ips` WHERE addr = ? LIMIT 1\nawait db.delete('ips', 'addr = ? LIMIT 1', req.ip)\n\n// getConnection, beginTransaction, callback, commit/rollback, release\nawait db.transaction(async function (conn) {\n  const id = await conn.insert('users', { username: 'lukks', ... })\n  await conn.insert('profiles', { owner: id, ... })\n})\n\n// execute\nconst [res, fields] = await db.execute('SELECT * FROM `ips` WHERE `addr` = ?', [req.ip])\n\n// query\nconst [res, fields] = await db.query('SELECT * FROM `ips` WHERE `addr` = \"8.8.8.8\"')\n\n// end pool\nawait db.end()\n```\n\n## Install\n```\nnpm i like-mysql\n```\n\n## Description\n[node-mysql2](https://github.com/sidorares/node-mysql2) is used to create the MySQL pool.\\\n[like-sql](https://github.com/lukks/like-sql) is used to build the SQL queries.\\\nOperations are prepared statements made by `execute`.\\\nPromise version. All custom methods are also promised.\n\nAutomatic `WHERE` when `find` argument doesn't start with:\\\n`ORDER BY`, `LIMIT` or `GROUP BY`\n\n## Examples\n#### constructor\n```javascript\n// host:port\nconst db = mysql('127.0.0.1:3306', 'root', 'secret', 'mydb')\n\n// socketPath\nconst db = mysql('/var/lib/mysql/mysql.sock', 'root', 'secret', 'mydb')\n```\n\n#### ready\nWait for database started by docker-compose, etc.\n```javascript\n// default timeout (15s)\nawait db.ready() // will throw in case is not able to connect\n\n// custom timeout\nawait db.ready(5000)\n```\n\n#### insert\n```javascript\n// with autoincrement id:\nconst insertId = await db.insert('ips', { addr: req.ip, hits: 0 })\nconsole.log(insertId) // =\u003e 1336\n\n// otherwise it always returns zero:\nconst insertId = await db.insert('config', { key: 'title', value: 'Database' })\nconsole.log(insertId) // =\u003e 0\n```\n\n#### select\n```javascript\nconst rows = await db.select('ips', ['*'], 'addr = ?', req.ip)\nconsole.log(rows) // =\u003e [{ id: 2, addr: '8.8.4.4', hits: 2 }]\n\nconst rows = await db.select('ips', ['addr', 'hits'], 'ORDER BY hits DESC')\nconsole.log(rows) // =\u003e [{ addr: '8.8.8.8', hits: 6 }, { addr: '8.8.4.4', hits: 2 }, ...]\n```\n\n#### selectOne\n```javascript\nconst row = await db.selectOne('ips', ['addr', 'hits'], 'addr = ?', req.ip)\nconsole.log(row) // =\u003e { addr: '8.8.4.4', hits: 2 }\n\nconst row = await db.selectOne('ips', ['addr', 'hits'], 'addr = ?', '0.0.0.0')\nconsole.log(row) // =\u003e undefined\n```\n\n#### exists\n```javascript\nconst exists = await db.exists('ips', 'addr = ?', req.ip)\nconsole.log(exists) // =\u003e true\n```\n\n#### count\n```javascript\nconst total = await db.count('ips', 'addr = ?', req.ip)\nconsole.log(total) // =\u003e 2\n```\n\n#### update\n```javascript\nconst changedRows = await db.update('ips', { hits: 1 }, 'addr = ?', req.ip)\nconsole.log(changedRows) // =\u003e 1\n\nconst changedRows = await db.update('ips', [{ hits: 'hits + ?' }, 1], 'addr = ?', req.ip)\nconsole.log(changedRows) // =\u003e 1\n```\n\n#### delete\n```javascript\nconst affectedRows = await db.delete('ips', 'addr = ?', req.ip)\nconsole.log(affectedRows) // =\u003e 1\n```\n\n#### transaction\nNormally with a pool you do something like:\n- `conn = pool.getConnection()`\n- `conn.beginTransaction()`\n- `conn.execute('INSERT INTO users (username, password) VALUES (?, ?)')`\n- `conn.execute('INSERT INTO profile (owner, name) VALUES (?, ?)')`\n- `conn.commit()`\n- `conn.release()`\n\nAlso checking different catchs to release and/or rollback.\n\nThis method simplifies all that and you just do the important part:\n```javascript\nawait db.transaction(async function (conn) {\n  const id = await conn.insert('users', { username: 'lukks', ... })\n  await conn.insert('profiles', { owner: id, ... })\n})\n```\n\nYou can also return a custom value:\n```javascript\nconst result = await db.transaction(async function (conn) {\n  await conn.insert(...)\n  return 'custom value'\n})\n\nconsole.log(result) // =\u003e 'custom value'\n```\n\n#### end\n```javascript\nawait db.end()\n```\n\n## Tests\nStart a database instance\n```\ndocker run --rm -p 3305:3306 -e MYSQL_ROOT_USER=root -e MYSQL_ROOT_PASSWORD=secret -d mysql:8.0\n```\n\nRun tests\n```\nnpm test\n```\n\nStop container and due --rm will be auto deleted\n```\ndocker ps\ndocker stop cc6\n```\n\n## License\nCode released under the [MIT License](https://github.com/LuKks/like-mysql/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukks%2Flike-mysql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukks%2Flike-mysql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukks%2Flike-mysql/lists"}