1. Packages
  2. Databricks
  3. API Docs
  4. getTables
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi

databricks.getTables

Explore with Pulumi AI

databricks logo
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi

    Note This data source can only be used with a workspace-level provider!

    Note If you have a fully automated setup with workspaces created by databricks.MwsWorkspaces or azurerm_databricks_workspace, please make sure to add depends_on attribute in order to prevent default auth: cannot configure default credentials errors.

    Retrieves a list of managed or external table full names in Unity Catalog, that were created by Pulumi or manually. Use databricks.getViews for retrieving a list of views.

    Example Usage

    Granting SELECT and MODIFY to sensitive group on all tables a things databricks.Schema from sandbox databricks_catalog:

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    export = async () => {
        const things = await databricks.getTables({
            catalogName: "sandbox",
            schemaName: "things",
        });
        const thingsGrants: databricks.Grants[] = [];
        for (const range of things.ids.map((v, k) => ({key: k, value: v}))) {
            thingsGrants.push(new databricks.Grants(`things-${range.key}`, {
                table: range.value,
                grants: [{
                    principal: "sensitive",
                    privileges: [
                        "SELECT",
                        "MODIFY",
                    ],
                }],
            }));
        }
    }
    
    import pulumi
    import pulumi_databricks as databricks
    
    things = databricks.get_tables(catalog_name="sandbox",
        schema_name="things")
    things_grants = []
    for range in [{"key": k, "value": v} for [k, v] in enumerate(things.ids)]:
        things_grants.append(databricks.Grants(f"things-{range['key']}",
            table=range["value"],
            grants=[{
                "principal": "sensitive",
                "privileges": [
                    "SELECT",
                    "MODIFY",
                ],
            }]))
    
    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 {
    		things, err := databricks.GetTables(ctx, &databricks.GetTablesArgs{
    			CatalogName: "sandbox",
    			SchemaName:  "things",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		var thingsGrants []*databricks.Grants
    		for key0, val0 := range things.Ids {
    			__res, err := databricks.NewGrants(ctx, fmt.Sprintf("things-%v", key0), &databricks.GrantsArgs{
    				Table: pulumi.String(val0),
    				Grants: databricks.GrantsGrantArray{
    					&databricks.GrantsGrantArgs{
    						Principal: pulumi.String("sensitive"),
    						Privileges: pulumi.StringArray{
    							pulumi.String("SELECT"),
    							pulumi.String("MODIFY"),
    						},
    					},
    				},
    			})
    			if err != nil {
    				return err
    			}
    			thingsGrants = append(thingsGrants, __res)
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Threading.Tasks;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(async() => 
    {
        var things = await Databricks.GetTables.InvokeAsync(new()
        {
            CatalogName = "sandbox",
            SchemaName = "things",
        });
    
        var thingsGrants = new List<Databricks.Grants>();
        foreach (var range in )
        {
            thingsGrants.Add(new Databricks.Grants($"things-{range.Key}", new()
            {
                Table = range.Value,
                GrantDetails = new[]
                {
                    new Databricks.Inputs.GrantsGrantArgs
                    {
                        Principal = "sensitive",
                        Privileges = new[]
                        {
                            "SELECT",
                            "MODIFY",
                        },
                    },
                },
            }));
        }
    });
    
    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.GetTablesArgs;
    import com.pulumi.databricks.Grants;
    import com.pulumi.databricks.GrantsArgs;
    import com.pulumi.databricks.inputs.GrantsGrantArgs;
    import com.pulumi.codegen.internal.KeyedValue;
    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 things = DatabricksFunctions.getTables(GetTablesArgs.builder()
                .catalogName("sandbox")
                .schemaName("things")
                .build());
    
            final var thingsGrants = things.applyValue(getTablesResult -> {
                final var resources = new ArrayList<Grants>();
                for (var range : KeyedValue.of(getTablesResult.ids()) {
                    var resource = new Grants("thingsGrants-" + range.key(), GrantsArgs.builder()
                        .table(range.value())
                        .grants(GrantsGrantArgs.builder()
                            .principal("sensitive")
                            .privileges(                        
                                "SELECT",
                                "MODIFY")
                            .build())
                        .build());
    
                    resources.add(resource);
                }
    
                return resources;
            });
    
        }
    }
    
    resources:
      thingsGrants:
        type: databricks:Grants
        name: things
        properties:
          table: ${range.value}
          grants:
            - principal: sensitive
              privileges:
                - SELECT
                - MODIFY
        options: {}
    variables:
      things:
        fn::invoke:
          Function: databricks:getTables
          Arguments:
            catalogName: sandbox
            schemaName: things
    

    The following resources are used in the same context:

    • databricks.Schema to manage schemas within Unity Catalog.
    • databricks.Catalog to manage catalogs within Unity Catalog.

    Using getTables

    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 getTables(args: GetTablesArgs, opts?: InvokeOptions): Promise<GetTablesResult>
    function getTablesOutput(args: GetTablesOutputArgs, opts?: InvokeOptions): Output<GetTablesResult>
    def get_tables(catalog_name: Optional[str] = None,
                   ids: Optional[Sequence[str]] = None,
                   schema_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetTablesResult
    def get_tables_output(catalog_name: Optional[pulumi.Input[str]] = None,
                   ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   schema_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetTablesResult]
    func GetTables(ctx *Context, args *GetTablesArgs, opts ...InvokeOption) (*GetTablesResult, error)
    func GetTablesOutput(ctx *Context, args *GetTablesOutputArgs, opts ...InvokeOption) GetTablesResultOutput

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

    public static class GetTables 
    {
        public static Task<GetTablesResult> InvokeAsync(GetTablesArgs args, InvokeOptions? opts = null)
        public static Output<GetTablesResult> Invoke(GetTablesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: databricks:index/getTables:getTables
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CatalogName string
    Name of databricks_catalog
    SchemaName string
    Name of databricks_schema
    Ids List<string>
    set of databricks.Table full names: catalog.schema.table
    CatalogName string
    Name of databricks_catalog
    SchemaName string
    Name of databricks_schema
    Ids []string
    set of databricks.Table full names: catalog.schema.table
    catalogName String
    Name of databricks_catalog
    schemaName String
    Name of databricks_schema
    ids List<String>
    set of databricks.Table full names: catalog.schema.table
    catalogName string
    Name of databricks_catalog
    schemaName string
    Name of databricks_schema
    ids string[]
    set of databricks.Table full names: catalog.schema.table
    catalog_name str
    Name of databricks_catalog
    schema_name str
    Name of databricks_schema
    ids Sequence[str]
    set of databricks.Table full names: catalog.schema.table
    catalogName String
    Name of databricks_catalog
    schemaName String
    Name of databricks_schema
    ids List<String>
    set of databricks.Table full names: catalog.schema.table

    getTables Result

    The following output properties are available:

    CatalogName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    set of databricks.Table full names: catalog.schema.table
    SchemaName string
    CatalogName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    set of databricks.Table full names: catalog.schema.table
    SchemaName string
    catalogName String
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    set of databricks.Table full names: catalog.schema.table
    schemaName String
    catalogName string
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    set of databricks.Table full names: catalog.schema.table
    schemaName string
    catalog_name str
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    set of databricks.Table full names: catalog.schema.table
    schema_name str
    catalogName String
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    set of databricks.Table full names: catalog.schema.table
    schemaName 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.56.0 published on Tuesday, Nov 12, 2024 by Pulumi