wundergraph.config.ts Reference

Configure Planetscale Data Source

The Planetscale data source introspects the database and generates a GraphQL schema.

Example Configuration

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// wundergraph.config.ts
const db = introspect.planetscale({
apiNamespace: 'wundergraph',
databaseURL: 'mysql://root:root@localhost:3306/wundergraph',
introspection: {
pollingIntervalSeconds: 5,
},
})
const myApplication = new Application({
name: 'app',
apis: [db],
})

Define the databaseURL which is the connection string to the database. To avoid naming conflicts, you should also define an apiNamespace.

The introspection result will be cached in the local file-system to make the development process faster. Otherwise, WunderGraph would introspect the database every time you change an operation.

If you're planning to frequently change the database schema, e.g. during development, you should specify the pollingIntervalSeconds to 5 seconds for example. This will make WunderGraph introspect the database every 5 seconds. If the generated schema is changed, the file-system cache will be updated.

Limitations

Currently, it's not possible to detect relationships when introspecting a Planetscale database.

Was this article helpful to you?
Provide feedback

Edit this page