databricks.getPostgresCatalog

Databricks v1.92.0, May 12 26

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Example Usage

Retrieve Catalog by Name

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

const _this = databricks.getPostgresCatalog({
    name: "catalogs/my_catalog",
});
export const catalogPostgresDatabase = _this.then(_this => _this.status?.postgresDatabase);

import pulumi
import pulumi_databricks as databricks

this = databricks.get_postgres_catalog(name="catalogs/my_catalog")
pulumi.export("catalogPostgresDatabase", this.status.postgres_database)

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.GetPostgresCatalog(ctx, &databricks.LookupPostgresCatalogArgs{
			Name: "catalogs/my_catalog",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("catalogPostgresDatabase", this.Status.PostgresDatabase)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetPostgresCatalog.Invoke(new()
    {
        Name = "catalogs/my_catalog",
    });

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

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.GetPostgresCatalogArgs;
import java.util.ArrayList;
import java.util.Arrays;
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.getPostgresCatalog(GetPostgresCatalogArgs.builder()
            .name("catalogs/my_catalog")
            .build());

        ctx.export("catalogPostgresDatabase", this_.status().postgresDatabase());
    }
}

variables:
  this:
    fn::invoke:
      function: databricks:getPostgresCatalog
      arguments:
        name: catalogs/my_catalog
outputs:
  catalogPostgresDatabase: ${this.status.postgresDatabase}

Example coming soon!

Using getPostgresCatalog

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 getPostgresCatalog(args: GetPostgresCatalogArgs, opts?: InvokeOptions): Promise<GetPostgresCatalogResult>
function getPostgresCatalogOutput(args: GetPostgresCatalogOutputArgs, opts?: InvokeOptions): Output<GetPostgresCatalogResult>

def get_postgres_catalog(name: Optional[str] = None,
                         provider_config: Optional[GetPostgresCatalogProviderConfig] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPostgresCatalogResult
def get_postgres_catalog_output(name: pulumi.Input[Optional[str]] = None,
                         provider_config: pulumi.Input[Optional[GetPostgresCatalogProviderConfigArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPostgresCatalogResult]

func LookupPostgresCatalog(ctx *Context, args *LookupPostgresCatalogArgs, opts ...InvokeOption) (*LookupPostgresCatalogResult, error)
func LookupPostgresCatalogOutput(ctx *Context, args *LookupPostgresCatalogOutputArgs, opts ...InvokeOption) LookupPostgresCatalogResultOutput

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

public static class GetPostgresCatalog 
{
    public static Task<GetPostgresCatalogResult> InvokeAsync(GetPostgresCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresCatalogResult> Invoke(GetPostgresCatalogInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPostgresCatalogResult> getPostgresCatalog(GetPostgresCatalogArgs args, InvokeOptions options)
public static Output<GetPostgresCatalogResult> getPostgresCatalog(GetPostgresCatalogArgs args, InvokeOptions options)

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

data "databricks_getpostgrescatalog" "name" {
    # arguments
}

The following arguments are supported:

Name string

Output only. The full resource path of the catalog.