Background Jobs - Run On Demand Table Maintenance

Service:

Lakehouse

API Version:

v1

Note

This API is in preview.

Run on-demand table maintenance job instance.

Required Delegated Scopes

Lakehouse.Execute.All or Item.Execute.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal	No
Managed identities	No

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/jobs/instances?jobType={jobType}

URI Parameters

Name	In	Required	Type	Description
lakehouseId	path	True	string uuid	The Lakehouse item ID.
workspaceId	path	True	string uuid	The workspace ID.
jobType	query	True	string	TableMaintenance job type.

Request Body

Name	Required	Type	Description
executionData	True	TableMaintenanceExecutionData	Execution data to configure the table maintenance job.

Responses

Name	Type	Description
202 Accepted		Request accepted, job execution is in progress. Headers Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: MissingMinimalPermisisons - The caller does not have sufficient permissions to run job instance. InvalidJobType - The requested job type is invalid. TooManyRequestsForJobs - The caller is spamming by lots of run on-demand job requests. ItemNotFound - Requested item id not found.

Examples

Run table maintenance with optimize enabled and vacuum disabled.

Run table maintenance with optimize Z-Order and vacuum enabled.

Run table maintenance with optimize enabled and vacuum disabled.

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/lakehouses/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=TableMaintenance

{
  "executionData": {
    "tableName": "table1",
    "optimizeSettings": {}
  }
}

Sample response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run table maintenance with optimize Z-Order and vacuum enabled.

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/lakehouses/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=TableMaintenance

{
  "executionData": {
    "tableName": "table1",
    "optimizeSettings": {
      "vOrder": true,
      "zOrderBy": [
        "tipAmount"
      ]
    },
    "vacuumSettings": {
      "retentionPeriod": "7:01:00:00"
    }
  }
}

Sample response

Status code:

202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
OptimizeSettings	Table maintenance optimization settings.
RunOnDemandTableMaintenanceRequest	Run on demand lakehouse table maintenance instance payload
TableMaintenanceExecutionData	Run on demand lakehouse table maintenance instance payload
VacuumSettings	Table maintenance vacuum settings.

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

OptimizeSettings

Table maintenance optimization settings.

Name	Type	Description
vOrder	boolean	The V-Order settings. True - Enabled, False - Disabled.
zOrderBy	string[]	A list of column names to Z-Order the data by. If not provided, Z-Ordering isn't applied.

RunOnDemandTableMaintenanceRequest

Run on demand lakehouse table maintenance instance payload

Name	Type	Description
executionData	TableMaintenanceExecutionData	Execution data to configure the table maintenance job.

TableMaintenanceExecutionData

Run on demand lakehouse table maintenance instance payload

Name	Type	Description
optimizeSettings	OptimizeSettings	Configures the optimization settings of the maintenance job. To skip table optimization, leave this parameter empty.
tableName	string	Name of the table to run maintenance on.
vacuumSettings	VacuumSettings	Configures the vacuum settings of the maintenance job. To skip table vacuum, leave this parameter empty.

VacuumSettings

Table maintenance vacuum settings.

Name	Type	Description
retentionPeriod	string	Overrides the default retention period. Unreferenced files or data files associated with delta table versions older than the specified retention period are removed. This value should follow the pattern of d:hh:mm:ss where d is the number of days, hh is the number of hours between 00 and 23, mm is the number of minutes between 00 and 59, and ss is the number of seconds between 00 and 59.