1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresCdfStatuses
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi

    Public Beta

    API Documentation

    This data source lists the replication statuses of all Postgres tables replicated under a CDF (Change Data Feed) configuration.

    Example Usage

    List All Replicated Table Statuses in a CDF Configuration

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const all = databricks.getPostgresCdfStatuses({
        parent: "projects/my-project/branches/main/databases/app_db/cdf-configs/public",
    });
    export const cdfTableStates = all.then(all => .reduce((__obj, status) => ({ ...__obj, [status.postgresTable]: status.state }), {}));
    
    import pulumi
    import pulumi_databricks as databricks
    
    all = databricks.get_postgres_cdf_statuses(parent="projects/my-project/branches/main/databases/app_db/cdf-configs/public")
    pulumi.export("cdfTableStates", {status.postgres_table: status.state for status in all.cdf_statuses})
    
    Example coming soon!
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Databricks.GetPostgresCdfStatuses.Invoke(new()
        {
            Parent = "projects/my-project/branches/main/databases/app_db/cdf-configs/public",
        });
    
        return new Dictionary<string, object?>
        {
            ["cdfTableStates"] = .ToDictionary(item => {
                var status = item.Value;
                return status.PostgresTable;
            }, item => {
                var status = item.Value;
                return status.State;
            }),
        };
    });
    
    Example coming soon!
    
    Example coming soon!
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    data "databricks_getpostgrescdfstatuses" "all" {
      parent = "projects/my-project/branches/main/databases/app_db/cdf-configs/public"
    }
    
    output "cdfTableStates" {
      value = {for status in data.databricks_getpostgrescdfstatuses.all.cdf_statuses : status.postgresTable => status.state}
    }
    

    Using getPostgresCdfStatuses

    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 getPostgresCdfStatuses(args: GetPostgresCdfStatusesArgs, opts?: InvokeOptions): Promise<GetPostgresCdfStatusesResult>
    function getPostgresCdfStatusesOutput(args: GetPostgresCdfStatusesOutputArgs, opts?: InvokeOptions): Output<GetPostgresCdfStatusesResult>
    def get_postgres_cdf_statuses(page_size: Optional[int] = None,
                                  parent: Optional[str] = None,
                                  provider_config: Optional[GetPostgresCdfStatusesProviderConfig] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetPostgresCdfStatusesResult
    def get_postgres_cdf_statuses_output(page_size: pulumi.Input[Optional[int]] = None,
                                  parent: pulumi.Input[Optional[str]] = None,
                                  provider_config: pulumi.Input[Optional[GetPostgresCdfStatusesProviderConfigArgs]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetPostgresCdfStatusesResult]
    func GetPostgresCdfStatuses(ctx *Context, args *GetPostgresCdfStatusesArgs, opts ...InvokeOption) (*GetPostgresCdfStatusesResult, error)
    func GetPostgresCdfStatusesOutput(ctx *Context, args *GetPostgresCdfStatusesOutputArgs, opts ...InvokeOption) GetPostgresCdfStatusesResultOutput

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

    public static class GetPostgresCdfStatuses 
    {
        public static Task<GetPostgresCdfStatusesResult> InvokeAsync(GetPostgresCdfStatusesArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresCdfStatusesResult> Invoke(GetPostgresCdfStatusesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPostgresCdfStatusesResult> getPostgresCdfStatuses(GetPostgresCdfStatusesArgs args, InvokeOptions options)
    public static Output<GetPostgresCdfStatusesResult> getPostgresCdfStatuses(GetPostgresCdfStatusesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPostgresCdfStatuses:getPostgresCdfStatuses
      arguments:
        # arguments dictionary
    data "databricks_get_postgres_cdf_statuses" "name" {
        # arguments
    }

    The following arguments are supported:

    Parent string
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    PageSize int
    Maximum number of CdfStatuses to return
    ProviderConfig GetPostgresCdfStatusesProviderConfig
    Configure the provider for management through account provider.
    Parent string
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    PageSize int
    Maximum number of CdfStatuses to return
    ProviderConfig GetPostgresCdfStatusesProviderConfig
    Configure the provider for management through account provider.
    parent string
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    page_size number
    Maximum number of CdfStatuses to return
    provider_config object
    Configure the provider for management through account provider.
    parent String
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    pageSize Integer
    Maximum number of CdfStatuses to return
    providerConfig GetPostgresCdfStatusesProviderConfig
    Configure the provider for management through account provider.
    parent string
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    pageSize number
    Maximum number of CdfStatuses to return
    providerConfig GetPostgresCdfStatusesProviderConfig
    Configure the provider for management through account provider.
    parent str
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    page_size int
    Maximum number of CdfStatuses to return
    provider_config GetPostgresCdfStatusesProviderConfig
    Configure the provider for management through account provider.
    parent String
    The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    pageSize Number
    Maximum number of CdfStatuses to return
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresCdfStatuses Result

    The following output properties are available:

    Supporting Types

    GetPostgresCdfStatusesCdfStatus

    CommittedLsn string
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    CreateTime string
    (string) - When replication for this table was first established
    LastSyncTime string
    (string) - The last time changes for this table were written to Delta Lake
    Name string
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    PostgresTable string
    (string) - The Postgres table being replicated
    State string
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    StatusDetail string
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    UcTable string
    (string) - The Unity Catalog table receiving replicated data
    ProviderConfig GetPostgresCdfStatusesCdfStatusProviderConfig
    Configure the provider for management through account provider.
    CommittedLsn string
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    CreateTime string
    (string) - When replication for this table was first established
    LastSyncTime string
    (string) - The last time changes for this table were written to Delta Lake
    Name string
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    PostgresTable string
    (string) - The Postgres table being replicated
    State string
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    StatusDetail string
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    UcTable string
    (string) - The Unity Catalog table receiving replicated data
    ProviderConfig GetPostgresCdfStatusesCdfStatusProviderConfig
    Configure the provider for management through account provider.
    committed_lsn string
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    create_time string
    (string) - When replication for this table was first established
    last_sync_time string
    (string) - The last time changes for this table were written to Delta Lake
    name string
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    postgres_table string
    (string) - The Postgres table being replicated
    state string
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    status_detail string
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    uc_table string
    (string) - The Unity Catalog table receiving replicated data
    provider_config object
    Configure the provider for management through account provider.
    committedLsn String
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    createTime String
    (string) - When replication for this table was first established
    lastSyncTime String
    (string) - The last time changes for this table were written to Delta Lake
    name String
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    postgresTable String
    (string) - The Postgres table being replicated
    state String
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    statusDetail String
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    ucTable String
    (string) - The Unity Catalog table receiving replicated data
    providerConfig GetPostgresCdfStatusesCdfStatusProviderConfig
    Configure the provider for management through account provider.
    committedLsn string
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    createTime string
    (string) - When replication for this table was first established
    lastSyncTime string
    (string) - The last time changes for this table were written to Delta Lake
    name string
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    postgresTable string
    (string) - The Postgres table being replicated
    state string
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    statusDetail string
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    ucTable string
    (string) - The Unity Catalog table receiving replicated data
    providerConfig GetPostgresCdfStatusesCdfStatusProviderConfig
    Configure the provider for management through account provider.
    committed_lsn str
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    create_time str
    (string) - When replication for this table was first established
    last_sync_time str
    (string) - The last time changes for this table were written to Delta Lake
    name str
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    postgres_table str
    (string) - The Postgres table being replicated
    state str
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    status_detail str
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    uc_table str
    (string) - The Unity Catalog table receiving replicated data
    provider_config GetPostgresCdfStatusesCdfStatusProviderConfig
    Configure the provider for management through account provider.
    committedLsn String
    (string) - The high-watermark Log Sequence Number (LSN) committed to Delta Lake
    createTime String
    (string) - When replication for this table was first established
    lastSyncTime String
    (string) - The last time changes for this table were written to Delta Lake
    name String
    (string) - Output only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name
    postgresTable String
    (string) - The Postgres table being replicated
    state String
    (string) - The current replication state of this table. Possible values are: CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED
    statusDetail String
    (string) - Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states
    ucTable String
    (string) - The Unity Catalog table receiving replicated data
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetPostgresCdfStatusesCdfStatusProviderConfig

    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 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.

    GetPostgresCdfStatusesProviderConfig

    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 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.

    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.101.0
    published on Thursday, Jul 30, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial