[{"_1":2,"_164":-5,"_165":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_91":-5,"_92":93,"_132":-5,"_133":11,"_134":17,"_135":11,"_136":-5,"_137":11,"_138":-5,"_139":140},"canonicalUrl","https://hub.docker.com/r/yutak23/serverless-mysql-http/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","yutak23","reponame","serverless-mysql-http","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_46":47,"_49":50,"_51":52,"_53":11,"_54":55,"_56":57,"_58":59,"_39":31,"_28":29,"_61":62,"_63":48,"_64":65,"_66":67,"_68":69,"_70":-5,"_71":65,"_72":73,"_74":11,"_75":29,"_76":77,"_82":11,"_83":84,"_88":29,"_89":90},"categories",[38,43],{"_39":40,"_41":42},"name","Developer tools","slug","developer-tools",{"_39":44,"_41":45},"Databases & storage","databases-and-storage","content_types",[48],"image","date_registered","2023-11-22T06:35:44.406156Z","description","This is an emulator for the serverless driver of PlanetScale and TiDB.","is_private","last_updated","2024-07-03T01:18:03.886921Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[60],"application/vnd.docker.container.image.v1+json","pull_count",2016,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","## Serverless MySQL HTTP (SMH)\n\nThis is an emulator for the `serverless driver` of [PlanetScale](https://planetscale.com/) and [TiDB](https://docs.pingcap.com/), which are serverless MySQL services. \nBy using this, you can proxy HTTP requests to requests for a MySQL server like Docker.\n\nThe goal of this project is to enable local development in the same way as connecting to PlanetScale or TiDB, without actually connecting to them.\n\n## Motivation (Why I develop this service)\n\n### Problem 😕\n\nThere may be times when you don't want to connect to the PlanetScale from your local development environment for reasons such as:\n\n- There is a risk of unintended billing (to reduce unnecessary spending)\n- In large-scale development, issuing id and password to connect to the production service can be cumbersome\n- Want to reduce development time and improve product velocity by developing and testing locally, like [LocalStack](https://www.localstack.cloud/) in AWS or [Firebase Local Emulator Suite](https://firebase.google.com/docs/emulator-suite) in Firebase\n\nIt seems that there are challenges to developing in a local environment while connected to PlanetScale.\n\n### Solution 😄\n\nBy using this service, requests to PlanetScale are proxied to a MySQL server in your local environment. This means that you can complete development in your local environment without having to connect to PlanetScale.\n\n- Before: \\ ++(HTTP)++ \\\n- **After: \\ ++(HTTP)++ ++(MySQL protocol)++ **\n\n## How to use\n\n### How to use with the [`@planetscale/database`](https://github.com/planetscale/database-js) SDK\n\nSimply set the REST URL to the location where SMH is running. For example,\n\n```ts\nimport { connect } from '@planetscale/database';\n\nconst config = { host: '', username: '', password: '' };\nif (import.meta.env.DEV) config.url = 'http://localhost:6306';\n\nconst conn = connect(config);\nconst results = await conn.execute('select 1 from dual where 1=?', [1]);\nconsole.log(results);\n```\n\nIf you only want to make this setting in your local environment, it's convenient to use `import.meta.env.DEV` from [Env Variables](https://vitejs.dev/guide/env-and-mode#env-variables) if you're using Vite. And you can probably implement it in the same way with `process.env.NODE_ENV` or similar.\n\n※The connection information to the MySQL server is set by SMH environment variables (see [Configuration](#configuration) section), so `host`, `user`, and `password` passed to `connect(config)` are not used. In other words, when you are developing in a local environment, you can specify anything in `host`, `name`, and `password`.\n\n### How to use with the [`@tidbcloud/serverless`](https://github.com/tidbcloud/serverless-js)\n\nFirst, with `@tidbcloud/serverless`, requests to the domain have the `http-` prefix, so set `http-localhost` to resolve to `127.0.0.1`.\n\nOn Linux, you can modify `/etc/hosts` as follows:\n\n```\n127.0.0.1 http-localhost\n```\n\nor\n\n```console\n$ sudo echo \"127.0.0.1 http-localhost\" | sudo tee -a /etc/hosts\n```\n\nThen, just specify `localhost` as the host to initialize as follows. This allows development in a local environment just like connecting to TiDB.\n\n```js\nimport { connect } from '@tidbcloud/serverless';\n\nif (import.meta.env.DEV) {\n\t// For using SMH,\n\t// \tit is necessary to allow self-signed server certificates during HTTPS communication.\n\t// https://github.com/orgs/nodejs/discussions/44038\n\tconst { Agent, setGlobalDispatcher } = await import('undici');\n\tconst agent = new Agent({\n\t\tconnect: {\n\t\t\trejectUnauthorized: false\n\t\t}\n\t});\n\tsetGlobalDispatcher(agent);\n}\n\nconst conn = connect({\n\thost: 'localhost',\n\tusername: '',\n\tpassword: '',\n\tdatabase: ''\n});\nconst results = await conn.execute('select * from users where id=?', [1]);\nconsole.log(results);\n```\n\nIf you only want to make this setting in your local environment, it's convenient to use `import.meta.env.DEV` from [Env Variables](https://vitejs.dev/guide/env-and-mode#env-variables) if you're using Vite. And you can probably implement it in the same way with `process.env.NODE_ENV` or similar.\n\n※The connection information to the MySQL server is set by SMH environment variables (see [Configuration](#configuration) section), so `user`, and `password` passed to `connect(config)` are not used. In other words, when you are developing in a local environment, you can specify anything in `name`, and `password`.\n\n**注** \nSMH uses a self-signed SSL certificate, so there will be errors in `fetch` requests used internally by `@tidbcloud/serverless`. Therefore, it is necessary to use the configuration with [undici](https://github.com/nodejs/undici).\n\n### Set up SMH\n\nTo start SMH, a MySQL server that can be connected from SMH must also be started at the same time. Do not forget to start the MySQL server.\n\nWill the MySQL server exist separately or will it be started at the same time with `docker compose`? The method differs depending on that.\n\n#### Docker\n\nIf you have a MySQL server locally, you can start an SMH container that connects to it. In this example, SMH runs on port 6306.\n\n```console\n$ docker run \\\n -d -it -p 6000:6000 -p 6443:6443 \\\n -e MYSQL_DATABASE= \\\n -e MYSQL_HOST= \\\n yutak23/serverless-mysql-http:latest\n```\n\nSee [Configuration](#configuration) for information on setting up a connection to the MySQL server.\n\nLink to the Docker hub: https://hub.docker.com/r/yutak23/serverless-mysql-http\n\n##### Attention\n\nPlanetScale's timezone is fixed at UTC. The local MySQL server timezone must also be set to UTC.\n\n#### Docker Compose\n\nIf it is docker compose, it can be configured as follows.\n\n```yaml\nversion: '3.9'\nservices:\n mysql:\n image: mysql:8.0.32\n container_name: mysql\n environment:\n MYSQL_ROOT_PASSWORD: ''\n MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'\n TZ: 'UTC' # PlanetScale's timezone is fixed at UTC\n ports:\n - 3306:3306\n serverless-mysql-http:\n image: yutak23/serverless-mysql-http:latest\n container_name: serverless-mysql-http\n ports:\n - 6000:6000\n - 6443:6443\n environment:\n MYSQL_DATABASE: \n MYSQL_HOST: mysql # Using `mysql` hostname since they're in the same Docker network.\n```\n\n## Configuration Options\n\nSMH allows you to change the connection settings to the MySQL server with the following environment variables.\n\n| Environment variable name | Default Value | Notes |\n| ------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| MYSQL_HOST | `127.0.0.1` | `127.0.0.1` is the localhost in the container and is assumed to be overwritten when SMH is used. **Be sure to specify the host of your own server**. |\n| MYSQL_PORT | `3306` | |\n| MYSQL_USER | `root` | |\n| MYSQL_PASSWORD | `''` | empty string |\n| MYSQL_DATABASE | `sample_db` | |\n\n## In GitHub Actions\n\nSMH can also be used in a CI environment such as GitHub Actions.\n\nThis is because SMH is provided as a Docker image, so it can be started as a service container for a job; just start a MySQL server and put SRH next to it.\n\nSMH does not connect to MySQL until a request comes in, so you don't have to worry about a race condition where the MySQL container is not ready. If you are worried, just make sure to check the MySQL server startup as shown in the following example.\n\n```yaml\njobs:\n test:\n runs-on: ubuntu-latest\n services:\n mysql:\n image: mysql:8.0\n env:\n MYSQL_ALLOW_EMPTY_PASSWORD: yes\n TZ: UTC\n ports:\n - 3306:3306\n options: --health-cmd=\"mysqladmin ping\" --health-interval=10s --health-timeout=5s --health-retries=3\n smh:\n image: yutak23/serverless-mysql-http:latest\n env:\n MYSQL_DATABASE: sample_db\n MYSQL_HOST: mysql\n ports:\n - 6000:6000\n - 6443:6443\n```\n\n## Notes\n\n### Differences between PlanetScale\n\nSMH has been tested to produce the same results as when connecting to PlanetScale. However, there are some differences in the behavior with PlanetScale in the following parts:\n\n- It does not support query caching by PlanetScale Boost\n\n Even if you implement code like `await conn.execute('SET @@boost_cached_queries = true')`, it **will not** result in an error, but setting `boost_cached_queries = true` will not cache the query results. \n However, we do not think this is a critical issue as you would not be troubled by not being able to use query caching when developing in a local environment.\n\n- There may be discrepancies in the `fields` data\n\n There may be discrepancies in the properties of the fields([Field](https://github.com/planetscale/database-js/blob/v1.11.0/src/index.ts)) returned when connecting to PlanetScale and the properties of the fields returned by SMH. Specifically, differences like the following may occur. \n | PlanetScale | SMH |\n | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n | name: 'count(\\*)',
type: 'INT64',
columnLength: 21,
charset: 63,
flags: 32897 | name: 'count(\\*)',
type: 'INT64',
table: '',
orgTable: '',
database: 'sample_db',
orgName: 'count(\\*)',
columnLength: 21,
charset: 63 |\n\n However, we believe that there is few problem with local environment construction due to this reproducibility (compatibility)(If you wish, please raise the issue and we will consider modifications to improve reproducibility).\n\n## Similar services that emulate serverless services\n\n- [Serverless Redis HTTP (SRH)](https://github.com/hiett/serverless-redis-http/tree/master)","has_starred","hub_user","immutable_tags_settings",{"_78":11,"_79":80},"enabled","rules",[81],".*","is_automated","permissions",{"_85":17,"_86":11,"_87":11},"read","write","admin","user","storage_size",1127868633,"orgData","recentTags",[94],{"_95":48,"_96":97,"_98":99,"_100":101,"_102":103,"_104":105,"_54":121,"_122":97,"_123":29,"_124":60,"_39":125,"_126":127,"_128":112,"_129":121,"_130":69,"_131":17},"content_type","creator",24038980,"digest","sha256:2911ccaa6c367a51773b3bfc352fa589bbd80d25166feb7d511f91f4e57a486d","full_size",317593937,"id",553990963,"images",[106],{"_107":108,"_98":99,"_109":110,"_111":112,"_113":114,"_115":116,"_117":110,"_118":-5,"_119":101,"_66":69,"_120":-5},"architecture","amd64","features","","last_pulled","2026-09-24T22:37:50.215166631Z","last_pushed","2024-07-03T01:18:04Z","os","linux","os_features","os_version","size","variant","2024-07-03T01:18:03.397959Z","last_updater","last_updater_username","media_type","latest","repository",22516702,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":143,"_152":153,"_139":162,"_163":11},{"_36":144,"_46":147,"_49":50,"_51":52,"_53":11,"_54":55,"_56":57,"_58":148,"_39":31,"_28":29,"_61":62,"_63":48,"_64":65,"_66":67,"_68":69,"_70":-5,"_71":65,"_72":73,"_74":11,"_75":29,"_76":149,"_82":11,"_83":151,"_88":29,"_89":90},[145,146],{"_39":40,"_41":42},{"_39":44,"_41":45},[48],[60],{"_78":11,"_79":150},[81],{"_85":17,"_86":11,"_87":11},"tags",{"_154":67,"_155":-5,"_156":-5,"_157":158},"count","next","previous","results",[159],{"_95":48,"_96":97,"_98":99,"_100":101,"_102":103,"_104":160,"_54":121,"_122":97,"_123":29,"_124":60,"_39":125,"_126":127,"_128":112,"_129":121,"_130":69,"_131":17},[161],{"_107":108,"_98":99,"_109":110,"_111":112,"_113":114,"_115":116,"_117":110,"_118":-5,"_119":101,"_66":69,"_120":-5},[],"canDeleteTags","actionData","errors"]

yutak23/serverless-mysql-http

Tags for yutak23/serverless-mysql-http