MCP Tools Reference: cloud-sql

Outil : import_data

Importer des données dans une instance Cloud SQL

Si le fichier ne commence pas par gs://, il est considéré comme stocké en local. Si le fichier est local, il doit être importé dans Cloud Storage avant que vous puissiez effectuer l'appel import_data. Pour importer le fichier dans Cloud Storage, vous pouvez utiliser les commandes gcloud ou gsutil.

Avant d'importer le fichier dans Cloud Storage, déterminez si vous souhaitez utiliser un bucket existant ou en créer un dans le projet fourni.

Une fois le fichier importé dans Cloud Storage, le compte de service de l'instance doit disposer des autorisations suffisantes pour lire le fichier importé à partir du bucket Cloud Storage.

Pour ce faire :

  1. Utilisez l'outil get_instance pour obtenir l'adresse e-mail du compte de service de l'instance. À partir du résultat de l'outil, obtenez la valeur du champ serviceAccountEmailAddress.
  2. Attribuez le rôle storage.objectAdmin au compte de service de l'instance sur le bucket Cloud Storage fourni. Utilisez une commande telle que gcloud storage buckets add-iam-policy-binding ou une requête à l'API Cloud Storage. Il peut s'écouler entre deux et sept minutes, voire plus, avant que le rôle ne soit accordé et que les autorisations ne soient propagées au compte de service dans Cloud Storage. Si vous rencontrez une erreur d'autorisation après avoir mis à jour la stratégie IAM, attendez quelques minutes, puis réessayez.

Une fois les autorisations accordées, vous pouvez importer les données. Nous vous recommandons de laisser les paramètres facultatifs vides et d'utiliser les valeurs par défaut du système. Le type de fichier peut généralement être déterminé par l'extension du fichier. Par exemple, si le fichier est un fichier SQL, .sql ou .csv pour un fichier CSV.

Voici un exemple de importContext SQL pour MySQL.

{
          "uri": "gs://sample-gcs-bucket/sample-file.sql",
          "kind": "sql#importContext",
          "fileType": "SQL"
        }

Aucun paramètre database n'est présent pour MySQL, car le nom de la base de données doit figurer dans le fichier SQL. Ne spécifiez qu'un seul URI. Aucun autre champ n'est obligatoire en dehors de importContext.

Pour PostgreSQL, le champ database est obligatoire. Voici un exemple de importContext PostgreSQL avec le champ database spécifié.

{
          "uri": "gs://sample-gcs-bucket/sample-file.sql",
          "kind": "sql#importContext",
          "fileType": "SQL",
          "database": "sample-db"
        }

L'outil import_data renvoie une opération de longue durée. Utilisez l'outil get_operation pour interroger son état jusqu'à ce que l'opération soit terminée.

L'exemple suivant montre comment utiliser curl pour appeler l'outil MCP import_data.

Requête curl 
                  
curl --location 'https://sqladmin.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "import_data",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Schéma d'entrée

Requête d'importation d'instance.

SqlInstancesImportRequest

Représentation JSON 
{
  "instance": string,
  "project": string,
  "body": {
    object (InstancesImportRequest)
  }
}
Champs
instance

string

ID de l'instance Cloud SQL Ce paramètre n'inclut pas l'ID du projet.
project

string

ID du projet contenant l'instance.
body

object (InstancesImportRequest)

InstancesImportRequest

Représentation JSON 
{
  "importContext": {
    object (ImportContext)
  }
}
Champs
importContext

object (ImportContext)

Contient des informations détaillées sur l'opération d'importation.

ImportContext

Représentation JSON 
{
  "uri": string,
  "database": string,
  "kind": string,
  "fileType": enum (SqlFileType),
  "csvImportOptions": {
    object (SqlCsvImportOptions)
  },
  "importUser": string,
  "bakImportOptions": {
    object (SqlBakImportOptions)
  },
  "sqlImportOptions": {
    object (SqlImportOptions)
  },
  "tdeImportOptions": {
    object (SqlTdeImportOptions)
  }
}
Champs
uri

string

Chemin d'accès au fichier d'importation dans Cloud Storage, au format gs://bucketName/fileName. Les fichiers gzip compressés (.gz) sont acceptés lorsque fileType est défini sur SQL. L'instance doit disposer d'autorisations d'écriture sur le bucket et d'un accès en lecture au fichier.
database

string

Base de données cible pour l'importation. Si fileType est défini sur SQL, ce champ n'est obligatoire que si le fichier d'importation ne spécifie pas de base de données. Il est remplacé par toute spécification de base de données dans le fichier d'importation. Pour les opérations d'importation parallèle d'une instance entière, la base de données est remplacée par le nom de la base de données stocké dans le nom du sous-répertoire. Si fileType est défini sur CSV, une base de données doit être spécifiée.
kind

string

Cette valeur est toujours définie sur sql#importContext.
fileType

enum (SqlFileType)

Type de fichier pour l'URI spécifié.`SQL: The file contains SQL statements. \CSV`: le fichier contient des données CSV.
csvImportOptions

object (SqlCsvImportOptions)

Options d'importation de données au format CSV.
importUser

string

Utilisateur de PostgreSQL associé à cette opération d'importation. Instances PostgreSQL uniquement.
bakImportOptions

object (SqlBakImportOptions)

Paramètres d'importation spécifiques aux fichiers SQL Server .BAK
sqlImportOptions

object (SqlImportOptions)

Facultatif. Options d'importation de données à partir d'instructions SQL.
tdeImportOptions

object (SqlTdeImportOptions)

Facultatif. Paramètres d'importation spécifiques aux certificats TDE SQL Server

SqlCsvImportOptions

Représentation JSON 
{
  "table": string,
  "columns": [
    string
  ],
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
Champs
table

string

Table dans laquelle les données CSV sont importées.
columns[]

string

Colonnes dans lesquelles les données CSV sont importées. Si aucune colonne n'est spécifiée, toutes les colonnes de la table de base de données sont chargées avec les données CSV.
escapeCharacter

string

Spécifie le caractère devant précéder un caractère de données devant être échappé.
quoteCharacter

string

Spécifie le caractère de guillemet à utiliser lorsqu'une valeur de données est entre guillemets.
fieldsTerminatedBy

string

Spécifie le caractère qui sépare les colonnes dans chaque ligne du fichier.
linesTerminatedBy

string

Il permet de séparer les lignes. Si une ligne ne contient pas tous les champs, les colonnes restantes sont définies sur leurs valeurs par défaut.

SqlBakImportOptions

Représentation JSON 
{
  "encryptionOptions": {
    object (EncryptionOptions)
  },
  "striped": boolean,
  "noRecovery": boolean,
  "recoveryOnly": boolean,
  "bakType": enum (BakType),
  "stopAt": string,
  "stopAtMark": string
}
Champs
encryptionOptions

object (EncryptionOptions)
striped

boolean

Indique si le groupe de sauvegarde en cours de restauration est agrégé ou non. Ne s'applique qu'à Cloud SQL pour SQL Server.
noRecovery

boolean

Indique si l'importation de la sauvegarde restaurera la base de données avec l'option NORECOVERY. Ne s'applique qu'à Cloud SQL pour SQL Server.
recoveryOnly

boolean

Indique si la demande d'importation de la sauvegarde ne fera que mettre la base de données en ligne sans télécharger le contenu BAK. Seule l'une des valeurs "no_recovery" et "recovery_only" peut être définie sur "true". Dans le cas contraire, une erreur sera renvoyée. Ne s'applique qu'à Cloud SQL pour SQL Server.
bakType

enum (BakType)

Type de contenu BAK : FULL ou DIFF
stopAt

string (Timestamp format)

Facultatif. Code temporel auquel l'importation doit s'arrêter. Cet horodatage est au format RFC 3339 (par exemple, 2023-10-01T16:19:00.094). Ce champ est équivalent au mot clé STOPAT et ne s'applique qu'à Cloud SQL pour SQL Server.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
stopAtMark

string

Facultatif. Transaction marquée à laquelle l'importation doit s'arrêter. Ce champ est équivalent au mot clé STOPATMARK et ne s'applique qu'à Cloud SQL pour SQL Server.

EncryptionOptions

Représentation JSON 
{
  "certPath": string,
  "pvkPath": string,
  "pvkPassword": string,
  "keepEncrypted": boolean
}
Champs
certPath

string

Chemin d'accès au certificat (.cer) dans Cloud Storage, au format gs://bucketName/fileName. L'instance doit disposer d'autorisations d'écriture sur le bucket et d'un accès en lecture au fichier.
pvkPath

string

Chemin d'accès à la clé privée du certificat (.pvk) dans Cloud Storage, au format gs://bucketName/fileName. L'instance doit disposer d'autorisations d'écriture sur le bucket et d'un accès en lecture au fichier.
pvkPassword

string

Mot de passe qui chiffre la clé privée
keepEncrypted

boolean

Facultatif. Indique si le fichier importé reste chiffré.

BoolValue

Représentation JSON 
{
  "value": boolean
}
Champs
value

boolean

Valeur booléenne.

Horodatage

Représentation JSON 
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos

integer

Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

SqlImportOptions

Représentation JSON 
{
  "threads": integer,
  "parallel": boolean,
  "postgresImportOptions": {
    object (PostgresImportOptions)
  }
}
Champs
threads

integer

Facultatif. Nombre de threads à utiliser pour l'importation parallèle.
parallel

boolean

Facultatif. Indique si l'importation doit être parallèle ou non.
postgresImportOptions

object (PostgresImportOptions)

Facultatif. Options d'importation à partir d'une instance Cloud SQL pour PostgreSQL.

Int32Value

Représentation JSON 
{
  "value": integer
}
Champs
value

integer

Valeur int32.

PostgresImportOptions

Représentation JSON 
{
  "clean": boolean,
  "ifExists": boolean
}
Champs
clean

boolean

Facultatif. Option "--clean" pour l'utilitaire pg_restore. Cette option ne s'applique que si vous avez activé l'importation de fichiers en parallèle dans Cloud SQL.
ifExists

boolean

Facultatif. Indicateur "--if-exists" pour l'utilitaire pg_restore. Cette option ne s'applique que si vous avez activé l'importation de fichiers en parallèle dans Cloud SQL.

SqlTdeImportOptions

Représentation JSON 
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
Champs
certificatePath

string

Obligatoire. Chemin d'accès à la clé publique du certificat TDE au format gs://bucketName/fileName. L'instance doit disposer d'un accès en lecture au fichier. Ne s'applique qu'aux instances SQL Server.
privateKeyPath

string

Obligatoire. Chemin d'accès à la clé privée du certificat TDE au format gs://bucketName/fileName. L'instance doit disposer d'un accès en lecture au fichier. Ne s'applique qu'aux instances SQL Server.
privateKeyPassword

string

Obligatoire. Mot de passe qui chiffre la clé privée.
name

string

Obligatoire. Nom du certificat. Ne s'applique qu'aux instances SQL Server.

Schéma de sortie

Ressource Operation. Pour les opérations réussies qui renvoient une ressource Operation, seuls les champs pertinents pour l'opération sont renseignés dans la ressource.

Opération

Représentation JSON 
{
  "kind": string,
  "targetLink": string,
  "status": enum (SqlOperationStatus),
  "user": string,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    object (OperationErrors)
  },
  "apiWarning": {
    object (ApiWarning)
  },
  "operationType": enum (SqlOperationType),
  "importContext": {
    object (ImportContext)
  },
  "exportContext": {
    object (ExportContext)
  },
  "backupContext": {
    object (BackupContext)
  },
  "preCheckMajorVersionUpgradeContext": {
    object (PreCheckMajorVersionUpgradeContext)
  },
  "name": string,
  "targetId": string,
  "selfLink": string,
  "targetProject": string,
  "acquireSsrsLeaseContext": {
    object (AcquireSsrsLeaseContext)
  },
  "subOperationType": {
    object (SqlSubOperationType)
  }
}
Champs
kind

string

Cette valeur est toujours définie sur sql#operation.
targetLink

string
status

enum (SqlOperationStatus)

État d'une opération.
user

string

Adresse e-mail de l'utilisateur qui a lancé cette opération.
insertTime

string (Timestamp format)

Heure à laquelle cette opération a été mise en file d'attente sur le fuseau horaire UTC au format RFC 3339, par exemple 2012-11-15T16:19:00.094Z.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Heure à laquelle cette opération a réellement commencé sur le fuseau horaire UTC au format RFC 3339, par exemple 2012-11-15T16:19:00.094Z.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure à laquelle cette opération a été terminée sur le fuseau horaire UTC au format RFC 3339, par exemple 2012-11-15T16:19:00.094Z.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
error

object (OperationErrors)

Si des erreurs se sont produites lors du traitement de cette opération, ce champ est renseigné.
apiWarning

object (ApiWarning)

Message d'avertissement de l'API Admin.
operationType

enum (SqlOperationType)

Type d'opération. Les valeurs valides sont : * CREATE * DELETE * UPDATE * RESTART * IMPORT * EXPORT * BACKUP_VOLUME * RESTORE_VOLUME * CREATE_USER * DELETE_USER * CREATE_DATABASE * DELETE_DATABASE
importContext

object (ImportContext)

Contexte de l'opération d'importation, le cas échéant.
exportContext

object (ExportContext)

Contexte de l'opération d'exportation, le cas échéant.
backupContext

object (BackupContext)

Contexte de l'opération de sauvegarde, le cas échéant.
preCheckMajorVersionUpgradeContext

object (PreCheckMajorVersionUpgradeContext)

Ce champ n'est renseigné que lorsque operation_type est défini sur PRE_CHECK_MAJOR_VERSION_UPGRADE. Le message PreCheckMajorVersionUpgradeContext contient les détails de cette vérification préalable, tels que la version cible de la base de données pour la mise à niveau et les résultats de la vérification (y compris les avertissements ou les erreurs détectés).
name

string

Identifiant qui identifie l'opération de manière unique. Vous pouvez utiliser cet identifiant pour récupérer la ressource Operations contenant les informations sur l'opération.
targetId

string

Nom de la ressource sur laquelle cette opération s'exécute.
selfLink

string

URI de cette ressource.
targetProject

string

ID du projet de l'instance cible associée à cette opération.
acquireSsrsLeaseContext

object (AcquireSsrsLeaseContext)

Contexte de l'opération d'acquisition de bail SSRS, le cas échéant.
subOperationType

object (SqlSubOperationType)

Facultatif. Sous-opération basée sur le type d'opération.

Horodatage

Représentation JSON 
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Représente les secondes de l'heure UTC à partir de l'epoch Unix 1970-01-01T00:00:00Z. La valeur doit être comprise entre -62135596800 et 253402300799 inclus (ce qui correspond à 0001-01-01T00:00:00Z et 9999-12-31T23:59:59Z).
nanos

integer

Fractions de secondes non négatives avec une précision de l'ordre de la nanoseconde. Ce champ correspond à la partie en nanosecondes de la durée, et non à une alternative aux secondes. Les valeurs de secondes négatives avec des fractions doivent toujours comporter des valeurs de nanosecondes non négatives comptabilisées dans le temps. La valeur doit être comprise entre 0 et 999 999 999 inclus.

OperationErrors

Représentation JSON 
{
  "kind": string,
  "errors": [
    {
      object (OperationError)
    }
  ]
}
Champs
kind

string

Cette valeur est toujours définie sur sql#operationErrors.
errors[]

object (OperationError)

Liste des erreurs rencontrées lors du traitement de cette opération.

OperationError

Représentation JSON 
{
  "kind": string,
  "code": string,
  "message": string
}
Champs
kind

string

Cette valeur est toujours définie sur sql#operationError.
code

string

Identifie l'erreur spécifique qui s'est produite.
message

string

Informations supplémentaires sur l'erreur rencontrée.

ApiWarning

Représentation JSON 
{
  "code": enum (SqlApiWarningCode),
  "message": string,
  "region": string
}
Champs
code

enum (SqlApiWarningCode)

Code permettant d'identifier de manière unique le type d'avertissement.
message

string

Message d'avertissement
region

string

Nom de la région pour l'avertissement REGION_UNREACHABLE.

ImportContext

Représentation JSON 
{
  "uri": string,
  "database": string,
  "kind": string,
  "fileType": enum (SqlFileType),
  "csvImportOptions": {
    object (SqlCsvImportOptions)
  },
  "importUser": string,
  "bakImportOptions": {
    object (SqlBakImportOptions)
  },
  "sqlImportOptions": {
    object (SqlImportOptions)
  },
  "tdeImportOptions": {
    object (SqlTdeImportOptions)
  }
}
Champs
uri

string

Chemin d'accès au fichier d'importation dans Cloud Storage, au format gs://bucketName/fileName. Les fichiers gzip compressés (.gz) sont acceptés lorsque fileType est défini sur SQL. L'instance doit disposer d'autorisations d'écriture sur le bucket et d'un accès en lecture au fichier.
database

string

Base de données cible pour l'importation. Si fileType est défini sur SQL, ce champ n'est obligatoire que si le fichier d'importation ne spécifie pas de base de données. Il est remplacé par toute spécification de base de données dans le fichier d'importation. Pour les opérations d'importation parallèle d'une instance entière, la base de données est remplacée par le nom de la base de données stocké dans le nom du sous-répertoire. Si fileType est défini sur CSV, une base de données doit être spécifiée.
kind

string

Cette valeur est toujours définie sur sql#importContext.
fileType

enum (SqlFileType)

Type de fichier pour l'URI spécifié.`SQL: The file contains SQL statements. \CSV`: le fichier contient des données CSV.
csvImportOptions

object (SqlCsvImportOptions)

Options d'importation de données au format CSV.
importUser

string

Utilisateur de PostgreSQL associé à cette opération d'importation. Instances PostgreSQL uniquement.
bakImportOptions

object (SqlBakImportOptions)

Paramètres d'importation spécifiques aux fichiers SQL Server .BAK
sqlImportOptions

object (SqlImportOptions)

Facultatif. Options d'importation de données à partir d'instructions SQL.
tdeImportOptions

object (SqlTdeImportOptions)

Facultatif. Paramètres d'importation spécifiques aux certificats TDE SQL Server

SqlCsvImportOptions

Représentation JSON 
{
  "table": string,
  "columns": [
    string
  ],
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
Champs
table

string

Table dans laquelle les données CSV sont importées.
columns[]

string

Colonnes dans lesquelles les données CSV sont importées. Si aucune colonne n'est spécifiée, toutes les colonnes de la table de base de données sont chargées avec les données CSV.
escapeCharacter

string

Spécifie le caractère devant précéder un caractère de données devant être échappé.
quoteCharacter

string

Spécifie le caractère de guillemet à utiliser lorsqu'une valeur de données est entre guillemets.
fieldsTerminatedBy

string

Spécifie le caractère qui sépare les colonnes dans chaque ligne du fichier.
linesTerminatedBy

string

Il permet de séparer les lignes. Si une ligne ne contient pas tous les champs, les colonnes restantes sont définies sur leurs valeurs par défaut.

SqlBakImportOptions

Représentation JSON 
{
  "encryptionOptions": {
    object (EncryptionOptions)
  },
  "striped": boolean,
  "noRecovery": boolean,
  "recoveryOnly": boolean,
  "bakType": enum (BakType),
  "stopAt": string,
  "stopAtMark": string
}
Champs
encryptionOptions

object (EncryptionOptions)
striped

boolean

Indique si le groupe de sauvegarde en cours de restauration est agrégé ou non. Ne s'applique qu'à Cloud SQL pour SQL Server.
noRecovery

boolean

Indique si l'importation de la sauvegarde restaurera la base de données avec l'option NORECOVERY. Ne s'applique qu'à Cloud SQL pour SQL Server.
recoveryOnly

boolean

Indique si la demande d'importation de la sauvegarde ne fera que mettre la base de données en ligne sans télécharger le contenu BAK. Seule l'une des valeurs "no_recovery" et "recovery_only" peut être définie sur "true". Dans le cas contraire, une erreur sera renvoyée. Ne s'applique qu'à Cloud SQL pour SQL Server.
bakType

enum (BakType)

Type de contenu BAK : FULL ou DIFF
stopAt

string (Timestamp format)

Facultatif. Code temporel auquel l'importation doit s'arrêter. Cet horodatage est au format RFC 3339 (par exemple, 2023-10-01T16:19:00.094). Ce champ est équivalent au mot clé STOPAT et ne s'applique qu'à Cloud SQL pour SQL Server.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
stopAtMark

string

Facultatif. Transaction marquée à laquelle l'importation doit s'arrêter. Ce champ est équivalent au mot clé STOPATMARK et ne s'applique qu'à Cloud SQL pour SQL Server.

EncryptionOptions

Représentation JSON 
{
  "certPath": string,
  "pvkPath": string,
  "pvkPassword": string,
  "keepEncrypted": boolean
}
Champs
certPath

string

Chemin d'accès au certificat (.cer) dans Cloud Storage, au format gs://bucketName/fileName. L'instance doit disposer d'autorisations d'écriture sur le bucket et d'un accès en lecture au fichier.
pvkPath

string

Chemin d'accès à la clé privée du certificat (.pvk) dans Cloud Storage, au format gs://bucketName/fileName. L'instance doit disposer d'autorisations d'écriture sur le bucket et d'un accès en lecture au fichier.
pvkPassword

string

Mot de passe qui chiffre la clé privée
keepEncrypted

boolean

Facultatif. Indique si le fichier importé reste chiffré.

BoolValue

Représentation JSON 
{
  "value": boolean
}
Champs
value

boolean

Valeur booléenne.

SqlImportOptions

Représentation JSON 
{
  "threads": integer,
  "parallel": boolean,
  "postgresImportOptions": {
    object (PostgresImportOptions)
  }
}
Champs
threads

integer

Facultatif. Nombre de threads à utiliser pour l'importation parallèle.
parallel

boolean

Facultatif. Indique si l'importation doit être parallèle ou non.
postgresImportOptions

object (PostgresImportOptions)

Facultatif. Options d'importation à partir d'une instance Cloud SQL pour PostgreSQL.

Int32Value

Représentation JSON 
{
  "value": integer
}
Champs
value

integer

Valeur int32.

PostgresImportOptions

Représentation JSON 
{
  "clean": boolean,
  "ifExists": boolean
}
Champs
clean

boolean

Facultatif. Option "--clean" pour l'utilitaire pg_restore. Cette option ne s'applique que si vous avez activé l'importation de fichiers en parallèle dans Cloud SQL.
ifExists

boolean

Facultatif. Indicateur "--if-exists" pour l'utilitaire pg_restore. Cette option ne s'applique que si vous avez activé l'importation de fichiers en parallèle dans Cloud SQL.

SqlTdeImportOptions

Représentation JSON 
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
Champs
certificatePath

string

Obligatoire. Chemin d'accès à la clé publique du certificat TDE au format gs://bucketName/fileName. L'instance doit disposer d'un accès en lecture au fichier. Ne s'applique qu'aux instances SQL Server.
privateKeyPath

string

Obligatoire. Chemin d'accès à la clé privée du certificat TDE au format gs://bucketName/fileName. L'instance doit disposer d'un accès en lecture au fichier. Ne s'applique qu'aux instances SQL Server.
privateKeyPassword

string

Obligatoire. Mot de passe qui chiffre la clé privée.
name

string

Obligatoire. Nom du certificat. Ne s'applique qu'aux instances SQL Server.

ExportContext

Représentation JSON 
{
  "uri": string,
  "databases": [
    string
  ],
  "kind": string,
  "sqlExportOptions": {
    object (SqlExportOptions)
  },
  "csvExportOptions": {
    object (SqlCsvExportOptions)
  },
  "fileType": enum (SqlFileType),
  "offload": boolean,
  "bakExportOptions": {
    object (SqlBakExportOptions)
  },
  "tdeExportOptions": {
    object (SqlTdeExportOptions)
  }
}
Champs
uri

string

Chemin d'accès au fichier dans Google Cloud Storage où l'exportation sera stockée. L'URI est au format gs://bucketName/fileName. Si le fichier existe déjà, la requête aboutit, mais l'opération échoue. Si fileType est défini sur SQL et que le nom de fichier se termine par .gz, le contenu est compressé.
databases[]

string

Bases de données à exporter.
MySQL instances: Si fileType est défini sur SQL et qu'aucune base de données n'est spécifiée, toutes les bases de données sont exportées, à l'exception de la base de données système mysql. Si fileType est défini sur CSV, vous pouvez spécifier une base de données, soit en utilisant cette propriété, soit en utilisant la propriété csvExportOptions.selectQuery, qui est prioritaire sur celle-ci.
PostgreSQL instances: Si vous ne spécifiez pas de base de données par son nom, toutes les bases de données utilisateur de l'instance sont exportées. Cela exclut les bases de données système et les bases de données Cloud SQL utilisées pour gérer les opérations internes. L'exportation de toutes les bases de données utilisateur n'est disponible que pour l'exportation parallèle au format répertoire. Si fileType est défini sur CSV, cette base de données doit correspondre à celle spécifiée dans la propriété csvExportOptions.selectQuery.
SQL Server instances: Vous devez spécifier une base de données à exporter, et la valeur fileType doit être BAK.
kind

string

Cette valeur est toujours définie sur sql#exportContext.
sqlExportOptions

object (SqlExportOptions)

Options d'exportation de données sous forme d'instructions SQL.
csvExportOptions

object (SqlCsvExportOptions)

Options d'exportation de données au format CSV. Instances MySQL et PostgreSQL uniquement.
fileType

enum (SqlFileType)

Type de fichier pour l'URI spécifié.
offload

boolean

Indique si une exportation sans serveur doit être effectuée.
bakExportOptions

object (SqlBakExportOptions)

Options d'exportation de données au format BAK.
tdeExportOptions

object (SqlTdeExportOptions)

Facultatif. Paramètres d'exportation spécifiques aux certificats TDE SQL Server

SqlExportOptions

Représentation JSON 
{
  "tables": [
    string
  ],
  "schemaOnly": boolean,
  "mysqlExportOptions": {
    object (MysqlExportOptions)
  },
  "threads": integer,
  "parallel": boolean,
  "postgresExportOptions": {
    object (PostgresExportOptions)
  }
}
Champs
tables[]

string

Tables à exporter ou qui ont été exportées à partir de la base de données spécifiée. Si vous spécifiez des tables, ne spécifiez qu'une seule base de données. Pour les instances PostgreSQL, vous ne pouvez spécifier qu'une seule table.
schemaOnly

boolean

Exporter uniquement les schémas.
mysqlExportOptions

object (MysqlExportOptions)
threads

integer

Facultatif. Nombre de threads à utiliser pour l'exportation parallèle.
parallel

boolean

Facultatif. Indique si l'exportation doit être parallèle ou non.
postgresExportOptions

object (PostgresExportOptions)

Facultatif. Options d'exportation à partir d'une instance Cloud SQL pour PostgreSQL.

MysqlExportOptions

Représentation JSON 
{
  "masterData": integer
}
Champs
masterData

integer

Option permettant d'inclure l'instruction SQL requise pour configurer la réplication. Si la valeur est définie sur 1, le fichier de dump inclut une instruction CHANGE MASTER TO avec les coordonnées du journal binaire, et --set-gtid-purged est défini sur ON. Si la valeur est définie sur 2, l'instruction CHANGE MASTER TO est écrite sous la forme d'un commentaire SQL et n'a aucun effet. Si elle est définie sur une valeur autre que 1, --set-gtid-purged est défini sur OFF.

PostgresExportOptions

Représentation JSON 
{
  "clean": boolean,
  "ifExists": boolean
}
Champs
clean

boolean

Facultatif. Utilisez cette option pour inclure DROP.

<object>

Instructions SQL. Utilisez ces instructions pour supprimer des objets de base de données avant d'exécuter l'opération d'importation.
ifExists

boolean

Facultatif. Option permettant d'inclure une instruction SQL IF EXISTS avec chaque instruction DROP produite par clean.

SqlCsvExportOptions

Représentation JSON 
{
  "selectQuery": string,
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
Champs
selectQuery

string

Requête SELECT utilisée pour extraire les données.
escapeCharacter

string

Spécifie le caractère devant précéder un caractère de données devant être échappé.
quoteCharacter

string

Spécifie le caractère de guillemet à utiliser lorsqu'une valeur de données est entre guillemets.
fieldsTerminatedBy

string

Spécifie le caractère qui sépare les colonnes dans chaque ligne du fichier.
linesTerminatedBy

string

Il permet de séparer les lignes. Si une ligne ne contient pas tous les champs, les colonnes restantes sont définies sur leurs valeurs par défaut.

SqlBakExportOptions

Représentation JSON 
{
  "striped": boolean,
  "stripeCount": integer,
  "bakType": enum (BakType),
  "copyOnly": boolean,
  "differentialBase": boolean,
  "exportLogStartTime": string,
  "exportLogEndTime": string
}
Champs
striped

boolean

Indique si l'exportation doit être rayée ou non.
stripeCount

integer

Option permettant de spécifier le nombre de bandes à utiliser pour l'exportation. Si ce champ est vide et que la valeur du champ "Rayé" est "true", le nombre de rayures est choisi automatiquement.
bakType

enum (BakType)

Type de ce fichier BAK (exportation, FULL ou DIFF), SQL Server uniquement
copyOnly
(deprecated)

boolean

Obsolète : copy_only est obsolète. Utilisez plutôt differential_base
differentialBase

boolean

Indique si la sauvegarde peut être utilisée comme base différentielle. Les sauvegardes copy_only ne peuvent pas être utilisées comme base différentielle.
exportLogStartTime

string (Timestamp format)

Facultatif. Code temporel de début de l'inclusion du journal des transactions dans l'opération d'exportation. Format RFC 3339 (par exemple, 2023-10-01T16:19:00.094) en UTC. Si cette valeur est omise, tous les journaux disponibles depuis le début de la période de conservation seront inclus. Cela ne s'applique qu'à Cloud SQL pour SQL Server.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
exportLogEndTime

string (Timestamp format)

Facultatif. Code temporel de fin pour lequel le journal des transactions sera inclus dans l'opération d'exportation. Format RFC 3339 (par exemple, 2023-10-01T16:19:00.094) en UTC. Si elle est omise, tous les journaux disponibles jusqu'à l'heure actuelle seront inclus. Cela ne s'applique qu'à Cloud SQL pour SQL Server.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SqlTdeExportOptions

Représentation JSON 
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
Champs
certificatePath

string

Obligatoire. Chemin d'accès à la clé publique du certificat TDE au format gs://bucketName/fileName. L'instance doit disposer d'un accès en écriture au bucket. Ne s'applique qu'aux instances SQL Server.
privateKeyPath

string

Obligatoire. Chemin d'accès à la clé privée du certificat TDE au format gs://bucketName/fileName. L'instance doit disposer d'un accès en écriture à l'emplacement. Ne s'applique qu'aux instances SQL Server.
privateKeyPassword

string

Obligatoire. Mot de passe qui chiffre la clé privée.
name

string

Obligatoire. Nom du certificat. Ne s'applique qu'aux instances SQL Server.

BackupContext

Représentation JSON 
{
  "backupId": string,
  "kind": string,
  "name": string
}
Champs
backupId

string (int64 format)

Identifiant de la sauvegarde.
kind

string

Cette valeur est toujours définie sur sql#backupContext.
name

string

Nom de la sauvegarde. Format : projects/{project}/backups/{backup}

PreCheckMajorVersionUpgradeContext

Représentation JSON 
{
  "targetDatabaseVersion": enum (SqlDatabaseVersion),
  "preCheckResponse": [
    {
      object (PreCheckResponse)
    }
  ],
  "kind": string
}
Champs
targetDatabaseVersion

enum (SqlDatabaseVersion)

Obligatoire. Version de base de données cible vers laquelle effectuer la mise à niveau.
preCheckResponse[]

object (PreCheckResponse)

Uniquement en sortie. Réponses de l'opération de prévérification.
kind

string

Facultatif. Cette valeur est toujours définie sur sql#preCheckMajorVersionUpgradeContext.

PreCheckResponse

Représentation JSON 
{
  "actionsRequired": [
    string
  ],

  // Union field _message can be only one of the following:
  "message": string
  // End of list of possible types for union field _message.

  // Union field _message_type can be only one of the following:
  "messageType": enum (MessageType)
  // End of list of possible types for union field _message_type.
}
Champs
actionsRequired[]

string

Actions que l'utilisateur doit effectuer. Utilisez "Répéter" pour plusieurs actions.

Champ d'union _message.

_message ne peut être qu'un des éléments suivants :
message

string

Message à afficher auprès de l'utilisateur.

Champ d'union _message_type.

_message_type ne peut être qu'un des éléments suivants :
messageType

enum (MessageType)

Type de message (information, avertissement ou erreur).

AcquireSsrsLeaseContext

Représentation JSON 
{

  // Union field _setup_login can be only one of the following:
  "setupLogin": string
  // End of list of possible types for union field _setup_login.

  // Union field _service_login can be only one of the following:
  "serviceLogin": string
  // End of list of possible types for union field _service_login.

  // Union field _report_database can be only one of the following:
  "reportDatabase": string
  // End of list of possible types for union field _report_database.

  // Union field _duration can be only one of the following:
  "duration": string
  // End of list of possible types for union field _duration.
}
Champs

Champ d'union _setup_login.

_setup_login ne peut être qu'un des éléments suivants :
setupLogin

string

Nom d'utilisateur à utiliser comme identifiant de connexion pour la configuration afin de se connecter au serveur de base de données pour la configuration de SSRS.

Champ d'union _service_login.

_service_login ne peut être qu'un des éléments suivants :
serviceLogin

string

Nom d'utilisateur à utiliser comme identifiant de service pour se connecter à la base de données de rapports lors de la configuration de SSRS.

Champ d'union _report_database.

_report_database ne peut être qu'un des éléments suivants :
reportDatabase

string

Base de données de rapports à utiliser pour la configuration de SSRS.

Champ d'union _duration.

_duration ne peut être qu'un des éléments suivants :
duration

string (Duration format)

Durée du bail nécessaire pour la configuration de SSRS.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

Durée

Représentation JSON 
{
  "seconds": string,
  "nanos": integer
}
Champs
seconds

string (int64 format)

Secondes signées de la durée. La valeur doit être comprise entre -315 576 000 000 et +315 576 000 000 (inclus). Remarque : Ces limites sont calculées à partir de : 60 s/min * 60 min/h * 24 h/jour * 365,25 jours/an * 10 000 ans
nanos

integer

Fractions de secondes signées avec une précision de l'ordre de la nanoseconde pour la durée. Les durées inférieures à une seconde sont représentées par un champ seconds égal à 0 et un champ nanos positif ou négatif. Pour les durées d'une seconde ou plus, une valeur non nulle pour le champ nanos doit avoir le même signe que le champ seconds. La valeur doit être comprise entre -999 999 999 et +999 999 999 inclus.

SqlSubOperationType

Représentation JSON 
{

  // Union field sub_operation_details can be only one of the following:
  "maintenanceType": enum (SqlMaintenanceType)
  // End of list of possible types for union field sub_operation_details.
}
Champs
Champ d'union sub_operation_details. Détails de la sous-opération correspondant au type d'opération. sub_operation_details ne peut être qu'un des éléments suivants :
maintenanceType

enum (SqlMaintenanceType)

Type de maintenance à effectuer sur l'instance.

Annotations d'outils

Indication destructive : ❌ | Indication idempotente : ❌ | Indication en lecture seule : ❌ | Indication Open World : ❌