databricks.getDataQualityRefreshes
This data source can be used to fetch the list of data quality refreshes on a Unity Catalog table.
The caller must either:
- be an owner of the table’s parent catalog
- have USE_CATALOG on the table’s parent catalog and be an owner of the table’s parent schema.
- have the following permissions:
- USE_CATALOG on the table’s parent catalog
- USE_SCHEMA on the table’s parent schema
- SELECT privilege on the table.
Note This data source can only be used with a workspace-level provider!
Example Usage
Getting a list of all data quality refresh for a given table:
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const _this = databricks.getTable({
name: "my_catalog.my_schema.my_table",
});
const all = _this.then(_this => databricks.getDataQualityRefreshes({
objectType: "table",
objectId: _this.id,
}));
import pulumi
import pulumi_databricks as databricks
this = databricks.get_table(name="my_catalog.my_schema.my_table")
all = databricks.get_data_quality_refreshes(object_type="table",
object_id=this.id)
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.LookupTable(ctx, &databricks.LookupTableArgs{
Name: "my_catalog.my_schema.my_table",
}, nil)
if err != nil {
return err
}
_, err = databricks.GetDataQualityRefreshes(ctx, &databricks.GetDataQualityRefreshesArgs{
ObjectType: "table",
ObjectId: this.Id,
}, 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.GetTable.Invoke(new()
{
Name = "my_catalog.my_schema.my_table",
});
var all = Databricks.GetDataQualityRefreshes.Invoke(new()
{
ObjectType = "table",
ObjectId = @this.Apply(getTableResult => getTableResult.Id),
});
});
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.GetTableArgs;
import com.pulumi.databricks.inputs.GetDataQualityRefreshesArgs;
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.getTable(GetTableArgs.builder()
.name("my_catalog.my_schema.my_table")
.build());
final var all = DatabricksFunctions.getDataQualityRefreshes(GetDataQualityRefreshesArgs.builder()
.objectType("table")
.objectId(this_.id())
.build());
}
}
variables:
this:
fn::invoke:
function: databricks:getTable
arguments:
name: my_catalog.my_schema.my_table
all:
fn::invoke:
function: databricks:getDataQualityRefreshes
arguments:
objectType: table
objectId: ${this.id}
Using getDataQualityRefreshes
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 getDataQualityRefreshes(args: GetDataQualityRefreshesArgs, opts?: InvokeOptions): Promise<GetDataQualityRefreshesResult>
function getDataQualityRefreshesOutput(args: GetDataQualityRefreshesOutputArgs, opts?: InvokeOptions): Output<GetDataQualityRefreshesResult>def get_data_quality_refreshes(object_id: Optional[str] = None,
object_type: Optional[str] = None,
page_size: Optional[int] = None,
opts: Optional[InvokeOptions] = None) -> GetDataQualityRefreshesResult
def get_data_quality_refreshes_output(object_id: Optional[pulumi.Input[str]] = None,
object_type: Optional[pulumi.Input[str]] = None,
page_size: Optional[pulumi.Input[int]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDataQualityRefreshesResult]func GetDataQualityRefreshes(ctx *Context, args *GetDataQualityRefreshesArgs, opts ...InvokeOption) (*GetDataQualityRefreshesResult, error)
func GetDataQualityRefreshesOutput(ctx *Context, args *GetDataQualityRefreshesOutputArgs, opts ...InvokeOption) GetDataQualityRefreshesResultOutput> Note: This function is named GetDataQualityRefreshes in the Go SDK.
public static class GetDataQualityRefreshes
{
public static Task<GetDataQualityRefreshesResult> InvokeAsync(GetDataQualityRefreshesArgs args, InvokeOptions? opts = null)
public static Output<GetDataQualityRefreshesResult> Invoke(GetDataQualityRefreshesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDataQualityRefreshesResult> getDataQualityRefreshes(GetDataQualityRefreshesArgs args, InvokeOptions options)
public static Output<GetDataQualityRefreshesResult> getDataQualityRefreshes(GetDataQualityRefreshesArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getDataQualityRefreshes:getDataQualityRefreshes
arguments:
# arguments dictionaryThe following arguments are supported:
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - Page
Size int
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - Page
Size int
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable - page
Size Integer
- object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - page
Size number
- object_
id str The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object_
type str - The type of the monitored object. Can be one of the following:
schemaortable - page_
size int
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable - page
Size Number
getDataQualityRefreshes Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Object
Id string - (string) - The UUID of the request object. It is
schema_idforschema, andtable_idfortable. - Object
Type string - (string) - The type of the monitored object. Can be one of the following:
schemaortable - Refreshes
List<Get
Data Quality Refreshes Refresh> - Page
Size int
- Id string
- The provider-assigned unique ID for this managed resource.
- Object
Id string - (string) - The UUID of the request object. It is
schema_idforschema, andtable_idfortable. - Object
Type string - (string) - The type of the monitored object. Can be one of the following:
schemaortable - Refreshes
[]Get
Data Quality Refreshes Refresh - Page
Size int
- id String
- The provider-assigned unique ID for this managed resource.
- object
Id String - (string) - The UUID of the request object. It is
schema_idforschema, andtable_idfortable. - object
Type String - (string) - The type of the monitored object. Can be one of the following:
schemaortable - refreshes
List<Get
Data Quality Refreshes Refresh> - page
Size Integer
- id string
- The provider-assigned unique ID for this managed resource.
- object
Id string - (string) - The UUID of the request object. It is
schema_idforschema, andtable_idfortable. - object
Type string - (string) - The type of the monitored object. Can be one of the following:
schemaortable - refreshes
Get
Data Quality Refreshes Refresh[] - page
Size number
- id str
- The provider-assigned unique ID for this managed resource.
- object_
id str - (string) - The UUID of the request object. It is
schema_idforschema, andtable_idfortable. - object_
type str - (string) - The type of the monitored object. Can be one of the following:
schemaortable - refreshes
Sequence[Get
Data Quality Refreshes Refresh] - page_
size int
- id String
- The provider-assigned unique ID for this managed resource.
- object
Id String - (string) - The UUID of the request object. It is
schema_idforschema, andtable_idfortable. - object
Type String - (string) - The type of the monitored object. Can be one of the following:
schemaortable - refreshes List<Property Map>
- page
Size Number
Supporting Types
GetDataQualityRefreshesRefresh
- End
Time intMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- Message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - Refresh
Id int - (integer) - Unique id of the refresh operation
- Start
Time intMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- State string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - Trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- End
Time intMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- Message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- Object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- Object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - Refresh
Id int - (integer) - Unique id of the refresh operation
- Start
Time intMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- State string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - Trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time IntegerMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message String
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable - refresh
Id Integer - (integer) - Unique id of the refresh operation
- start
Time IntegerMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state String
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger String
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time numberMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message string
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object
Id string The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type string - The type of the monitored object. Can be one of the following:
schemaortable - refresh
Id number - (integer) - Unique id of the refresh operation
- start
Time numberMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state string
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger string
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end_
time_ intms - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message str
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object_
id str The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object_
type str - The type of the monitored object. Can be one of the following:
schemaortable - refresh_
id int - (integer) - Unique id of the refresh operation
- start_
time_ intms - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state str
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger str
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
- end
Time NumberMs - (integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)
- message String
- (string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)
- object
Id String The UUID of the request object. It is
schema_idforschema, andtable_idfortable.Find the
schema_idfrom either:- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
Schemasresource. - In Catalog Explorer > select the
schema> go to theDetailstab > theSchema IDfield.
Find the
table_idfrom either:- The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the
Tablesresource. - In Catalog Explorer > select the
table> go to theDetailstab > theTable IDfield
- The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the
- object
Type String - The type of the monitored object. Can be one of the following:
schemaortable - refresh
Id Number - (integer) - Unique id of the refresh operation
- start
Time NumberMs - (integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)
- state String
- (string) - The current state of the refresh. Possible values are:
MONITOR_REFRESH_STATE_CANCELED,MONITOR_REFRESH_STATE_FAILED,MONITOR_REFRESH_STATE_PENDING,MONITOR_REFRESH_STATE_RUNNING,MONITOR_REFRESH_STATE_SUCCESS,MONITOR_REFRESH_STATE_UNKNOWN - trigger String
- (string) - What triggered the refresh. Possible values are:
MONITOR_REFRESH_TRIGGER_DATA_CHANGE,MONITOR_REFRESH_TRIGGER_MANUAL,MONITOR_REFRESH_TRIGGER_SCHEDULE,MONITOR_REFRESH_TRIGGER_UNKNOWN
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
