Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudflare/worker-template-mysql
Reference demo and modified MySQL driver to connect Cloudflare Workers to a relational database.
https://github.com/cloudflare/worker-template-mysql
cloudflare database mysql serverless sql workers
Last synced: 5 days ago
JSON representation
Reference demo and modified MySQL driver to connect Cloudflare Workers to a relational database.
- Host: GitHub
- URL: https://github.com/cloudflare/worker-template-mysql
- Owner: cloudflare
- License: apache-2.0
- Created: 2021-11-03T19:00:45.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T03:15:47.000Z (4 months ago)
- Last Synced: 2024-12-27T02:06:37.919Z (12 days ago)
- Topics: cloudflare, database, mysql, serverless, sql, workers
- Language: JavaScript
- Homepage:
- Size: 533 KB
- Stars: 51
- Watchers: 5
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE_APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cloudflare Workers + MySQL
This repo contains example code and a MySQL driver that can be used in any Workers project. If you
are interested in using the driver _outside_ of this template, copy the `driver/mysql` module
into your project's `node_modules` or directly alongside your source.
## Usage
Before you start, please refer to the **[official tutorial](https://developers.cloudflare.com/workers/tutorials/query-postgres-from-workers-using-database-connectors)**.
```typescript
const mysql = new Client()
const mysqlClient = await mysql.connect({
username: '',
db: '',
// hostname is the full URL to your pre-created Cloudflare Tunnel, see documentation here:
// https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/create-tunnel
hostname: env.TUNNEL_HOST || 'https://dev.example.com',
password: env.DATABASE_PASSWORD, // use a secret to store passwords
})
```
**Please Note:**
- you must use this config object format vs. a database connection string
- the `hostname` property must be the URL to your Cloudflare Tunnel, _NOT_ your database host
- your Tunnel will be configured to connect to your database host
## Running the MySQL Demo
`mysql/docker-compose.yml`
This docker-compose composition will get you up and running with a local instance of `mysql` and a
copy of `cloudflared` to enable your applications to securely connect through an encrypted tunnel.
Unlike the PostgreSQL example, this does not contain any server-side connection pool, but you can
configure one behind `cloudflared` should it be necessary.
### Usage
> from within `scripts/mysql`, run:
1. **Create credentials file (first time only)**
```sh
docker run -v ~/.cloudflared:/etc/cloudflared cloudflare/cloudflared:2021.10.5 login
```
2. **Start a local dev stack (cloudflared/mysql)**
```sh
TUNNEL_HOSTNAME=dev.example.com docker-compose up
```