1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPostgresProject
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresProject

databricks logo
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    This data source retrieves a single Postgres project.

    Example Usage

    Retrieve Project by Name

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

const _this = databricks.getPostgresProject({
    name: "projects/my-project",
});
export const projectPgVersion = _this.then(_this => _this.status?.pgVersion);
export const projectDisplayName = _this.then(_this => _this.status?.displayName);
export const projectHistoryRetention = _this.then(_this => _this.status?.historyRetentionDuration);

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_postgres_project(name="projects/my-project")
pulumi.export("projectPgVersion", this.status.pg_version)
pulumi.export("projectDisplayName", this.status.display_name)
pulumi.export("projectHistoryRetention", this.status.history_retention_duration)

    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.LookupPostgresProject(ctx, &databricks.LookupPostgresProjectArgs{
			Name: "projects/my-project",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("projectPgVersion", this.Status.PgVersion)
		ctx.Export("projectDisplayName", this.Status.DisplayName)
		ctx.Export("projectHistoryRetention", this.Status.HistoryRetentionDuration)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetPostgresProject.Invoke(new()
    {
        Name = "projects/my-project",
    });

    return new Dictionary<string, object?>
    {
        ["projectPgVersion"] = @this.Apply(@this => @this.Apply(getPostgresProjectResult => getPostgresProjectResult.Status?.PgVersion)),
        ["projectDisplayName"] = @this.Apply(@this => @this.Apply(getPostgresProjectResult => getPostgresProjectResult.Status?.DisplayName)),
        ["projectHistoryRetention"] = @this.Apply(@this => @this.Apply(getPostgresProjectResult => getPostgresProjectResult.Status?.HistoryRetentionDuration)),
    };
});

    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.GetPostgresProjectArgs;
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.getPostgresProject(GetPostgresProjectArgs.builder()
            .name("projects/my-project")
            .build());

        ctx.export("projectPgVersion", this_.status().pgVersion());
        ctx.export("projectDisplayName", this_.status().displayName());
        ctx.export("projectHistoryRetention", this_.status().historyRetentionDuration());
    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getPostgresProject
      arguments:
        name: projects/my-project
outputs:
  projectPgVersion: ${this.status.pgVersion}
  projectDisplayName: ${this.status.displayName}
  projectHistoryRetention: ${this.status.historyRetentionDuration}

    Using getPostgresProject

    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 getPostgresProject(args: GetPostgresProjectArgs, opts?: InvokeOptions): Promise<GetPostgresProjectResult>
function getPostgresProjectOutput(args: GetPostgresProjectOutputArgs, opts?: InvokeOptions): Output<GetPostgresProjectResult>
    def get_postgres_project(name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPostgresProjectResult
def get_postgres_project_output(name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPostgresProjectResult]
    func LookupPostgresProject(ctx *Context, args *LookupPostgresProjectArgs, opts ...InvokeOption) (*LookupPostgresProjectResult, error)
func LookupPostgresProjectOutput(ctx *Context, args *LookupPostgresProjectOutputArgs, opts ...InvokeOption) LookupPostgresProjectResultOutput

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

    public static class GetPostgresProject 
{
    public static Task<GetPostgresProjectResult> InvokeAsync(GetPostgresProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresProjectResult> Invoke(GetPostgresProjectInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresProjectResult> getPostgresProject(GetPostgresProjectArgs args, InvokeOptions options)
public static Output<GetPostgresProjectResult> getPostgresProject(GetPostgresProjectArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Name string
    The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    Name string
    The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    name String
    The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    name string
    The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    name str
    The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    name String
    The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}

    getPostgresProject Result

    The following output properties are available:

    CreateTime string
    (string) - A timestamp indicating when the project was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    Spec GetPostgresProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    Status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    Uid string
    (string) - System-generated unique ID for the project
    UpdateTime string
    (string) - A timestamp indicating when the project was last updated
    CreateTime string
    (string) - A timestamp indicating when the project was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    Spec GetPostgresProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    Status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    Uid string
    (string) - System-generated unique ID for the project
    UpdateTime string
    (string) - A timestamp indicating when the project was last updated
    createTime String
    (string) - A timestamp indicating when the project was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec GetPostgresProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    uid String
    (string) - System-generated unique ID for the project
    updateTime String
    (string) - A timestamp indicating when the project was last updated
    createTime string
    (string) - A timestamp indicating when the project was created
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec GetPostgresProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    uid string
    (string) - System-generated unique ID for the project
    updateTime string
    (string) - A timestamp indicating when the project was last updated
    create_time str
    (string) - A timestamp indicating when the project was created
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec GetPostgresProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    uid str
    (string) - System-generated unique ID for the project
    update_time str
    (string) - A timestamp indicating when the project was last updated
    createTime String
    (string) - A timestamp indicating when the project was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec Property Map
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status Property Map
    (ProjectStatus) - The current status of a Project
    uid String
    (string) - System-generated unique ID for the project
    updateTime String
    (string) - A timestamp indicating when the project was last updated

    Supporting Types

    GetPostgresProjectSpec

    DefaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    PgVersion int
    (integer) - The effective major Postgres version number
    DefaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    PgVersion int
    (integer) - The effective major Postgres version number
    defaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pgVersion Integer
    (integer) - The effective major Postgres version number
    defaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName string
    (string) - The effective human-readable project name
    historyRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pgVersion number
    (integer) - The effective major Postgres version number
    default_endpoint_settings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    display_name str
    (string) - The effective human-readable project name
    history_retention_duration str
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pg_version int
    (integer) - The effective major Postgres version number
    defaultEndpointSettings Property Map
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pgVersion Number
    (integer) - The effective major Postgres version number

    GetPostgresProjectSpecDefaultEndpointSettings

    AutoscalingLimitMaxCu double
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    AutoscalingLimitMinCu double
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    NoSuspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    AutoscalingLimitMaxCu float64
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    AutoscalingLimitMinCu float64
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    NoSuspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscalingLimitMaxCu Double
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscalingLimitMinCu Double
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    noSuspension Boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscalingLimitMaxCu number
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscalingLimitMinCu number
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    noSuspension boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscaling_limit_max_cu float
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscaling_limit_min_cu float
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    no_suspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    suspend_timeout_duration str
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscalingLimitMaxCu Number
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscalingLimitMinCu Number
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    noSuspension Boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)

    GetPostgresProjectStatus

    BranchLogicalSizeLimitBytes int
    (integer) - The logical size limit for a branch
    DefaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    Owner string
    (string) - The email of the project owner
    PgVersion int
    (integer) - The effective major Postgres version number
    SyntheticStorageSizeBytes int
    (integer) - The current space occupied by the project in storage
    BranchLogicalSizeLimitBytes int
    (integer) - The logical size limit for a branch
    DefaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    Owner string
    (string) - The email of the project owner
    PgVersion int
    (integer) - The effective major Postgres version number
    SyntheticStorageSizeBytes int
    (integer) - The current space occupied by the project in storage
    branchLogicalSizeLimitBytes Integer
    (integer) - The logical size limit for a branch
    defaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner String
    (string) - The email of the project owner
    pgVersion Integer
    (integer) - The effective major Postgres version number
    syntheticStorageSizeBytes Integer
    (integer) - The current space occupied by the project in storage
    branchLogicalSizeLimitBytes number
    (integer) - The logical size limit for a branch
    defaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName string
    (string) - The effective human-readable project name
    historyRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner string
    (string) - The email of the project owner
    pgVersion number
    (integer) - The effective major Postgres version number
    syntheticStorageSizeBytes number
    (integer) - The current space occupied by the project in storage
    branch_logical_size_limit_bytes int
    (integer) - The logical size limit for a branch
    default_endpoint_settings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    display_name str
    (string) - The effective human-readable project name
    history_retention_duration str
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner str
    (string) - The email of the project owner
    pg_version int
    (integer) - The effective major Postgres version number
    synthetic_storage_size_bytes int
    (integer) - The current space occupied by the project in storage
    branchLogicalSizeLimitBytes Number
    (integer) - The logical size limit for a branch
    defaultEndpointSettings Property Map
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner String
    (string) - The email of the project owner
    pgVersion Number
    (integer) - The effective major Postgres version number
    syntheticStorageSizeBytes Number
    (integer) - The current space occupied by the project in storage

    GetPostgresProjectStatusDefaultEndpointSettings

    AutoscalingLimitMaxCu double
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    AutoscalingLimitMinCu double
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    NoSuspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    AutoscalingLimitMaxCu float64
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    AutoscalingLimitMinCu float64
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    NoSuspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscalingLimitMaxCu Double
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscalingLimitMinCu Double
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    noSuspension Boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscalingLimitMaxCu number
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscalingLimitMinCu number
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    noSuspension boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscaling_limit_max_cu float
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscaling_limit_min_cu float
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    no_suspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    suspend_timeout_duration str
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)
    autoscalingLimitMaxCu Number
    (number) - The maximum number of Compute Units. Minimum value is 0.5
    autoscalingLimitMinCu Number
    (number) - The minimum number of Compute Units. Minimum value is 0.5
    noSuspension Boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week)

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate