Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresCdfStatus
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresCdfStatus

databricks logo
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    API Documentation

    This data source retrieves the replication status of a single Postgres table replicated under a CDF (Change Data Feed) configuration.

    Example Usage

    Retrieve CDF Status by Name

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

const _this = databricks.getPostgresCdfStatus({
    name: "projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders",
});
export const cdfTableState = _this.then(_this => _this.state);

    import pulumi
import pulumi_databricks as databricks

this = databricks.get_postgres_cdf_status(name="projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders")
pulumi.export("cdfTableState", this.state)

    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.GetPostgresCdfStatus(ctx, &databricks.GetPostgresCdfStatusArgs{
			Name: "projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("cdfTableState", this.State)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetPostgresCdfStatus.Invoke(new()
    {
        Name = "projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders",
    });

    return new Dictionary<string, object?>
    {
        ["cdfTableState"] = @this.Apply(@this => @this.Apply(getPostgresCdfStatusResult => getPostgresCdfStatusResult.State)),
    };
});

    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.GetPostgresCdfStatusArgs;
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.getPostgresCdfStatus(GetPostgresCdfStatusArgs.builder()
            .name("projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders")
            .build());

        ctx.export("cdfTableState", this_.state());
    }
}

    variables:
  this:
    fn::invoke:
      function: databricks:getPostgresCdfStatus
      arguments:
        name: projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders
outputs:
  cdfTableState: ${this.state}

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

data "databricks_getpostgrescdfstatus" "this" {
  name = "projects/my-project/branches/main/databases/app_db/cdf-configs/public/cdf-statuses/orders"
}

output "cdfTableState" {
  value = data.databricks_getpostgrescdfstatus.this.state
}

    Using getPostgresCdfStatus

    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 getPostgresCdfStatus(args: GetPostgresCdfStatusArgs, opts?: InvokeOptions): Promise<GetPostgresCdfStatusResult>
function getPostgresCdfStatusOutput(args: GetPostgresCdfStatusOutputArgs, opts?: InvokeOptions): Output<GetPostgresCdfStatusResult>
    def get_postgres_cdf_status(name: Optional[str] = None,
                            provider_config: Optional[GetPostgresCdfStatusProviderConfig] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPostgresCdfStatusResult
def get_postgres_cdf_status_output(name: pulumi.Input[Optional[str]] = None,
                            provider_config: pulumi.Input[Optional[GetPostgresCdfStatusProviderConfigArgs]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPostgresCdfStatusResult]
    func GetPostgresCdfStatus(ctx *Context, args *GetPostgresCdfStatusArgs, opts ...InvokeOption) (*GetPostgresCdfStatusResult, error)
func GetPostgresCdfStatusOutput(ctx *Context, args *GetPostgresCdfStatusOutputArgs, opts ...InvokeOption) GetPostgresCdfStatusResultOutput

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

    public static class GetPostgresCdfStatus 
{
    public static Task<GetPostgresCdfStatusResult> InvokeAsync(GetPostgresCdfStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresCdfStatusResult> Invoke(GetPostgresCdfStatusInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresCdfStatusResult> getPostgresCdfStatus(GetPostgresCdfStatusArgs args, InvokeOptions options)
public static Output<GetPostgresCdfStatusResult> getPostgresCdfStatus(GetPostgresCdfStatusArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getPostgresCdfStatus:getPostgresCdfStatus
  arguments:
    # arguments dictionary
    data "databricks_get_postgres_cdf_status" "name" {
    # arguments
}

    The following arguments are supported:

    Name 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
    ProviderConfig GetPostgresCdfStatusProviderConfig
    Configure the provider for management through account provider.
    Name 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
    ProviderConfig GetPostgresCdfStatusProviderConfig
    Configure the provider for management through account provider.
    name 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
    provider_config object
    Configure the provider for management through account provider.
    name 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
    providerConfig GetPostgresCdfStatusProviderConfig
    Configure the provider for management through account provider.
    name 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
    providerConfig GetPostgresCdfStatusProviderConfig
    Configure the provider for management through account provider.
    name str
    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
    provider_config GetPostgresCdfStatusProviderConfig
    Configure the provider for management through account provider.
    name 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
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresCdfStatus Result

    The following output properties are available:

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

    Supporting Types

    GetPostgresCdfStatusProviderConfig

    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
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial