planetscale 0.5.0, Apr 5 25

planetscale 0.5.0 published on Saturday, Apr 5, 2025 by planetscale

planetscale/terraform-provider-planetscale

planetscale.getDatabases

Explore with Pulumi AI

planetscale 0.5.0 published on Saturday, Apr 5, 2025 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";

const example = planetscale.getDatabases({
    organization: "example",
});
export const dbs = example;

import pulumi
import pulumi_planetscale as planetscale

example = planetscale.get_databases(organization="example")
pulumi.export("dbs", example)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetDatabases(ctx, &planetscale.GetDatabasesArgs{
			Organization: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dbs", example)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Planetscale = Pulumi.Planetscale;

return await Deployment.RunAsync(() => 
{
    var example = Planetscale.GetDatabases.Invoke(new()
    {
        Organization = "example",
    });

    return new Dictionary<string, object?>
    {
        ["dbs"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetDatabasesArgs;
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) {
        final var example = PlanetscaleFunctions.getDatabases(GetDatabasesArgs.builder()
            .organization("example")
            .build());

        ctx.export("dbs", example.applyValue(getDatabasesResult -> getDatabasesResult));
    }
}

variables:
  example:
    fn::invoke:
      function: planetscale:getDatabases
      arguments:
        organization: example
outputs:
  dbs: ${example}

Using getDatabases

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getDatabases(args: GetDatabasesArgs, opts?: InvokeOptions): Promise<GetDatabasesResult>
function getDatabasesOutput(args: GetDatabasesOutputArgs, opts?: InvokeOptions): Output<GetDatabasesResult>

def get_databases(organization: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDatabasesResult
def get_databases_output(organization: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDatabasesResult]

func GetDatabases(ctx *Context, args *GetDatabasesArgs, opts ...InvokeOption) (*GetDatabasesResult, error)
func GetDatabasesOutput(ctx *Context, args *GetDatabasesOutputArgs, opts ...InvokeOption) GetDatabasesResultOutput

> Note: This function is named GetDatabases in the Go SDK.

public static class GetDatabases 
{
    public static Task<GetDatabasesResult> InvokeAsync(GetDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabasesResult> Invoke(GetDatabasesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabasesResult> getDatabases(GetDatabasesArgs args, InvokeOptions options)
public static Output<GetDatabasesResult> getDatabases(GetDatabasesArgs args, InvokeOptions options)

fn::invoke:
  function: planetscale:index/getDatabases:getDatabases
  arguments:
    # arguments dictionary

The following arguments are supported:

Organization string

Organization string

organization String

organization string

organization str

organization String

getDatabases Result

The following output properties are available:

Databases List<GetDatabasesDatabase>
Id string: The provider-assigned unique ID for this managed resource.
Organization string

Databases []GetDatabasesDatabase
Id string: The provider-assigned unique ID for this managed resource.
Organization string

databases List<GetDatabasesDatabase>
id String: The provider-assigned unique ID for this managed resource.
organization String

databases GetDatabasesDatabase[]
id string: The provider-assigned unique ID for this managed resource.
organization string

databases Sequence[GetDatabasesDatabase]
id str: The provider-assigned unique ID for this managed resource.
organization str

databases List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
organization String

Supporting Types

GetDatabasesDatabase

AllowDataBranching bool: Whether seeding branches with data is enabled for all branches.
AtBackupRestoreBranchesLimit bool: If the database has reached its backup restored branch limit.
AtDevelopmentBranchLimit bool: If the database has reached its development branch limit.
AutomaticMigrations bool: Whether to automatically manage Rails migrations during deploy requests.
BranchesCount double: The total number of database branches.
BranchesUrl string: The URL to retrieve this database's branches via the API.
CreatedAt string: When the database was created.
DefaultBranch string: The default branch for the database.
DefaultBranchReadOnlyRegionsCount double: Number of read only regions in the default branch.
DefaultBranchShardCount double: Number of shards in the default branch.
DefaultBranchTableCount double: Number of tables in the default branch schema.
DevelopmentBranchesCount double: The total number of database development branches.
HtmlUrl string: The total number of database development branches.
Id string: The ID of the database.
InsightsRawQueries bool: The URL to see this database's branches in the web UI.
IssuesCount double: The total number of ongoing issues within a database.
MigrationFramework string: Framework used for applying migrations.
MigrationTableName string: Table name to use for copying schema migration data.
MultipleAdminsRequiredForDeletion bool: If the database requires multiple admins for deletion.
Name string: The name of this database.
Organization string: The organization this database belongs to.
Plan string: The database plan.
ProductionBranchWebConsole bool: Whether web console is enabled for production branches.
ProductionBranchesCount double: The total number of database production branches.
Ready bool: If the database is ready to be used.
Region GetDatabasesDatabaseRegion: The region the database lives in.
RequireApprovalForDeploy bool: Whether an approval is required to deploy schema changes to this database.
RestrictBranchRegion bool: Whether to restrict branch creation to one region.
SchemaLastUpdatedAt string: When the default branch schema was last changed.
Sharded bool: If the database is sharded.
State string: State of the database.
UpdatedAt string: When the database was last updated.
Url string: The URL to the database API endpoint.
DataImport GetDatabasesDatabaseDataImport: If the database was created from an import, describes the import process.

AllowDataBranching bool: Whether seeding branches with data is enabled for all branches.
AtBackupRestoreBranchesLimit bool: If the database has reached its backup restored branch limit.
AtDevelopmentBranchLimit bool: If the database has reached its development branch limit.
AutomaticMigrations bool: Whether to automatically manage Rails migrations during deploy requests.
BranchesCount float64: The total number of database branches.
BranchesUrl string: The URL to retrieve this database's branches via the API.
CreatedAt string: When the database was created.
DefaultBranch string: The default branch for the database.
DefaultBranchReadOnlyRegionsCount float64: Number of read only regions in the default branch.
DefaultBranchShardCount float64: Number of shards in the default branch.
DefaultBranchTableCount float64: Number of tables in the default branch schema.
DevelopmentBranchesCount float64: The total number of database development branches.
HtmlUrl string: The total number of database development branches.
Id string: The ID of the database.
InsightsRawQueries bool: The URL to see this database's branches in the web UI.
IssuesCount float64: The total number of ongoing issues within a database.
MigrationFramework string: Framework used for applying migrations.
MigrationTableName string: Table name to use for copying schema migration data.
MultipleAdminsRequiredForDeletion bool: If the database requires multiple admins for deletion.
Name string: The name of this database.
Organization string: The organization this database belongs to.
Plan string: The database plan.
ProductionBranchWebConsole bool: Whether web console is enabled for production branches.
ProductionBranchesCount float64: The total number of database production branches.
Ready bool: If the database is ready to be used.
Region GetDatabasesDatabaseRegion: The region the database lives in.
RequireApprovalForDeploy bool: Whether an approval is required to deploy schema changes to this database.
RestrictBranchRegion bool: Whether to restrict branch creation to one region.
SchemaLastUpdatedAt string: When the default branch schema was last changed.
Sharded bool: If the database is sharded.
State string: State of the database.
UpdatedAt string: When the database was last updated.
Url string: The URL to the database API endpoint.
DataImport GetDatabasesDatabaseDataImport: If the database was created from an import, describes the import process.

allowDataBranching Boolean: Whether seeding branches with data is enabled for all branches.
atBackupRestoreBranchesLimit Boolean: If the database has reached its backup restored branch limit.
atDevelopmentBranchLimit Boolean: If the database has reached its development branch limit.
automaticMigrations Boolean: Whether to automatically manage Rails migrations during deploy requests.
branchesCount Double: The total number of database branches.
branchesUrl String: The URL to retrieve this database's branches via the API.
createdAt String: When the database was created.
defaultBranch String: The default branch for the database.
defaultBranchReadOnlyRegionsCount Double: Number of read only regions in the default branch.
defaultBranchShardCount Double: Number of shards in the default branch.
defaultBranchTableCount Double: Number of tables in the default branch schema.
developmentBranchesCount Double: The total number of database development branches.
htmlUrl String: The total number of database development branches.
id String: The ID of the database.
insightsRawQueries Boolean: The URL to see this database's branches in the web UI.
issuesCount Double: The total number of ongoing issues within a database.
migrationFramework String: Framework used for applying migrations.
migrationTableName String: Table name to use for copying schema migration data.
multipleAdminsRequiredForDeletion Boolean: If the database requires multiple admins for deletion.
name String: The name of this database.
organization String: The organization this database belongs to.
plan String: The database plan.
productionBranchWebConsole Boolean: Whether web console is enabled for production branches.
productionBranchesCount Double: The total number of database production branches.
ready Boolean: If the database is ready to be used.
region GetDatabasesDatabaseRegion: The region the database lives in.
requireApprovalForDeploy Boolean: Whether an approval is required to deploy schema changes to this database.
restrictBranchRegion Boolean: Whether to restrict branch creation to one region.
schemaLastUpdatedAt String: When the default branch schema was last changed.
sharded Boolean: If the database is sharded.
state String: State of the database.
updatedAt String: When the database was last updated.
url String: The URL to the database API endpoint.
dataImport GetDatabasesDatabaseDataImport: If the database was created from an import, describes the import process.

allowDataBranching boolean: Whether seeding branches with data is enabled for all branches.
atBackupRestoreBranchesLimit boolean: If the database has reached its backup restored branch limit.
atDevelopmentBranchLimit boolean: If the database has reached its development branch limit.
automaticMigrations boolean: Whether to automatically manage Rails migrations during deploy requests.
branchesCount number: The total number of database branches.
branchesUrl string: The URL to retrieve this database's branches via the API.
createdAt string: When the database was created.
defaultBranch string: The default branch for the database.
defaultBranchReadOnlyRegionsCount number: Number of read only regions in the default branch.
defaultBranchShardCount number: Number of shards in the default branch.
defaultBranchTableCount number: Number of tables in the default branch schema.
developmentBranchesCount number: The total number of database development branches.
htmlUrl string: The total number of database development branches.
id string: The ID of the database.
insightsRawQueries boolean: The URL to see this database's branches in the web UI.
issuesCount number: The total number of ongoing issues within a database.
migrationFramework string: Framework used for applying migrations.
migrationTableName string: Table name to use for copying schema migration data.
multipleAdminsRequiredForDeletion boolean: If the database requires multiple admins for deletion.
name string: The name of this database.
organization string: The organization this database belongs to.
plan string: The database plan.
productionBranchWebConsole boolean: Whether web console is enabled for production branches.
productionBranchesCount number: The total number of database production branches.
ready boolean: If the database is ready to be used.
region GetDatabasesDatabaseRegion: The region the database lives in.
requireApprovalForDeploy boolean: Whether an approval is required to deploy schema changes to this database.
restrictBranchRegion boolean: Whether to restrict branch creation to one region.
schemaLastUpdatedAt string: When the default branch schema was last changed.
sharded boolean: If the database is sharded.
state string: State of the database.
updatedAt string: When the database was last updated.
url string: The URL to the database API endpoint.
dataImport GetDatabasesDatabaseDataImport: If the database was created from an import, describes the import process.

allow_data_branching bool: Whether seeding branches with data is enabled for all branches.
at_backup_restore_branches_limit bool: If the database has reached its backup restored branch limit.
at_development_branch_limit bool: If the database has reached its development branch limit.
automatic_migrations bool: Whether to automatically manage Rails migrations during deploy requests.
branches_count float: The total number of database branches.
branches_url str: The URL to retrieve this database's branches via the API.
created_at str: When the database was created.
default_branch str: The default branch for the database.
default_branch_read_only_regions_count float: Number of read only regions in the default branch.
default_branch_shard_count float: Number of shards in the default branch.
default_branch_table_count float: Number of tables in the default branch schema.
development_branches_count float: The total number of database development branches.
html_url str: The total number of database development branches.
id str: The ID of the database.
insights_raw_queries bool: The URL to see this database's branches in the web UI.
issues_count float: The total number of ongoing issues within a database.
migration_framework str: Framework used for applying migrations.
migration_table_name str: Table name to use for copying schema migration data.
multiple_admins_required_for_deletion bool: If the database requires multiple admins for deletion.
name str: The name of this database.
organization str: The organization this database belongs to.
plan str: The database plan.
production_branch_web_console bool: Whether web console is enabled for production branches.
production_branches_count float: The total number of database production branches.
ready bool: If the database is ready to be used.
region GetDatabasesDatabaseRegion: The region the database lives in.
require_approval_for_deploy bool: Whether an approval is required to deploy schema changes to this database.
restrict_branch_region bool: Whether to restrict branch creation to one region.
schema_last_updated_at str: When the default branch schema was last changed.
sharded bool: If the database is sharded.
state str: State of the database.
updated_at str: When the database was last updated.
url str: The URL to the database API endpoint.
data_import GetDatabasesDatabaseDataImport: If the database was created from an import, describes the import process.

allowDataBranching Boolean: Whether seeding branches with data is enabled for all branches.
atBackupRestoreBranchesLimit Boolean: If the database has reached its backup restored branch limit.
atDevelopmentBranchLimit Boolean: If the database has reached its development branch limit.
automaticMigrations Boolean: Whether to automatically manage Rails migrations during deploy requests.
branchesCount Number: The total number of database branches.
branchesUrl String: The URL to retrieve this database's branches via the API.
createdAt String: When the database was created.
defaultBranch String: The default branch for the database.
defaultBranchReadOnlyRegionsCount Number: Number of read only regions in the default branch.
defaultBranchShardCount Number: Number of shards in the default branch.
defaultBranchTableCount Number: Number of tables in the default branch schema.
developmentBranchesCount Number: The total number of database development branches.
htmlUrl String: The total number of database development branches.
id String: The ID of the database.
insightsRawQueries Boolean: The URL to see this database's branches in the web UI.
issuesCount Number: The total number of ongoing issues within a database.
migrationFramework String: Framework used for applying migrations.
migrationTableName String: Table name to use for copying schema migration data.
multipleAdminsRequiredForDeletion Boolean: If the database requires multiple admins for deletion.
name String: The name of this database.
organization String: The organization this database belongs to.
plan String: The database plan.
productionBranchWebConsole Boolean: Whether web console is enabled for production branches.
productionBranchesCount Number: The total number of database production branches.
ready Boolean: If the database is ready to be used.
region Property Map: The region the database lives in.
requireApprovalForDeploy Boolean: Whether an approval is required to deploy schema changes to this database.
restrictBranchRegion Boolean: Whether to restrict branch creation to one region.
schemaLastUpdatedAt String: When the default branch schema was last changed.
sharded Boolean: If the database is sharded.
state String: State of the database.
updatedAt String: When the database was last updated.
url String: The URL to the database API endpoint.
dataImport Property Map: If the database was created from an import, describes the import process.

GetDatabasesDatabaseDataImport

DataSource GetDatabasesDatabaseDataImportDataSource: Connection information for the source of the data for the import.
FinishedAt string: When the import finished.
ImportCheckErrors string: Errors encountered while preparing the import.
StartedAt string: When the import started.
State string: The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

DataSource GetDatabasesDatabaseDataImportDataSource: Connection information for the source of the data for the import.
FinishedAt string: When the import finished.
ImportCheckErrors string: Errors encountered while preparing the import.
StartedAt string: When the import started.
State string: The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

dataSource GetDatabasesDatabaseDataImportDataSource: Connection information for the source of the data for the import.
finishedAt String: When the import finished.
importCheckErrors String: Errors encountered while preparing the import.
startedAt String: When the import started.
state String: The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

dataSource GetDatabasesDatabaseDataImportDataSource: Connection information for the source of the data for the import.
finishedAt string: When the import finished.
importCheckErrors string: Errors encountered while preparing the import.
startedAt string: When the import started.
state string: The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

data_source GetDatabasesDatabaseDataImportDataSource: Connection information for the source of the data for the import.
finished_at str: When the import finished.
import_check_errors str: Errors encountered while preparing the import.
started_at str: When the import started.
state str: The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

dataSource Property Map: Connection information for the source of the data for the import.
finishedAt String: When the import finished.
importCheckErrors String: Errors encountered while preparing the import.
startedAt String: When the import started.
state String: The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

GetDatabasesDatabaseDataImportDataSource

Database string: The name of the database imported from.
Hostname string: The hostname where the database lives.
Port string: The port on which the database listens on the host.

Database string: The name of the database imported from.
Hostname string: The hostname where the database lives.
Port string: The port on which the database listens on the host.

database String: The name of the database imported from.
hostname String: The hostname where the database lives.
port String: The port on which the database listens on the host.

database string: The name of the database imported from.
hostname string: The hostname where the database lives.
port string: The port on which the database listens on the host.

database str: The name of the database imported from.
hostname str: The hostname where the database lives.
port str: The port on which the database listens on the host.

database String: The name of the database imported from.
hostname String: The hostname where the database lives.
port String: The port on which the database listens on the host.

GetDatabasesDatabaseRegion

DisplayName string: Name of the region.
Enabled bool: Whether or not the region is currently active.
Id string: The ID of the region.
Location string: Location of the region.
Provider string: Provider for the region (ex. AWS).
PublicIpAddresses List<string>: Public IP addresses for the region.
Slug string: The slug of the region.

DisplayName string: Name of the region.
Enabled bool: Whether or not the region is currently active.
Id string: The ID of the region.
Location string: Location of the region.
Provider string: Provider for the region (ex. AWS).
PublicIpAddresses []string: Public IP addresses for the region.
Slug string: The slug of the region.

displayName String: Name of the region.
enabled Boolean: Whether or not the region is currently active.
id String: The ID of the region.
location String: Location of the region.
provider String: Provider for the region (ex. AWS).
publicIpAddresses List<String>: Public IP addresses for the region.
slug String: The slug of the region.

displayName string: Name of the region.
enabled boolean: Whether or not the region is currently active.
id string: The ID of the region.
location string: Location of the region.
provider string: Provider for the region (ex. AWS).
publicIpAddresses string[]: Public IP addresses for the region.
slug string: The slug of the region.

display_name str: Name of the region.
enabled bool: Whether or not the region is currently active.
id str: The ID of the region.
location str: Location of the region.
provider str: Provider for the region (ex. AWS).
public_ip_addresses Sequence[str]: Public IP addresses for the region.
slug str: The slug of the region.

displayName String: Name of the region.
enabled Boolean: Whether or not the region is currently active.
id String: The ID of the region.
location String: Location of the region.
provider String: Provider for the region (ex. AWS).
publicIpAddresses List<String>: Public IP addresses for the region.
slug String: The slug of the region.

Package Details

Repository: planetscale planetscale/terraform-provider-planetscale
License
Notes: This Pulumi package is based on the planetscale Terraform Provider.

planetscale 0.5.0 published on Saturday, Apr 5, 2025 by planetscale

planetscale/terraform-provider-planetscale

planetscale.getDatabases

On this page

On this page

Example Usage

Using getDatabases

getDatabases Result

Supporting Types

GetDatabasesDatabase

GetDatabasesDatabaseDataImport

GetDatabasesDatabaseDataImportDataSource

GetDatabasesDatabaseRegion

Package Details

On this page

On this page