Del via

Background Jobs - Run On Demand Table Maintenance

  • Reference
Tjeneste:
Lakehouse
API-version:
v1

Seddel

Denne API er en prøveversion.

Kør on-demand-tabelvedligeholdelse jobforekomst.

Påkrævede delegerede områder

Lakehouse.Execute.All eller Item.Execute.All

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Nej

Grænseflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
lakehouseId
 path True

string

uuid

Lakehouse-vare-id'et.
workspaceId
 path True

string

uuid

Arbejdsområde-id'et.
jobType
 query True

string

TableMaintenance jobtype.

Brødtekst for anmodning

Name Påkrævet Type Beskrivelse
executionData True

TableMaintenanceExecutionData

Udførelsesdata til konfiguration af tabelvedligeholdelse job.

Svar

Name Type Beskrivelse
202 Accepted

Anmodningen er accepteret. Jobudførelsen er i gang.

Headere

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

ErrorResponse

Almindelige fejlkoder:

  • MissingMinimalPermissions – Kalderen har ikke tilstrækkelige tilladelser til at køre jobforekomsten.

  • InvalidJobType – Den anmodede jobtype er ugyldig.

  • TooManyRequestsForJobs – Den, der ringer op, spammer med mange kørselsanmodninger efter behov.

  • ItemNotFound - Det anmodede element-id blev ikke fundet.

Eksempler

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.

Eksempelanmodning

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

Eksempelsvar

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

Eksempelanmodning

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

Eksempelsvar

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

Eksempelanmodning

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

Eksempelsvar

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

Definitioner

Name Beskrivelse
ErrorRelatedResource

Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse

Fejlsvaret.
ErrorResponseDetails

Oplysninger om fejlsvar.
OptimizeSettings

Indstillinger for optimering af tabelvedligeholdelse.
RunOnDemandTableMaintenanceRequest

Kør nyttedata for lakehouse-tabelvedligeholdelse efter behov
TableMaintenanceExecutionData

Kør nyttedata for lakehouse-tabelvedligeholdelse efter behov
VacuumSettings

Indstillinger for tabelvedligeholdelse vakuum.

ErrorRelatedResource

Object

Objektet med fejlrelaterede ressourceoplysninger.

Name Type Beskrivelse
resourceId

string

Det ressource-id, der er involveret i fejlen.
resourceType

string

Typen af ressource, der er involveret i fejlen.

ErrorResponse

Object

Fejlsvaret.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
moreDetails

ErrorResponseDetails[]

Liste over yderligere oplysninger om fejl.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.
requestId

string

Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Object

Oplysninger om fejlsvar.

Name Type Beskrivelse
errorCode

string

Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message

string

En menneskelig læsbar gengivelse af fejlen.
relatedResource

ErrorRelatedResource

De fejlrelaterede ressourceoplysninger.

OptimizeSettings

Object

Indstillinger for optimering af tabelvedligeholdelse.

Name Type Beskrivelse
vOrder

boolean

Indstillingerne for V-Order. True – Aktiveret, Falsk – Deaktiveret.
zOrderBy

string[]

En liste over kolonnenavne, som dataene skal sorteres efter. Hvis den ikke er angivet, anvendes Z-ordering ikke.

RunOnDemandTableMaintenanceRequest

Object

Kør nyttedata for lakehouse-tabelvedligeholdelse efter behov

Name Type Beskrivelse
executionData

TableMaintenanceExecutionData

Udførelsesdata til konfiguration af tabelvedligeholdelse job.

TableMaintenanceExecutionData

Object

Kør nyttedata for lakehouse-tabelvedligeholdelse efter behov

Name Type Beskrivelse
optimizeSettings

OptimizeSettings

Konfigurerer optimeringsindstillingerne for vedligeholdelsesjobbet. Hvis du vil springe tabeloptimering over, skal du lade denne parameter være tom.
schemaName

string

Navnet på det skema, som tabellen er oprettet under. Denne egenskab gælder kun for et skemaaktiveret Lakehouse. Maks. længde på 128 tegn alfanumerisk streng med understregningstegn.
tableName

string

Navnet på den tabel, der skal køres vedligeholdelse på. Maks. længde på 256 tegn alfanumerisk streng med understregningstegn.
vacuumSettings

VacuumSettings

Konfigurerer indstillingerne for vakuum for vedligeholdelsesjobbet. Hvis du vil springe tabelvakuum over, skal du lade denne parameter være tom.

VacuumSettings

Object

Indstillinger for tabelvedligeholdelse vakuum.

Name Type Beskrivelse
retentionPeriod

string

Tilsidesætter standardopbevaringsperioden. Filer eller datafiler, der ikke refereres til, og som er knyttet til deltatabelversioner, der er ældre end den angivne opbevaringsperiode, fjernes. Denne værdi skal følge mønsteret for d:hh:mm:ss hvor d er antallet af dage, hh er antallet af timer mellem 00 og 23, mm er antallet af minutter mellem 00 og 59, og ss er antallet af sekunder mellem 00 og 59.