Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
published on Monday, Mar 2, 2026 by planetscale
Planetscale Provider
I want to use the Pulumi planetscale package (planetscale) in my project.
## Provider details
- Package: planetscale
- Version: 1.0.0
- Publisher: planetscale
- Source: opentofu
- Repository: https://github.com/planetscale/terraform-provider-planetscale
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/opentofu/planetscale/planetscale/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/opentofu/planetscale/planetscale/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/opentofu/planetscale/planetscale/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/opentofu/planetscale/planetscale/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
published on Monday, Mar 2, 2026 by planetscale
Generate Provider
The Planetscale provider must be installed as a Local Package by following the instructions for Any Terraform Provider:
pulumi package add terraform-provider planetscale/planetscale
Overview
Pulumi Provider for PlanetScale: Manage your PlanetScale resources with Pulumi
Example Usage
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
planetscale:serverUrl:
value: '...'
import * as pulumi from "@pulumi/pulumi";
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
planetscale:serverUrl:
value: '...'
import pulumi
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
planetscale:serverUrl:
value: '...'
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
planetscale:serverUrl:
value: '...'
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
planetscale:serverUrl:
value: '...'
{}
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
planetscale:serverUrl:
value: '...'
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
}
}
Configuration Reference
serverUrl(String) Server URL (defaults to https://api.planetscale.com/v1)serviceToken(String, Sensitive) PlanetScale Service Token. Configurable via environment variablePLANETSCALE_SERVICE_TOKEN.serviceTokenId(String, Sensitive) PlanetScale Service Token ID. Configurable via environment variablePLANETSCALE_SERVICE_TOKEN_ID.
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
published on Monday, Mar 2, 2026 by planetscale