1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresDatabase
Viewing docs for Databricks v1.91.1
published on Friday, May 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresDatabase

databricks logo
Viewing docs for Databricks v1.91.1
published on Friday, May 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Private Preview

    This data source retrieves a single Postgres database.

    Example Usage

    Retrieve Database by Name

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

const _this = databricks.getPostgresDatabase({
    name: "projects/my-project/branches/main/databases/app",
});
export const postgresDatabaseName = _this.then(_this => _this.status?.postgresDatabase);
export const databaseOwnerRole = _this.then(_this => _this.status?.role);

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_postgres_database(name="projects/my-project/branches/main/databases/app")
pulumi.export("postgresDatabaseName", this.status.postgres_database)
pulumi.export("databaseOwnerRole", this.status.role)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := databricks.GetPostgresDatabase(ctx, &databricks.LookupPostgresDatabaseArgs{
			Name: "projects/my-project/branches/main/databases/app",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("postgresDatabaseName", this.Status.PostgresDatabase)
		ctx.Export("databaseOwnerRole", this.Status.Role)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.Index.GetPostgresDatabase.Invoke(new()
    {
        Name = "projects/my-project/branches/main/databases/app",
    });

    return new Dictionary<string, object?>
    {
        ["postgresDatabaseName"] = @this.Apply(@this => @this.Apply(getPostgresDatabaseResult => getPostgresDatabaseResult.Status?.PostgresDatabase)),
        ["databaseOwnerRole"] = @this.Apply(@this => @this.Apply(getPostgresDatabaseResult => getPostgresDatabaseResult.Status?.Role)),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetPostgresDatabaseArgs;
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 this = DatabricksFunctions.getPostgresDatabase(GetPostgresDatabaseArgs.builder()
            .name("projects/my-project/branches/main/databases/app")
            .build());

        ctx.export("postgresDatabaseName", this_.status().postgresDatabase());
        ctx.export("databaseOwnerRole", this_.status().role());
    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getPostgresDatabase
      arguments:
        name: projects/my-project/branches/main/databases/app
outputs:
  postgresDatabaseName: ${this.status.postgresDatabase}
  databaseOwnerRole: ${this.status.role}

    Using getPostgresDatabase

    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.

    function getPostgresDatabase(args: GetPostgresDatabaseArgs, opts?: InvokeOptions): Promise<GetPostgresDatabaseResult>
function getPostgresDatabaseOutput(args: GetPostgresDatabaseOutputArgs, opts?: InvokeOptions): Output<GetPostgresDatabaseResult>
    def get_postgres_database(name: Optional[str] = None,
                          provider_config: Optional[GetPostgresDatabaseProviderConfig] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPostgresDatabaseResult
def get_postgres_database_output(name: pulumi.Input[Optional[str]] = None,
                          provider_config: pulumi.Input[Optional[GetPostgresDatabaseProviderConfigArgs]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPostgresDatabaseResult]
    func LookupPostgresDatabase(ctx *Context, args *LookupPostgresDatabaseArgs, opts ...InvokeOption) (*LookupPostgresDatabaseResult, error)
func LookupPostgresDatabaseOutput(ctx *Context, args *LookupPostgresDatabaseOutputArgs, opts ...InvokeOption) LookupPostgresDatabaseResultOutput

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

    public static class GetPostgresDatabase 
{
    public static Task<GetPostgresDatabaseResult> InvokeAsync(GetPostgresDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresDatabaseResult> Invoke(GetPostgresDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresDatabaseResult> getPostgresDatabase(GetPostgresDatabaseArgs args, InvokeOptions options)
public static Output<GetPostgresDatabaseResult> getPostgresDatabase(GetPostgresDatabaseArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getPostgresDatabase:getPostgresDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    ProviderConfig GetPostgresDatabaseProviderConfig
    Configure the provider for management through account provider.
    Name string
    The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    ProviderConfig GetPostgresDatabaseProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    providerConfig GetPostgresDatabaseProviderConfig
    Configure the provider for management through account provider.
    name string
    The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    providerConfig GetPostgresDatabaseProviderConfig
    Configure the provider for management through account provider.
    name str
    The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    provider_config GetPostgresDatabaseProviderConfig
    Configure the provider for management through account provider.
    name String
    The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresDatabase Result

    The following output properties are available:

    CreateTime string
    (string) - A timestamp indicating when the database was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    Parent string
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    Status GetPostgresDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    UpdateTime string
    (string) - A timestamp indicating when the database was last updated
    ProviderConfig GetPostgresDatabaseProviderConfig
    CreateTime string
    (string) - A timestamp indicating when the database was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    Parent string
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    Status GetPostgresDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    UpdateTime string
    (string) - A timestamp indicating when the database was last updated
    ProviderConfig GetPostgresDatabaseProviderConfig
    createTime String
    (string) - A timestamp indicating when the database was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent String
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    status GetPostgresDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    updateTime String
    (string) - A timestamp indicating when the database was last updated
    providerConfig GetPostgresDatabaseProviderConfig
    createTime string
    (string) - A timestamp indicating when the database was created
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent string
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    status GetPostgresDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    updateTime string
    (string) - A timestamp indicating when the database was last updated
    providerConfig GetPostgresDatabaseProviderConfig
    create_time str
    (string) - A timestamp indicating when the database was created
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent str
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresDatabaseSpec
    (DatabaseDatabaseSpec) - The desired state of the Database
    status GetPostgresDatabaseStatus
    (DatabaseDatabaseStatus) - The observed state of the Database
    update_time str
    (string) - A timestamp indicating when the database was last updated
    provider_config GetPostgresDatabaseProviderConfig
    createTime String
    (string) - A timestamp indicating when the database was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the database. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    parent String
    (string) - The branch containing this database. Format: projects/{project_id}/branches/{branch_id}
    spec Property Map
    (DatabaseDatabaseSpec) - The desired state of the Database
    status Property Map
    (DatabaseDatabaseStatus) - The observed state of the Database
    updateTime String
    (string) - A timestamp indicating when the database was last updated
    providerConfig Property Map

    Supporting Types

    GetPostgresDatabaseProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetPostgresDatabaseSpec

    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase string
    (string) - The name of the Postgres database
    role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgres_database str
    (string) - The name of the Postgres database
    role str
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}

    GetPostgresDatabaseStatus

    DatabaseId string
    (string) - The short identifier of the database, suitable for showing to the users. For a database with name projects/my-project/branches/my-branch/databases/my-db, the databaseId is my-db.
    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    DatabaseId string
    (string) - The short identifier of the database, suitable for showing to the users. For a database with name projects/my-project/branches/my-branch/databases/my-db, the databaseId is my-db.
    PostgresDatabase string
    (string) - The name of the Postgres database
    Role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    databaseId String
    (string) - The short identifier of the database, suitable for showing to the users. For a database with name projects/my-project/branches/my-branch/databases/my-db, the databaseId is my-db.
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    databaseId string
    (string) - The short identifier of the database, suitable for showing to the users. For a database with name projects/my-project/branches/my-branch/databases/my-db, the databaseId is my-db.
    postgresDatabase string
    (string) - The name of the Postgres database
    role string
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    database_id str
    (string) - The short identifier of the database, suitable for showing to the users. For a database with name projects/my-project/branches/my-branch/databases/my-db, the databaseId is my-db.
    postgres_database str
    (string) - The name of the Postgres database
    role str
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
    databaseId String
    (string) - The short identifier of the database, suitable for showing to the users. For a database with name projects/my-project/branches/my-branch/databases/my-db, the databaseId is my-db.
    postgresDatabase String
    (string) - The name of the Postgres database
    role String
    (string) - The name of the role that owns the database. Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.91.1
    published on Friday, May 1, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.