-
-
Notifications
You must be signed in to change notification settings - Fork 639
feat: support Cloudflare Workers #2289
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.
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
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Using MySQL2 on Cloudflare Workers | ||
|
||
This document is a step-by-step tutorial on how to use `node-mysql2` on Cloudflare Workers. | ||
|
||
## Prerequisites | ||
|
||
Before you try the steps in this document, you need to prepare the following things: | ||
|
||
- A [Cloudflare Workers](https://dash.cloudflare.com/login) account. | ||
- [Wrangler](https://developers.cloudflare.com/workers/wrangler/) installed. | ||
|
||
If you haven't created a Cloudflare Worker project yet, please refer to [Get Started Guide](https://developers.cloudflare.com/workers/get-started/guide/) to create one. | ||
|
||
## Step 1: Configure `wrangler.jsonc` file | ||
|
||
Because of the differences between the Cloudflare Workers runtime and the Node.js runtime, you can't use MySQL2 directly on the worker, but you can enable compatibility mode through configuration: | ||
|
||
```json | ||
{ | ||
"$schema": "node_modules/wrangler/config-schema.json", | ||
"name": "mysql2-cloudflare", | ||
"main": "src/index.ts", | ||
// highlight-start | ||
"compatibility_date": "2025-02-24", | ||
// highlight-end | ||
"observability": { | ||
"enabled": true | ||
}, | ||
// highlight-start | ||
"compatibility_flags": ["nodejs_compat"] | ||
// highlight-end | ||
} | ||
``` | ||
|
||
## Step 2: Disable code generation-based parser | ||
|
||
MySQL2 uses code generation based parser for performance by default, but this is restricted on Cloudflare Workers. You may encounter the errors like: | ||
|
||
``` | ||
Code generation from strings disallowed for this context | ||
``` | ||
|
||
To make it work, you can disable the code generation-based parser by pass the `disableEval=true` parameter when creating a connection. Here are an example: | ||
|
||
```ts | ||
import { createConnection } from 'mysql2/promise'; | ||
|
||
export default { | ||
async fetch(request, env, ctx): Promise<Response> { | ||
const conn = await createConnection({ | ||
host: '<ENTER_HOST>', | ||
port: 3306, | ||
user: '<ENTER_USERNAME>', | ||
password: '<ENTER_PASSWORD>', | ||
// highlight-start | ||
disableEval: true, | ||
// highlight-end | ||
database: '<ENTER_DB_NAME>', | ||
}); | ||
|
||
const [results] = await conn.query('SHOW TABLES;'); | ||
|
||
return new Response(JSON.stringify(results)); | ||
}, | ||
} satisfies ExportedHandler<Env>; | ||
``` | ||
|
||
:::tip | ||
For some managed MySQL / MySQL-compatible cloud databases (e.g., TiDB Serverless, Planetscale), connections are usually required to use SSL. It is recommended to use the Cloudflare managed connection pool [Hyperdrive](https://developers.cloudflare.com/hyperdrive/) to connect. | ||
::: | ||
|
||
## Step 3: Test locally | ||
|
||
``` | ||
wrangler dev | ||
``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.