1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPostgresProjects
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
databricks logo
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi

    Public Beta

    This data source lists all Postgres projects in the workspace.

    Example Usage

    List All Projects

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const all = databricks.getPostgresProjects({});
    export const projectNames = all.then(all => .map(project => (project.name)));
    
    import pulumi
    import pulumi_databricks as databricks
    
    all = databricks.get_postgres_projects()
    pulumi.export("projectNames", [project.name for project in all.projects])
    
    Example coming soon!
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Databricks.GetPostgresProjects.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["projectNames"] = .Select(project => 
            {
                return project.Name;
            }).ToList(),
        };
    });
    
    Example coming soon!
    
    Example coming soon!
    

    Using getPostgresProjects

    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 getPostgresProjects(args: GetPostgresProjectsArgs, opts?: InvokeOptions): Promise<GetPostgresProjectsResult>
    function getPostgresProjectsOutput(args: GetPostgresProjectsOutputArgs, opts?: InvokeOptions): Output<GetPostgresProjectsResult>
    def get_postgres_projects(page_size: Optional[int] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPostgresProjectsResult
    def get_postgres_projects_output(page_size: Optional[pulumi.Input[int]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPostgresProjectsResult]
    func GetPostgresProjects(ctx *Context, args *GetPostgresProjectsArgs, opts ...InvokeOption) (*GetPostgresProjectsResult, error)
    func GetPostgresProjectsOutput(ctx *Context, args *GetPostgresProjectsOutputArgs, opts ...InvokeOption) GetPostgresProjectsResultOutput

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

    public static class GetPostgresProjects 
    {
        public static Task<GetPostgresProjectsResult> InvokeAsync(GetPostgresProjectsArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresProjectsResult> Invoke(GetPostgresProjectsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPostgresProjectsResult> getPostgresProjects(GetPostgresProjectsArgs args, InvokeOptions options)
    public static Output<GetPostgresProjectsResult> getPostgresProjects(GetPostgresProjectsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPostgresProjects:getPostgresProjects
      arguments:
        # arguments dictionary

    The following arguments are supported:

    PageSize int
    Upper bound for items returned. Cannot be negative
    PageSize int
    Upper bound for items returned. Cannot be negative
    pageSize Integer
    Upper bound for items returned. Cannot be negative
    pageSize number
    Upper bound for items returned. Cannot be negative
    page_size int
    Upper bound for items returned. Cannot be negative
    pageSize Number
    Upper bound for items returned. Cannot be negative

    getPostgresProjects Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Projects List<GetPostgresProjectsProject>
    PageSize int
    Id string
    The provider-assigned unique ID for this managed resource.
    Projects []GetPostgresProjectsProject
    PageSize int
    id String
    The provider-assigned unique ID for this managed resource.
    projects List<GetPostgresProjectsProject>
    pageSize Integer
    id string
    The provider-assigned unique ID for this managed resource.
    projects GetPostgresProjectsProject[]
    pageSize number
    id str
    The provider-assigned unique ID for this managed resource.
    projects Sequence[GetPostgresProjectsProject]
    page_size int
    id String
    The provider-assigned unique ID for this managed resource.
    projects List<Property Map>
    pageSize Number

    Supporting Types

    GetPostgresProjectsProject

    CreateTime string
    (string) - A timestamp indicating when the project was created
    Name string
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    Spec GetPostgresProjectsProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    Status GetPostgresProjectsProjectStatus
    (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
    Name string
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    Spec GetPostgresProjectsProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    Status GetPostgresProjectsProjectStatus
    (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
    name String
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec GetPostgresProjectsProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status GetPostgresProjectsProjectStatus
    (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
    name string
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec GetPostgresProjectsProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status GetPostgresProjectsProjectStatus
    (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
    name str
    (string) - The resource name of the project. This field is output-only and constructed by the system. Format: projects/{project_id}
    spec GetPostgresProjectsProjectSpec
    (ProjectSpec) - The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings
    status GetPostgresProjectsProjectStatus
    (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
    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

    GetPostgresProjectsProjectSpec

    DefaultEndpointSettings GetPostgresProjectsProjectSpecDefaultEndpointSettings
    (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 GetPostgresProjectsProjectSpecDefaultEndpointSettings
    (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 GetPostgresProjectsProjectSpecDefaultEndpointSettings
    (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 GetPostgresProjectsProjectSpecDefaultEndpointSettings
    (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 GetPostgresProjectsProjectSpecDefaultEndpointSettings
    (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

    GetPostgresProjectsProjectSpecDefaultEndpointSettings

    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)

    GetPostgresProjectsProjectStatus

    BranchLogicalSizeLimitBytes int
    (integer) - The logical size limit for a branch
    DefaultEndpointSettings GetPostgresProjectsProjectStatusDefaultEndpointSettings
    (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 GetPostgresProjectsProjectStatusDefaultEndpointSettings
    (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 GetPostgresProjectsProjectStatusDefaultEndpointSettings
    (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 GetPostgresProjectsProjectStatusDefaultEndpointSettings
    (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 GetPostgresProjectsProjectStatusDefaultEndpointSettings
    (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

    GetPostgresProjectsProjectStatusDefaultEndpointSettings

    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
      Meet Neo: Your AI Platform Teammate