SqlQuery

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 Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var q1 = new Databricks.SqlQuery("q1", new Databricks.SqlQueryArgs
        {
            DataSourceId = databricks_sql_endpoint.Example.Data_source_id,
            Query = "SELECT {{ p1 }} AS p1, 2 as p2",
            RunAsRole = "viewer",
            Schedule = new Databricks.Inputs.SqlQueryScheduleArgs
            {
                Continuous = new Databricks.Inputs.SqlQueryScheduleContinuousArgs
                {
                    IntervalSeconds = 5 * 60,
                },
            },
            Parameters = 
            {
                new Databricks.Inputs.SqlQueryParameterArgs
                {
                    Name = "p1",
                    Title = "Title for p1",
                    Text = new Databricks.Inputs.SqlQueryParameterTextArgs
                    {
                        Value = "default",
                    },
                },
            },
            Tags = 
            {
                "t1",
                "t2",
            },
        });
    }

}

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.NewSqlQuery(ctx, "q1", &databricks.SqlQueryArgs{
			DataSourceId: pulumi.Any(databricks_sql_endpoint.Example.Data_source_id),
			Query:        pulumi.String("SELECT {{ p1 }} AS p1, 2 as p2"),
			RunAsRole:    pulumi.String("viewer"),
			Schedule: &SqlQueryScheduleArgs{
				Continuous: &SqlQueryScheduleContinuousArgs{
					IntervalSeconds: 5 * 60,
				},
			},
			Parameters: SqlQueryParameterArray{
				&SqlQueryParameterArgs{
					Name:  pulumi.String("p1"),
					Title: pulumi.String("Title for p1"),
					Text: &SqlQueryParameterTextArgs{
						Value: pulumi.String("default"),
					},
				},
			},
			Tags: pulumi.StringArray{
				pulumi.String("t1"),
				pulumi.String("t2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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

const q1 = new databricks.SqlQuery("q1", {
    dataSourceId: databricks_sql_endpoint.example.data_source_id,
    query: "SELECT {{ p1 }} AS p1, 2 as p2",
    runAsRole: "viewer",
    schedule: {
        continuous: {
            intervalSeconds: 5 * 60,
        },
    },
    parameters: [{
        name: "p1",
        title: "Title for p1",
        text: {
            value: "default",
        },
    }],
    tags: [
        "t1",
        "t2",
    ],
});

import pulumi
import pulumi_databricks as databricks

q1 = databricks.SqlQuery("q1",
    data_source_id=databricks_sql_endpoint["example"]["data_source_id"],
    query="SELECT {{ p1 }} AS p1, 2 as p2",
    run_as_role="viewer",
    schedule=databricks.SqlQueryScheduleArgs(
        continuous=databricks.SqlQueryScheduleContinuousArgs(
            interval_seconds=5 * 60,
        ),
    ),
    parameters=[databricks.SqlQueryParameterArgs(
        name="p1",
        title="Title for p1",
        text=databricks.SqlQueryParameterTextArgs(
            value="default",
        ),
    )],
    tags=[
        "t1",
        "t2",
    ])

Example coming soon!

Example permission to share query with all users

using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var q1 = new Databricks.Permissions("q1", new Databricks.PermissionsArgs
        {
            SqlQueryId = databricks_sql_query.Q1.Id,
            AccessControls = 
            {
                new Databricks.Inputs.PermissionsAccessControlArgs
                {
                    GroupName = data.Databricks_group.Users.Display_name,
                    PermissionLevel = "CAN_RUN",
                },
                new Databricks.Inputs.PermissionsAccessControlArgs
                {
                    GroupName = data.Databricks_group.Team.Display_name,
                    PermissionLevel = "CAN_EDIT",
                },
            },
        });
    }

}

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.NewPermissions(ctx, "q1", &databricks.PermissionsArgs{
			SqlQueryId: pulumi.Any(databricks_sql_query.Q1.Id),
			AccessControls: PermissionsAccessControlArray{
				&PermissionsAccessControlArgs{
					GroupName:       pulumi.Any(data.Databricks_group.Users.Display_name),
					PermissionLevel: pulumi.String("CAN_RUN"),
				},
				&PermissionsAccessControlArgs{
					GroupName:       pulumi.Any(data.Databricks_group.Team.Display_name),
					PermissionLevel: pulumi.String("CAN_EDIT"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

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

const q1 = new databricks.Permissions("q1", {
    sqlQueryId: databricks_sql_query.q1.id,
    accessControls: [
        {
            groupName: data.databricks_group.users.display_name,
            permissionLevel: "CAN_RUN",
        },
        {
            groupName: data.databricks_group.team.display_name,
            permissionLevel: "CAN_EDIT",
        },
    ],
});

import pulumi
import pulumi_databricks as databricks

q1 = databricks.Permissions("q1",
    sql_query_id=databricks_sql_query["q1"]["id"],
    access_controls=[
        databricks.PermissionsAccessControlArgs(
            group_name=data["databricks_group"]["users"]["display_name"],
            permission_level="CAN_RUN",
        ),
        databricks.PermissionsAccessControlArgs(
            group_name=data["databricks_group"]["team"]["display_name"],
            permission_level="CAN_EDIT",
        ),
    ])

Example coming soon!

Create SqlQuery Resource

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

Constructor syntax

new SqlQuery(name: string, args: SqlQueryArgs, opts?: CustomResourceOptions);

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

@overload
def SqlQuery(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             data_source_id: Optional[str] = None,
             query: Optional[str] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             parameters: Optional[Sequence[SqlQueryParameterArgs]] = None,
             run_as_role: Optional[str] = None,
             schedule: Optional[SqlQueryScheduleArgs] = None,
             tags: Optional[Sequence[str]] = None)

func NewSqlQuery(ctx *Context, name string, args SqlQueryArgs, opts ...ResourceOption) (*SqlQuery, error)

public SqlQuery(string name, SqlQueryArgs args, CustomResourceOptions? opts = null)

public SqlQuery(String name, SqlQueryArgs args)
public SqlQuery(String name, SqlQueryArgs args, CustomResourceOptions options)

type: databricks:SqlQuery
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 SqlQueryArgs: 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 SqlQueryArgs: 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 SqlQueryArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SqlQueryArgs: 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 sqlQueryResource = new Databricks.SqlQuery("sqlQueryResource", new()
{
    DataSourceId = "string",
    Query = "string",
    Description = "string",
    Name = "string",
    Parameters = new[]
    {
        new Databricks.Inputs.SqlQueryParameterArgs
        {
            Name = "string",
            Date = new Databricks.Inputs.SqlQueryParameterDateArgs
            {
                Value = "string",
            },
            DateRange = new Databricks.Inputs.SqlQueryParameterDateRangeArgs
            {
                Value = "string",
            },
            Datetime = new Databricks.Inputs.SqlQueryParameterDatetimeArgs
            {
                Value = "string",
            },
            DatetimeRange = new Databricks.Inputs.SqlQueryParameterDatetimeRangeArgs
            {
                Value = "string",
            },
            Datetimesec = new Databricks.Inputs.SqlQueryParameterDatetimesecArgs
            {
                Value = "string",
            },
            DatetimesecRange = new Databricks.Inputs.SqlQueryParameterDatetimesecRangeArgs
            {
                Value = "string",
            },
            Enum = new Databricks.Inputs.SqlQueryParameterEnumArgs
            {
                Options = new[]
                {
                    "string",
                },
                Multiple = new Databricks.Inputs.SqlQueryParameterEnumMultipleArgs
                {
                    Prefix = "string",
                    Separator = "string",
                    Suffix = "string",
                },
                Value = "string",
                Values = new[]
                {
                    "string",
                },
            },
            Number = new Databricks.Inputs.SqlQueryParameterNumberArgs
            {
                Value = 0,
            },
            Query = new Databricks.Inputs.SqlQueryParameterQueryArgs
            {
                QueryId = "string",
                Multiple = new Databricks.Inputs.SqlQueryParameterQueryMultipleArgs
                {
                    Prefix = "string",
                    Separator = "string",
                    Suffix = "string",
                },
                Value = "string",
                Values = new[]
                {
                    "string",
                },
            },
            Text = new Databricks.Inputs.SqlQueryParameterTextArgs
            {
                Value = "string",
            },
            Title = "string",
        },
    },
    RunAsRole = "string",
    Schedule = new Databricks.Inputs.SqlQueryScheduleArgs
    {
        Continuous = new Databricks.Inputs.SqlQueryScheduleContinuousArgs
        {
            IntervalSeconds = 0,
            UntilDate = "string",
        },
        Daily = new Databricks.Inputs.SqlQueryScheduleDailyArgs
        {
            IntervalDays = 0,
            TimeOfDay = "string",
            UntilDate = "string",
        },
        Weekly = new Databricks.Inputs.SqlQueryScheduleWeeklyArgs
        {
            DayOfWeek = "string",
            IntervalWeeks = 0,
            TimeOfDay = "string",
            UntilDate = "string",
        },
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := databricks.NewSqlQuery(ctx, "sqlQueryResource", &databricks.SqlQueryArgs{
	DataSourceId: pulumi.String("string"),
	Query:        pulumi.String("string"),
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	Parameters: databricks.SqlQueryParameterArray{
		&databricks.SqlQueryParameterArgs{
			Name: pulumi.String("string"),
			Date: &databricks.SqlQueryParameterDateArgs{
				Value: pulumi.String("string"),
			},
			DateRange: &databricks.SqlQueryParameterDateRangeArgs{
				Value: pulumi.String("string"),
			},
			Datetime: &databricks.SqlQueryParameterDatetimeArgs{
				Value: pulumi.String("string"),
			},
			DatetimeRange: &databricks.SqlQueryParameterDatetimeRangeArgs{
				Value: pulumi.String("string"),
			},
			Datetimesec: &databricks.SqlQueryParameterDatetimesecArgs{
				Value: pulumi.String("string"),
			},
			DatetimesecRange: &databricks.SqlQueryParameterDatetimesecRangeArgs{
				Value: pulumi.String("string"),
			},
			Enum: &databricks.SqlQueryParameterEnumArgs{
				Options: pulumi.StringArray{
					pulumi.String("string"),
				},
				Multiple: &databricks.SqlQueryParameterEnumMultipleArgs{
					Prefix:    pulumi.String("string"),
					Separator: pulumi.String("string"),
					Suffix:    pulumi.String("string"),
				},
				Value: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Number: &databricks.SqlQueryParameterNumberArgs{
				Value: pulumi.Float64(0),
			},
			Query: &databricks.SqlQueryParameterQueryArgs{
				QueryId: pulumi.String("string"),
				Multiple: &databricks.SqlQueryParameterQueryMultipleArgs{
					Prefix:    pulumi.String("string"),
					Separator: pulumi.String("string"),
					Suffix:    pulumi.String("string"),
				},
				Value: pulumi.String("string"),
				Values: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Text: &databricks.SqlQueryParameterTextArgs{
				Value: pulumi.String("string"),
			},
			Title: pulumi.String("string"),
		},
	},
	RunAsRole: pulumi.String("string"),
	Schedule: &databricks.SqlQueryScheduleArgs{
		Continuous: &databricks.SqlQueryScheduleContinuousArgs{
			IntervalSeconds: pulumi.Int(0),
			UntilDate:       pulumi.String("string"),
		},
		Daily: &databricks.SqlQueryScheduleDailyArgs{
			IntervalDays: pulumi.Int(0),
			TimeOfDay:    pulumi.String("string"),
			UntilDate:    pulumi.String("string"),
		},
		Weekly: &databricks.SqlQueryScheduleWeeklyArgs{
			DayOfWeek:     pulumi.String("string"),
			IntervalWeeks: pulumi.Int(0),
			TimeOfDay:     pulumi.String("string"),
			UntilDate:     pulumi.String("string"),
		},
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var sqlQueryResource = new SqlQuery("sqlQueryResource", SqlQueryArgs.builder()
    .dataSourceId("string")
    .query("string")
    .description("string")
    .name("string")
    .parameters(SqlQueryParameterArgs.builder()
        .name("string")
        .date(SqlQueryParameterDateArgs.builder()
            .value("string")
            .build())
        .dateRange(SqlQueryParameterDateRangeArgs.builder()
            .value("string")
            .build())
        .datetime(SqlQueryParameterDatetimeArgs.builder()
            .value("string")
            .build())
        .datetimeRange(SqlQueryParameterDatetimeRangeArgs.builder()
            .value("string")
            .build())
        .datetimesec(SqlQueryParameterDatetimesecArgs.builder()
            .value("string")
            .build())
        .datetimesecRange(SqlQueryParameterDatetimesecRangeArgs.builder()
            .value("string")
            .build())
        .enum_(SqlQueryParameterEnumArgs.builder()
            .options("string")
            .multiple(SqlQueryParameterEnumMultipleArgs.builder()
                .prefix("string")
                .separator("string")
                .suffix("string")
                .build())
            .value("string")
            .values("string")
            .build())
        .number(SqlQueryParameterNumberArgs.builder()
            .value(0.0)
            .build())
        .query(SqlQueryParameterQueryArgs.builder()
            .queryId("string")
            .multiple(SqlQueryParameterQueryMultipleArgs.builder()
                .prefix("string")
                .separator("string")
                .suffix("string")
                .build())
            .value("string")
            .values("string")
            .build())
        .text(SqlQueryParameterTextArgs.builder()
            .value("string")
            .build())
        .title("string")
        .build())
    .runAsRole("string")
    .schedule(SqlQueryScheduleArgs.builder()
        .continuous(SqlQueryScheduleContinuousArgs.builder()
            .intervalSeconds(0)
            .untilDate("string")
            .build())
        .daily(SqlQueryScheduleDailyArgs.builder()
            .intervalDays(0)
            .timeOfDay("string")
            .untilDate("string")
            .build())
        .weekly(SqlQueryScheduleWeeklyArgs.builder()
            .dayOfWeek("string")
            .intervalWeeks(0)
            .timeOfDay("string")
            .untilDate("string")
            .build())
        .build())
    .tags("string")
    .build());

sql_query_resource = databricks.SqlQuery("sqlQueryResource",
    data_source_id="string",
    query="string",
    description="string",
    name="string",
    parameters=[{
        "name": "string",
        "date": {
            "value": "string",
        },
        "date_range": {
            "value": "string",
        },
        "datetime": {
            "value": "string",
        },
        "datetime_range": {
            "value": "string",
        },
        "datetimesec": {
            "value": "string",
        },
        "datetimesec_range": {
            "value": "string",
        },
        "enum": {
            "options": ["string"],
            "multiple": {
                "prefix": "string",
                "separator": "string",
                "suffix": "string",
            },
            "value": "string",
            "values": ["string"],
        },
        "number": {
            "value": 0,
        },
        "query": {
            "query_id": "string",
            "multiple": {
                "prefix": "string",
                "separator": "string",
                "suffix": "string",
            },
            "value": "string",
            "values": ["string"],
        },
        "text": {
            "value": "string",
        },
        "title": "string",
    }],
    run_as_role="string",
    schedule={
        "continuous": {
            "interval_seconds": 0,
            "until_date": "string",
        },
        "daily": {
            "interval_days": 0,
            "time_of_day": "string",
            "until_date": "string",
        },
        "weekly": {
            "day_of_week": "string",
            "interval_weeks": 0,
            "time_of_day": "string",
            "until_date": "string",
        },
    },
    tags=["string"])

const sqlQueryResource = new databricks.SqlQuery("sqlQueryResource", {
    dataSourceId: "string",
    query: "string",
    description: "string",
    name: "string",
    parameters: [{
        name: "string",
        date: {
            value: "string",
        },
        dateRange: {
            value: "string",
        },
        datetime: {
            value: "string",
        },
        datetimeRange: {
            value: "string",
        },
        datetimesec: {
            value: "string",
        },
        datetimesecRange: {
            value: "string",
        },
        "enum": {
            options: ["string"],
            multiple: {
                prefix: "string",
                separator: "string",
                suffix: "string",
            },
            value: "string",
            values: ["string"],
        },
        number: {
            value: 0,
        },
        query: {
            queryId: "string",
            multiple: {
                prefix: "string",
                separator: "string",
                suffix: "string",
            },
            value: "string",
            values: ["string"],
        },
        text: {
            value: "string",
        },
        title: "string",
    }],
    runAsRole: "string",
    schedule: {
        continuous: {
            intervalSeconds: 0,
            untilDate: "string",
        },
        daily: {
            intervalDays: 0,
            timeOfDay: "string",
            untilDate: "string",
        },
        weekly: {
            dayOfWeek: "string",
            intervalWeeks: 0,
            timeOfDay: "string",
            untilDate: "string",
        },
    },
    tags: ["string"],
});

type: databricks:SqlQuery
properties:
    dataSourceId: string
    description: string
    name: string
    parameters:
        - date:
            value: string
          dateRange:
            value: string
          datetime:
            value: string
          datetimeRange:
            value: string
          datetimesec:
            value: string
          datetimesecRange:
            value: string
          enum:
            multiple:
                prefix: string
                separator: string
                suffix: string
            options:
                - string
            value: string
            values:
                - string
          name: string
          number:
            value: 0
          query:
            multiple:
                prefix: string
                separator: string
                suffix: string
            queryId: string
            value: string
            values:
                - string
          text:
            value: string
          title: string
    query: string
    runAsRole: string
    schedule:
        continuous:
            intervalSeconds: 0
            untilDate: string
        daily:
            intervalDays: 0
            timeOfDay: string
            untilDate: string
        weekly:
            dayOfWeek: string
            intervalWeeks: 0
            timeOfDay: string
            untilDate: string
    tags:
        - string

SqlQuery 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 SqlQuery resource accepts the following input properties:

DataSourceId string
Query string
Description string
Name string
Parameters List<SqlQueryParameter>
RunAsRole string
Schedule SqlQuerySchedule
Tags List<string>

DataSourceId string
Query string
Description string
Name string
Parameters []SqlQueryParameterArgs
RunAsRole string
Schedule SqlQueryScheduleArgs
Tags []string

dataSourceId String
query String
description String
name String
parameters List<SqlQueryParameter>
runAsRole String
schedule SqlQuerySchedule
tags List<String>

dataSourceId string
query string
description string
name string
parameters SqlQueryParameter[]
runAsRole string
schedule SqlQuerySchedule
tags string[]

data_source_id str
query str
description str
name str
parameters Sequence[SqlQueryParameterArgs]
run_as_role str
schedule SqlQueryScheduleArgs
tags Sequence[str]

dataSourceId String
query String
description String
name String
parameters List<Property Map>
runAsRole String
schedule Property Map
tags List<String>

Outputs

All input properties are implicitly available as output properties. Additionally, the SqlQuery 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 SqlQuery Resource

Get an existing SqlQuery 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?: SqlQueryState, opts?: CustomResourceOptions): SqlQuery

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_source_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[SqlQueryParameterArgs]] = None,
        query: Optional[str] = None,
        run_as_role: Optional[str] = None,
        schedule: Optional[SqlQueryScheduleArgs] = None,
        tags: Optional[Sequence[str]] = None) -> SqlQuery

func GetSqlQuery(ctx *Context, name string, id IDInput, state *SqlQueryState, opts ...ResourceOption) (*SqlQuery, error)

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

public static SqlQuery get(String name, Output<String> id, SqlQueryState state, CustomResourceOptions options)

resources:  _:    type: databricks:SqlQuery    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:

DataSourceId string
Description string
Name string
Parameters List<SqlQueryParameter>
Query string
RunAsRole string
Schedule SqlQuerySchedule
Tags List<string>

DataSourceId string
Description string
Name string
Parameters []SqlQueryParameterArgs
Query string
RunAsRole string
Schedule SqlQueryScheduleArgs
Tags []string

dataSourceId String
description String
name String
parameters List<SqlQueryParameter>
query String
runAsRole String
schedule SqlQuerySchedule
tags List<String>

dataSourceId string
description string
name string
parameters SqlQueryParameter[]
query string
runAsRole string
schedule SqlQuerySchedule
tags string[]

data_source_id str
description str
name str
parameters Sequence[SqlQueryParameterArgs]
query str
run_as_role str
schedule SqlQueryScheduleArgs
tags Sequence[str]

dataSourceId String
description String
name String
parameters List<Property Map>
query String
runAsRole String
schedule Property Map
tags List<String>

Supporting Types

SqlQueryParameter, SqlQueryParameterArgs

SqlQueryParameterDate, SqlQueryParameterDateArgs

Value string

Value string

value String

value string

value str

value String

SqlQueryParameterDateRange, SqlQueryParameterDateRangeArgs

Value string

Value string

value String

value string

value str

value String

SqlQueryParameterDatetime, SqlQueryParameterDatetimeArgs

Value string

Value string

value String

value string

value str

value String

SqlQueryParameterDatetimeRange, SqlQueryParameterDatetimeRangeArgs

Value string

Value string

value String

value string

value str

value String

SqlQueryParameterDatetimesec, SqlQueryParameterDatetimesecArgs

Value string

Value string

value String

value string

value str

value String

SqlQueryParameterDatetimesecRange, SqlQueryParameterDatetimesecRangeArgs

Value string

Value string

value String

value string

value str

value String

SqlQueryParameterEnum, SqlQueryParameterEnumArgs

Options List<string>
Multiple SqlQueryParameterEnumMultiple
Value string
Values List<string>

Options []string
Multiple SqlQueryParameterEnumMultiple
Value string
Values []string

options List<String>
multiple SqlQueryParameterEnumMultiple
value String
values List<String>

options string[]
multiple SqlQueryParameterEnumMultiple
value string
values string[]

options Sequence[str]
multiple SqlQueryParameterEnumMultiple
value str
values Sequence[str]

options List<String>
multiple Property Map
value String
values List<String>

SqlQueryParameterEnumMultiple, SqlQueryParameterEnumMultipleArgs

Prefix string
Separator string
Suffix string

Prefix string
Separator string
Suffix string

prefix String
separator String
suffix String

prefix string
separator string
suffix string

prefix str
separator str
suffix str

prefix String
separator String
suffix String

SqlQueryParameterNumber, SqlQueryParameterNumberArgs

Value double

Value float64

value Double

value number

value float

value Number

SqlQueryParameterQuery, SqlQueryParameterQueryArgs

QueryId string
Multiple SqlQueryParameterQueryMultiple
Value string
Values List<string>

QueryId string
Multiple SqlQueryParameterQueryMultiple
Value string
Values []string

queryId String
multiple SqlQueryParameterQueryMultiple
value String
values List<String>

queryId string
multiple SqlQueryParameterQueryMultiple
value string
values string[]

query_id str
multiple SqlQueryParameterQueryMultiple
value str
values Sequence[str]

queryId String
multiple Property Map
value String
values List<String>

SqlQueryParameterQueryMultiple, SqlQueryParameterQueryMultipleArgs

Prefix string
Separator string
Suffix string

Prefix string
Separator string
Suffix string

prefix String
separator String
suffix String

prefix string
separator string
suffix string

prefix str
separator str
suffix str

prefix String
separator String
suffix String

SqlQueryParameterText, SqlQueryParameterTextArgs

Value string

Value string

value String

value string

value str

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

On this page

On this page

Example Usage

Create SqlQuery Resource

Constructor syntax

Parameters

Constructor example

SqlQuery Resource Properties

Inputs

Outputs

Look up Existing SqlQuery Resource

Supporting Types

SqlQueryParameter, SqlQueryParameterArgs

SqlQueryParameterDate, SqlQueryParameterDateArgs

SqlQueryParameterDateRange, SqlQueryParameterDateRangeArgs

SqlQueryParameterDatetime, SqlQueryParameterDatetimeArgs

SqlQueryParameterDatetimeRange, SqlQueryParameterDatetimeRangeArgs

SqlQueryParameterDatetimesec, SqlQueryParameterDatetimesecArgs

SqlQueryParameterDatetimesecRange, SqlQueryParameterDatetimesecRangeArgs

SqlQueryParameterEnum, SqlQueryParameterEnumArgs

SqlQueryParameterEnumMultiple, SqlQueryParameterEnumMultipleArgs

SqlQueryParameterNumber, SqlQueryParameterNumberArgs

SqlQueryParameterQuery, SqlQueryParameterQueryArgs

SqlQueryParameterQueryMultiple, SqlQueryParameterQueryMultipleArgs

SqlQueryParameterText, SqlQueryParameterTextArgs

SqlQuerySchedule, SqlQueryScheduleArgs

SqlQueryScheduleContinuous, SqlQueryScheduleContinuousArgs

SqlQueryScheduleDaily, SqlQueryScheduleDailyArgs

SqlQueryScheduleWeekly, SqlQueryScheduleWeeklyArgs

Import

Package Details

On this page

On this page

databricks.SqlQuery

On this page

On this page

Related Resources

Example Usage

Create SqlQuery Resource

Constructor syntax

Parameters

Constructor example

SqlQuery Resource Properties

Inputs

Outputs

Look up Existing SqlQuery Resource

Supporting Types

SqlQueryParameter, SqlQueryParameterArgs

SqlQueryParameterDate, SqlQueryParameterDateArgs

SqlQueryParameterDateRange, SqlQueryParameterDateRangeArgs

SqlQueryParameterDatetime, SqlQueryParameterDatetimeArgs

SqlQueryParameterDatetimeRange, SqlQueryParameterDatetimeRangeArgs

SqlQueryParameterDatetimesec, SqlQueryParameterDatetimesecArgs

SqlQueryParameterDatetimesecRange, SqlQueryParameterDatetimesecRangeArgs

SqlQueryParameterEnum, SqlQueryParameterEnumArgs

SqlQueryParameterEnumMultiple, SqlQueryParameterEnumMultipleArgs

SqlQueryParameterNumber, SqlQueryParameterNumberArgs

SqlQueryParameterQuery, SqlQueryParameterQueryArgs

SqlQueryParameterQueryMultiple, SqlQueryParameterQueryMultipleArgs

SqlQueryParameterText, SqlQueryParameterTextArgs

SqlQuerySchedule, SqlQueryScheduleArgs

SqlQueryScheduleContinuous, SqlQueryScheduleContinuousArgs

SqlQueryScheduleDaily, SqlQueryScheduleDailyArgs

SqlQueryScheduleWeekly, SqlQueryScheduleWeeklyArgs

Import

Package Details

On this page

On this page