databricks.SqlVisualization (v0)

Databricks v0.4.0 (0.x), Mar 9 26

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

End to end workspace management guide.
databricks.SqlDashboard to manage Databricks SQL Dashboards.
databricks.SqlEndpoint to manage Databricks SQL Endpoints.
databricks.SqlGlobalConfig to configure the security policy, databricks_instance_profile, and data access properties for all databricks.SqlEndpoint of workspace.
databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var q1v1 = new Databricks.SqlVisualization("q1v1", new Databricks.SqlVisualizationArgs
        {
            QueryId = databricks_sql_query.Q1.Id,
            Type = "table",
            Description = "Some Description",
            Options = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                { "itemsPerPage", 25 },
                { "columns", new[]
                    {
                        new Dictionary<string, object?>
                        {
                            { "name", "p1" },
                            { "type", "string" },
                            { "title", "Parameter 1" },
                            { "displayAs", "string" },
                        },
                        new Dictionary<string, object?>
                        {
                            { "name", "p2" },
                            { "type", "string" },
                            { "title", "Parameter 2" },
                            { "displayAs", "link" },
                            { "highlightLinks", true },
                        },
                    }
                 },
            }),
        });
    }

}

package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"itemsPerPage": 25,
			"columns": []map[string]interface{}{
				map[string]interface{}{
					"name":      "p1",
					"type":      "string",
					"title":     "Parameter 1",
					"displayAs": "string",
				},
				map[string]interface{}{
					"name":           "p2",
					"type":           "string",
					"title":          "Parameter 2",
					"displayAs":      "link",
					"highlightLinks": true,
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err := databricks.NewSqlVisualization(ctx, "q1v1", &databricks.SqlVisualizationArgs{
			QueryId:     pulumi.Any(databricks_sql_query.Q1.Id),
			Type:        pulumi.String("table"),
			Description: pulumi.String("Some Description"),
			Options:     pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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

const q1v1 = new databricks.SqlVisualization("q1v1", {
    queryId: databricks_sql_query.q1.id,
    type: "table",
    description: "Some Description",
    options: JSON.stringify({
        itemsPerPage: 25,
        columns: [
            {
                name: "p1",
                type: "string",
                title: "Parameter 1",
                displayAs: "string",
            },
            {
                name: "p2",
                type: "string",
                title: "Parameter 2",
                displayAs: "link",
                highlightLinks: true,
            },
        ],
    }),
});

import pulumi
import json
import pulumi_databricks as databricks

q1v1 = databricks.SqlVisualization("q1v1",
    query_id=databricks_sql_query["q1"]["id"],
    type="table",
    description="Some Description",
    options=json.dumps({
        "itemsPerPage": 25,
        "columns": [
            {
                "name": "p1",
                "type": "string",
                "title": "Parameter 1",
                "displayAs": "string",
            },
            {
                "name": "p2",
                "type": "string",
                "title": "Parameter 2",
                "displayAs": "link",
                "highlightLinks": True,
            },
        ],
    }))

Example coming soon!

Create SqlVisualization Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SqlVisualization(name: string, args: SqlVisualizationArgs, opts?: CustomResourceOptions);

@overload
def SqlVisualization(resource_name: str,
                     args: SqlVisualizationArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def SqlVisualization(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     options: Optional[str] = None,
                     query_id: Optional[str] = None,
                     type: Optional[str] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     visualization_id: Optional[str] = None)

func NewSqlVisualization(ctx *Context, name string, args SqlVisualizationArgs, opts ...ResourceOption) (*SqlVisualization, error)

public SqlVisualization(string name, SqlVisualizationArgs args, CustomResourceOptions? opts = null)

public SqlVisualization(String name, SqlVisualizationArgs args)
public SqlVisualization(String name, SqlVisualizationArgs args, CustomResourceOptions options)

type: databricks:SqlVisualization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SqlVisualizationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SqlVisualizationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SqlVisualizationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SqlVisualizationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SqlVisualizationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sqlVisualizationResource = new Databricks.SqlVisualization("sqlVisualizationResource", new()
{
    Options = "string",
    QueryId = "string",
    Type = "string",
    Description = "string",
    Name = "string",
    VisualizationId = "string",
});

example, err := databricks.NewSqlVisualization(ctx, "sqlVisualizationResource", &databricks.SqlVisualizationArgs{
	Options:         pulumi.String("string"),
	QueryId:         pulumi.String("string"),
	Type:            pulumi.String("string"),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	VisualizationId: pulumi.String("string"),
})

var sqlVisualizationResource = new SqlVisualization("sqlVisualizationResource", SqlVisualizationArgs.builder()
    .options("string")
    .queryId("string")
    .type("string")
    .description("string")
    .name("string")
    .visualizationId("string")
    .build());

sql_visualization_resource = databricks.SqlVisualization("sqlVisualizationResource",
    options="string",
    query_id="string",
    type="string",
    description="string",
    name="string",
    visualization_id="string")

const sqlVisualizationResource = new databricks.SqlVisualization("sqlVisualizationResource", {
    options: "string",
    queryId: "string",
    type: "string",
    description: "string",
    name: "string",
    visualizationId: "string",
});

type: databricks:SqlVisualization
properties:
    description: string
    name: string
    options: string
    queryId: string
    type: string
    visualizationId: string

SqlVisualization Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SqlVisualization resource accepts the following input properties:

Options string
QueryId string
Type string
Description string
Name string
VisualizationId string

Options string
QueryId string
Type string
Description string
Name string
VisualizationId string

options String
queryId String
type String
description String
name String
visualizationId String

options string
queryId string
type string
description string
name string
visualizationId string

options str
query_id str
type str
description str
name str
visualization_id str

options String
queryId String
type String
description String
name String
visualizationId String

Outputs

All input properties are implicitly available as output properties. Additionally, the SqlVisualization resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing SqlVisualization Resource

Get an existing SqlVisualization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SqlVisualizationState, opts?: CustomResourceOptions): SqlVisualization

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[str] = None,
        query_id: Optional[str] = None,
        type: Optional[str] = None,
        visualization_id: Optional[str] = None) -> SqlVisualization

func GetSqlVisualization(ctx *Context, name string, id IDInput, state *SqlVisualizationState, opts ...ResourceOption) (*SqlVisualization, error)

public static SqlVisualization Get(string name, Input<string> id, SqlVisualizationState? state, CustomResourceOptions? opts = null)

public static SqlVisualization get(String name, Output<String> id, SqlVisualizationState state, CustomResourceOptions options)

resources:  _:    type: databricks:SqlVisualization    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string
Name string
Options string
QueryId string
Type string
VisualizationId string

Description string
Name string
Options string
QueryId string
Type string
VisualizationId string

description String
name String
options String
queryId String
type String
visualizationId String

description string
name string
options string
queryId string
type string
visualizationId string

description str
name str
options str
query_id str
type str
visualization_id str

description String
name String
options String
queryId String
type String
visualizationId String

Import

-> Note Importing this resource is not currently supported.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

databricks.SqlVisualization

On this page

On this page

Example Usage

Create SqlVisualization Resource

Constructor syntax

Parameters

Constructor example

SqlVisualization Resource Properties

Inputs

Outputs

Look up Existing SqlVisualization Resource

Import

Package Details

On this page

On this page

databricks.SqlVisualization

On this page

On this page

Related Resources

Example Usage

Create SqlVisualization Resource

Constructor syntax

Parameters

Constructor example

SqlVisualization Resource Properties

Inputs

Outputs

Look up Existing SqlVisualization Resource

Import

Package Details

On this page

On this page