1. Packages
  2. Databricks Provider
  3. API Docs
  4. getDatabaseDatabaseCatalog
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

databricks.getDatabaseDatabaseCatalog

Explore with Pulumi AI

databricks logo
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

    This data source can be used to get a single Database Catalog.

    Example Usage

    Referring to a Database Catalog by name:

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = databricks.getDatabaseDatabaseCatalog({
        name: "my-database-catalog",
    });
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.get_database_database_catalog(name="my-database-catalog")
    
    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 {
    		_, err := databricks.LookupDatabaseDatabaseCatalog(ctx, &databricks.LookupDatabaseDatabaseCatalogArgs{
    			Name: "my-database-catalog",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Databricks.GetDatabaseDatabaseCatalog.Invoke(new()
        {
            Name = "my-database-catalog",
        });
    
    });
    
    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.GetDatabaseDatabaseCatalogArgs;
    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.getDatabaseDatabaseCatalog(GetDatabaseDatabaseCatalogArgs.builder()
                .name("my-database-catalog")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: databricks:getDatabaseDatabaseCatalog
          arguments:
            name: my-database-catalog
    

    Using getDatabaseDatabaseCatalog

    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 getDatabaseDatabaseCatalog(args: GetDatabaseDatabaseCatalogArgs, opts?: InvokeOptions): Promise<GetDatabaseDatabaseCatalogResult>
    function getDatabaseDatabaseCatalogOutput(args: GetDatabaseDatabaseCatalogOutputArgs, opts?: InvokeOptions): Output<GetDatabaseDatabaseCatalogResult>
    def get_database_database_catalog(create_database_if_not_exists: Optional[bool] = None,
                                      database_instance_name: Optional[str] = None,
                                      database_name: Optional[str] = None,
                                      name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetDatabaseDatabaseCatalogResult
    def get_database_database_catalog_output(create_database_if_not_exists: Optional[pulumi.Input[bool]] = None,
                                      database_instance_name: Optional[pulumi.Input[str]] = None,
                                      database_name: Optional[pulumi.Input[str]] = None,
                                      name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseDatabaseCatalogResult]
    func LookupDatabaseDatabaseCatalog(ctx *Context, args *LookupDatabaseDatabaseCatalogArgs, opts ...InvokeOption) (*LookupDatabaseDatabaseCatalogResult, error)
    func LookupDatabaseDatabaseCatalogOutput(ctx *Context, args *LookupDatabaseDatabaseCatalogOutputArgs, opts ...InvokeOption) LookupDatabaseDatabaseCatalogResultOutput

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

    public static class GetDatabaseDatabaseCatalog 
    {
        public static Task<GetDatabaseDatabaseCatalogResult> InvokeAsync(GetDatabaseDatabaseCatalogArgs args, InvokeOptions? opts = null)
        public static Output<GetDatabaseDatabaseCatalogResult> Invoke(GetDatabaseDatabaseCatalogInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatabaseDatabaseCatalogResult> getDatabaseDatabaseCatalog(GetDatabaseDatabaseCatalogArgs args, InvokeOptions options)
    public static Output<GetDatabaseDatabaseCatalogResult> getDatabaseDatabaseCatalog(GetDatabaseDatabaseCatalogArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getDatabaseDatabaseCatalog:getDatabaseDatabaseCatalog
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatabaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    DatabaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    Name string
    The name of the catalog in UC
    CreateDatabaseIfNotExists bool
    (boolean)
    DatabaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    DatabaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    Name string
    The name of the catalog in UC
    CreateDatabaseIfNotExists bool
    (boolean)
    databaseInstanceName String
    (string) - The name of the DatabaseInstance housing the database
    databaseName String
    (string) - The name of the database (in a instance) associated with the catalog
    name String
    The name of the catalog in UC
    createDatabaseIfNotExists Boolean
    (boolean)
    databaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    databaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    name string
    The name of the catalog in UC
    createDatabaseIfNotExists boolean
    (boolean)
    database_instance_name str
    (string) - The name of the DatabaseInstance housing the database
    database_name str
    (string) - The name of the database (in a instance) associated with the catalog
    name str
    The name of the catalog in UC
    create_database_if_not_exists bool
    (boolean)
    databaseInstanceName String
    (string) - The name of the DatabaseInstance housing the database
    databaseName String
    (string) - The name of the database (in a instance) associated with the catalog
    name String
    The name of the catalog in UC
    createDatabaseIfNotExists Boolean
    (boolean)

    getDatabaseDatabaseCatalog Result

    The following output properties are available:

    CreateDatabaseIfNotExists bool
    (boolean)
    DatabaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    DatabaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The name of the catalog in UC
    Uid string
    (string)
    CreateDatabaseIfNotExists bool
    (boolean)
    DatabaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    DatabaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The name of the catalog in UC
    Uid string
    (string)
    createDatabaseIfNotExists Boolean
    (boolean)
    databaseInstanceName String
    (string) - The name of the DatabaseInstance housing the database
    databaseName String
    (string) - The name of the database (in a instance) associated with the catalog
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The name of the catalog in UC
    uid String
    (string)
    createDatabaseIfNotExists boolean
    (boolean)
    databaseInstanceName string
    (string) - The name of the DatabaseInstance housing the database
    databaseName string
    (string) - The name of the database (in a instance) associated with the catalog
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - The name of the catalog in UC
    uid string
    (string)
    create_database_if_not_exists bool
    (boolean)
    database_instance_name str
    (string) - The name of the DatabaseInstance housing the database
    database_name str
    (string) - The name of the database (in a instance) associated with the catalog
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - The name of the catalog in UC
    uid str
    (string)
    createDatabaseIfNotExists Boolean
    (boolean)
    databaseInstanceName String
    (string) - The name of the DatabaseInstance housing the database
    databaseName String
    (string) - The name of the database (in a instance) associated with the catalog
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The name of the catalog in UC
    uid String
    (string)

    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.74.0 published on Thursday, Aug 14, 2025 by Pulumi