Jaa


Background Jobs - Run On Demand Table Maintenance

Muistiinpano

Tämä ohjelmointirajapinta on esikatselutilassa.

Suorita tarvittaessa taulukoiden ylläpito työn esiintymän avulla.

Vaaditut delegoidut vaikutusalueet

Lakehouse.Execute.All tai Item.Execute.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti Tuki
Käyttäjä Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kyllä

Rajapinta

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Description
lakehouseId
path True

string (uuid)

Lakehouse-kohteen tunnus.

workspaceId
path True

string (uuid)

Työtilan tunnus.

jobType
query True

string

Taulukon haku työtyyppi.

Pyynnön leipäteksti

Nimi Pakollinen Tyyppi Description
executionData True

TableMaintenanceExecutionData

Suoritustiedot taulukon ylläpidon työn määrittämiseksi.

Vastaukset

Nimi Tyyppi Description
202 Accepted

Pyyntö hyväksytään, työn suorittaminen on meneillään.

Otsikot

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

ErrorResponse

Yleiset virhekoodit:

  • MissingMinimalPermissions : Kutsujalla ei ole riittäviä oikeuksia työn esiintymän suorittamiseen.

  • InvalidJobType – Pyydetty työtyyppi on virheellinen.

  • TooManyRequestsForJobs – Soittaja särkii paljon pyydettyjä työpyyntöjä.

  • ItemNotFound – Pyydetty kohdetunnusta ei löytynyt.

Esimerkit

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.

Mallipyyntö

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

Mallivastaus

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.

Mallipyyntö

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

Mallivastaus

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.

Mallipyyntö

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

Mallivastaus

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

Määritelmät

Nimi Description
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.

ErrorResponse

Virhevastaus.

ErrorResponseDetails

Virheen vastauksen tiedot.

OptimizeSettings

Taulukon ylläpidon optimointiasetukset.

RunOnDemandTableMaintenanceRequest

Suorita pyydettäessä lakehouse-taulukoiden ylläpitoesiintymän tiedot

TableMaintenanceExecutionData

Suorita pyydettäessä lakehouse-taulukoiden ylläpitoesiintymän tiedot

VacuumSettings

Taulukon ylläpito tyhjiön asetukset.

ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.

resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Virhevastaus.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.

message

string

Ihmisen luettavissa oleva esitys virheestä.

moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.

relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

requestId

string

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Virheen vastauksen tiedot.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.

message

string

Ihmisen luettavissa oleva esitys virheestä.

relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

OptimizeSettings

Taulukon ylläpidon optimointiasetukset.

Nimi Tyyppi Description
vOrder

boolean

V-Order -asetukset. True – Käytössä, False – Ei käytössä.

zOrderBy

string[]

Luettelo sarakkeiden nimistä Z-järjestykseen tietojen mukaan. Jos sitä ei ole annettu, Z-tilausta ei käytetä.

RunOnDemandTableMaintenanceRequest

Suorita pyydettäessä lakehouse-taulukoiden ylläpitoesiintymän tiedot

Nimi Tyyppi Description
executionData

TableMaintenanceExecutionData

Suoritustiedot taulukon ylläpidon työn määrittämiseksi.

TableMaintenanceExecutionData

Suorita pyydettäessä lakehouse-taulukoiden ylläpitoesiintymän tiedot

Nimi Tyyppi Description
optimizeSettings

OptimizeSettings

Määrittää ylläpitotyön optimointiasetukset. Jos haluat ohittaa taulukon optimoinnin, jätä tämä parametri tyhjäksi.

schemaName

string

pattern: ^(?=[0-9]*[a-zA-Z_])[a-zA-Z0-9_]{1,128}$

Sen rakenteen nimi, jossa taulukko luodaan. Tämä ominaisuus on käytettävissä vain rakenteen ollessa käytössä Lakehouse. Aakkosnumeerinen 128 merkin enimmäispituus ja alaviivat.

tableName

string

pattern: ^(?=[0-9]*[a-zA-Z_])[a-zA-Z0-9_]{1,256}$

Ylläpidossa suoritettavan taulukon nimi. Aakkosnumeerinen 256 merkin enimmäispituus ja alaviivat.

vacuumSettings

VacuumSettings

Määrittää ylläpitotöiden tyhjiön asetukset. Jos haluat ohittaa taulukon tyhjiön, jätä tämä parametri tyhjäksi.

VacuumSettings

Taulukon ylläpito tyhjiön asetukset.

Nimi Tyyppi Description
retentionPeriod

string

pattern: ^(\d+:)?\d{1,2}:\d{1,2}:\d{1,2}$

Ohittaa oletuspidätysajan. Määritetyn säilytysajan pituisiin delta-taulukkoversioihin liittyvät tiedostot tai datatiedostot poistetaan. Tämän arvon on noudatettava mallia, jossa d:hh:mm:ss, jossa d on päivien määrä, hh on tuntien määrä välillä 00–23, mm on minuuttien määrä välillä 00–59 ja ss on sekuntien määrä välillä 00 ja 59.