Delen via

Background Jobs - Run On Demand Table Maintenance

  • Referentie
Service:
Lakehouse
API-versie:
v1

Notitie

Deze API is in preview.

Voer op aanvraag tabelonderhoud uit taakexemplaren.

Vereiste gedelegeerde bereiken

Lakehouse.Execute.All of Item.Execute.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit Steunen
Gebruiker Ja
service-principal en beheerde identiteiten Nee

Interface

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

URI-parameters

Name In Vereist Type Description
lakehouseId
 path True

string

uuid

De item-id van Lakehouse.
workspaceId
 path True

string

uuid

De werkruimte-id.
jobType
 query True

string

TableMaintenance taaktype.

Aanvraagbody

Name Vereist Type Description
executionData True

TableMaintenanceExecutionData

Uitvoeringsgegevens voor het configureren van het tabelonderhoud taak.

Antwoorden

Name Type Description
202 Accepted

Aanvraag geaccepteerd, taakuitvoering wordt uitgevoerd.

Kopteksten

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • MissingMinimalPermissions - De aanroeper beschikt niet over voldoende machtigingen om het taakexemplaren uit te voeren.

  • InvalidJobType: het aangevraagde taaktype is ongeldig.

  • TooManyRequestsForJobs - De beller spamt door veel aanvragen voor on-demand taken.

  • ItemNotFound - Aangevraagde item-id is niet gevonden.

Voorbeelden

Run table maintenance with optimize enabled and vacuum disabled.
Run table maintenance with optimize Z-Order and vacuum enabled for schema enabled lakehouse.
Run table maintenance with optimize Z-Order and vacuum enabled.

Run table maintenance with optimize enabled and vacuum disabled.

Voorbeeldaanvraag

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": {}
  }
}

Voorbeeldrespons

Statuscode:
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 for schema enabled lakehouse.

Voorbeeldaanvraag

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",
    "schemaName": "dbo",
    "optimizeSettings": {
      "vOrder": true,
      "zOrderBy": [
        "tipAmount"
      ]
    },
    "vacuumSettings": {
      "retentionPeriod": "7:01:00:00"
    }
  }
}

Voorbeeldrespons

Statuscode:
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.

Voorbeeldaanvraag

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"
    }
  }
}

Voorbeeldrespons

Statuscode:
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

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
OptimizeSettings

Instellingen voor optimalisatie van tabelonderhoud.
RunOnDemandTableMaintenanceRequest

Nettolading van lakehouse-tabelonderhoudsexemplaren uitvoeren op aanvraag
TableMaintenanceExecutionData

Nettolading van lakehouse-tabelonderhoudsexemplaren uitvoeren op aanvraag
VacuumSettings

Tabelonderhoud vacuüm instellingen.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

OptimizeSettings

Object

Instellingen voor optimalisatie van tabelonderhoud.

Name Type Description
vOrder

boolean

De V-Order instellingen. True - Ingeschakeld, Onwaar - Uitgeschakeld.
zOrderBy

string[]

Een lijst met kolomnamen naar Z-Order van de gegevens op. Indien niet opgegeven, wordt Z-Ordering niet toegepast.

RunOnDemandTableMaintenanceRequest

Object

Nettolading van lakehouse-tabelonderhoudsexemplaren uitvoeren op aanvraag

Name Type Description
executionData

TableMaintenanceExecutionData

Uitvoeringsgegevens voor het configureren van het tabelonderhoud taak.

TableMaintenanceExecutionData

Object

Nettolading van lakehouse-tabelonderhoudsexemplaren uitvoeren op aanvraag

Name Type Description
optimizeSettings

OptimizeSettings

Hiermee configureert u de optimalisatie-instellingen van de onderhoudstaak. Als u tabeloptimalisatie wilt overslaan, laat u deze parameter leeg.
schemaName

string

Naam van het schema waaronder de tabel wordt gemaakt. Deze eigenschap is alleen van toepassing op een schema ingeschakeld Lakehouse. Maximale lengte van alfanumerieke tekenreeks van 128 tekens met onderstrepingstekens.
tableName

string

De naam van de tabel waarop onderhoud moet worden uitgevoerd. Maximale lengte van alfanumerieke tekenreeks van 256 tekens met onderstrepingstekens.
vacuumSettings

VacuumSettings

Hiermee configureert u de vacuüm instellingen van de onderhoudstaak. Als u tabelvacuüm wilt overslaan, laat u deze parameter leeg.

VacuumSettings

Object

Tabelonderhoud vacuüm instellingen.

Name Type Description
retentionPeriod

string

Hiermee wordt de standaardretentieperiode overschreven. Niet-deductiebestanden of gegevensbestanden die zijn gekoppeld aan deltatabelversies die ouder zijn dan de opgegeven bewaarperiode, worden verwijderd. Deze waarde moet het patroon van d:hh:mm:ss volgen waarbij d het aantal dagen is, uu is het aantal uren tussen 00 en 23, mm het aantal minuten tussen 00 en 59, en ss het aantal seconden tussen 00 en 59.