Partager via

Background Jobs - Run On Demand Table Maintenance

  • Référence
Service:
Lakehouse
Version d'API:
v1

Note

Cette API est en préversion.

Exécutez l’instance de travail de maintenance de table à la demande.

Étendues déléguées requises

Lakehouse.Execute.All ou Item.Execute.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
principal de service et identités managées Non

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
lakehouseId
 path True

string

uuid

ID de l’élément Lakehouse.
workspaceId
 path True

string

uuid

ID de l’espace de travail.
jobType
 query True

string

Type de travail TableMaintenance.

Corps de la demande

Nom Obligatoire Type Description
executionData True

TableMaintenanceExecutionData

Données d’exécution pour configurer le travail de maintenance de table .

Réponses

Nom Type Description
202 Accepted

Demande acceptée, l’exécution du travail est en cours.

En-têtes

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

ErrorResponse

Codes d’erreur courants :

  • MissingMinimalPermissions : l’appelant ne dispose pas des autorisations suffisantes pour exécuter l’instance de travail.

  • InvalidJobType : le type de travail demandé n’est pas valide.

  • TooManyRequestsForJobs : l’appelant est spammant par beaucoup de demandes de travail à la demande.

  • ItemNotFound - ID d’élément demandé introuvable.

Exemples

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.

Exemple de requête

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

Exemple de réponse

Code d’état:
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.

Exemple de requête

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

Exemple de réponse

Code d’état:
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.

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Définitions

Nom Description
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
OptimizeSettings

Paramètres d’optimisation de la maintenance de table.
RunOnDemandTableMaintenanceRequest

Exécuter à la demande la charge utile de l’instance de maintenance de table lakehouse
TableMaintenanceExecutionData

Exécuter à la demande la charge utile de l’instance de maintenance de table lakehouse
VacuumSettings

La maintenance de table paramètres de vide.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

OptimizeSettings

Object

Paramètres d’optimisation de la maintenance de table.

Nom Type Description
vOrder

boolean

Paramètres de de commande V. True - Activé, False - Désactivé.
zOrderBy

string[]

Liste des noms de colonnes dans L’ordre des données. S’il n’est pas fourni, L’ordre Z n’est pas appliqué.

RunOnDemandTableMaintenanceRequest

Object

Exécuter à la demande la charge utile de l’instance de maintenance de table lakehouse

Nom Type Description
executionData

TableMaintenanceExecutionData

Données d’exécution pour configurer le travail de maintenance de table .

TableMaintenanceExecutionData

Object

Exécuter à la demande la charge utile de l’instance de maintenance de table lakehouse

Nom Type Description
optimizeSettings

OptimizeSettings

Configure les paramètres d’optimisation du travail de maintenance. Pour ignorer l’optimisation des tables, laissez ce paramètre vide.
schemaName

string

Nom du schéma sous lequel la table est créée. Cette propriété s’applique uniquement à un schéma activé Lakehouse. Longueur maximale de 128 caractères de chaîne alphanumérique avec traits de soulignement.
tableName

string

Nom de la table sur laquelle exécuter la maintenance. Longueur maximale de 256 caractères de chaîne alphanumérique avec traits de soulignement.
vacuumSettings

VacuumSettings

Configure les paramètres de de la tâche de maintenance. Pour ignorer le vide de table, laissez ce paramètre vide.

VacuumSettings

Object

La maintenance de table paramètres de vide.

Nom Type Description
retentionPeriod

string

Remplace la période de rétention par défaut. Les fichiers ou fichiers de données non référencés associés aux versions de table delta antérieures à la période de rétention spécifiée sont supprimés. Cette valeur doit suivre le modèle de d:hh:mm:ss où d correspond au nombre de jours, hh est le nombre d’heures comprises entre 00 et 23, mm correspond au nombre de minutes comprises entre 00 et 59, et ss correspond au nombre de secondes comprises entre 00 et 59.