3.1 KiB
3.1 KiB
Hyperdrive configuration
See README.md for the retrieval workflow. Fetch the relevant guide before creating or changing resources; use current configuration fields and CLI syntax from these sources.
| Task | Official documentation |
|---|---|
| Create the first configuration and bind it to a Worker | Get started |
| Create, inspect, update, or delete configurations; set cache or pool options | Wrangler commands |
| Generate TypeScript types from Worker configuration | Workers TypeScript |
| Connect a private database using the recommended Workers VPC route | Workers VPC integration |
| Maintain a private database connection using Tunnel and Access | Tunnel integration |
| Configure database network access | Firewall and networking |
| Configure server verification or client certificates | SSL/TLS certificates |
| Rotate origin database credentials | Credential rotation |
| Configure cache freshness or separate cached and fresh-read bindings | Query caching |
| Budget origin connections across configurations | Tune connection pooling |
| Choose local database access or remote Hyperdrive testing | Local development |
| Evaluate Worker placement for multiple database round trips | Smart Placement |
Setup decisions
- Identify the database engine, provider, and network path first. The PostgreSQL and MySQL indexes route to provider-specific instructions.
- For private connectivity, choose Workers VPC or the existing Tunnel/Access integration before configuring credentials. Follow the selected guide's prerequisites and TLS guidance.
- Decide which reads may be stale before selecting cache settings. Multiple configurations against one database contribute to its total origin connection usage.
- Local direct database access does not exercise Hyperdrive pooling or caching. Use the local-development guide's remote option when verifying those behaviors, and identify the database that option targets before running writes.
See api.md for drivers and gotchas.md for diagnosis.