MCP Tools Reference: cloud-sql

Ferramenta: import_data

Importar dados para uma instância do Cloud SQL.

Se o arquivo não começar com gs://, a suposição é que ele está armazenado localmente. Se o arquivo for local, ele precisará ser enviado para o Cloud Storage antes de você fazer a chamada import_data. Para fazer upload do arquivo no Cloud Storage, use os comandos gcloud ou gsutil.

Antes de fazer upload do arquivo para o Cloud Storage, considere se você quer usar um bucket atual ou criar um novo no projeto fornecido.

Depois que o arquivo é enviado para o Cloud Storage, a conta de serviço da instância precisa ter permissões suficientes para ler o arquivo enviado do bucket do Cloud Storage.

Isso pode ser feito da seguinte forma:

1. Use a ferramenta get_instance para receber o endereço de e-mail da conta de serviço da instância. Na saída da ferramenta, acesse o valor do campo serviceAccountEmailAddress.
2. Conceda à conta de serviço da instância o papel storage.objectAdmin no bucket do Cloud Storage fornecido. Use um comando como gcloud storage buckets add-iam-policy-binding ou uma solicitação para a API Storage do Cloud Storage. Pode levar de dois a sete minutos ou mais para que a função seja concedida e as permissões sejam propagadas para a conta de serviço no Cloud Storage. Se você encontrar um erro de permissões após atualizar a política do IAM, aguarde alguns minutos e tente de novo.

Depois que as permissões forem concedidas, você poderá importar os dados. Recomendamos que você deixe os parâmetros opcionais vazios e use os padrões do sistema. O tipo de arquivo geralmente é determinado pela extensão. Por exemplo, se o arquivo for SQL, .sql ou .csv para arquivo CSV.

Confira a seguir um exemplo de importContext SQL para MySQL.

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

Não há um parâmetro database para o MySQL, já que o nome do banco de dados precisa estar presente no arquivo SQL. Especifique apenas um URI. Nenhum outro campo é obrigatório além de importContext.

Para o PostgreSQL, o campo database é obrigatório. Confira a seguir um exemplo de importContext do PostgreSQL com o campo database especificado.

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

A ferramenta import_data retorna uma operação de longa duração. Use a ferramenta get_operation para pesquisar o status até que a operação seja concluída.

O exemplo a seguir demonstra como usar curl para invocar a ferramenta import_data MCP.

Solicitação 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 }'

Esquema de entrada

Solicitação de importação de instância.

SqlInstancesImportRequest

Representação JSON
{ "instance": string, "project": string, "body": { object (InstancesImportRequest) } }

Campos
instance	string ID da instância do Cloud SQL. Isso não inclui o ID do projeto.
project	string ID do projeto com a instância.
body	object (InstancesImportRequest)

InstancesImportRequest

Representação JSON
{ "importContext": { object (ImportContext) } }

Campos
importContext	object (ImportContext) Contém detalhes sobre a operação de importação.

ImportContext

Representação JSON
{ "uri": string, "database": string, "kind": string, "fileType": enum (SqlFileType), "csvImportOptions": { object (SqlCsvImportOptions) }, "importUser": string, "bakImportOptions": { object (SqlBakImportOptions) }, "sqlImportOptions": { object (SqlImportOptions) }, "tdeImportOptions": { object (SqlTdeImportOptions) } }

Campos
uri	string Caminho para o arquivo de importação no Cloud Storage, no formato gs://bucketName/fileName. Arquivos gzip compactados (.gz) são compatíveis quando fileType é SQL. A instância precisa ter permissões de gravação no bucket e acesso de leitura ao arquivo.
database	string O banco de dados de destino da importação. Se fileType for SQL, esse campo será obrigatório somente se o arquivo de importação não especificar um banco de dados e for substituído por qualquer especificação de banco de dados no arquivo de importação. Para operações de importação paralela de instâncias inteiras, o banco de dados é substituído pelo nome armazenado no nome do subdiretório. Se fileType for CSV, será preciso especificar um banco de dados.
kind	string Esse valor é sempre sql#importContext.
fileType	enum (SqlFileType) O tipo de arquivo do URI especificado.`SQL: The file contains SQL statements. \CSV`: o arquivo contém dados CSV.
csvImportOptions	object (SqlCsvImportOptions) Opções para importar dados como CSV.
importUser	string O usuário do PostgreSQL para esta operação de importação. Somente instâncias do PostgreSQL.
bakImportOptions	object (SqlBakImportOptions) Parâmetros de importação específicos para arquivos .BAK do SQL Server
sqlImportOptions	object (SqlImportOptions) Opcional. Opções para importar dados de instruções SQL.
tdeImportOptions	object (SqlTdeImportOptions) Opcional. Parâmetros de importação específicos para certificados TDE do SQL Server

SqlCsvImportOptions

Representação JSON
{ "table": string, "columns": [ string ], "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string }

Campos
table	string A tabela para a qual os dados CSV são importados.
columns[]	string As colunas para as quais os dados CSV são importados. Se não for especificado, todas as colunas da tabela do banco de dados serão carregadas com dados CSV.
escapeCharacter	string Especifica o caractere que precisa aparecer antes de um caractere de dados que precisa de escape.
quoteCharacter	string Especifica o caractere de aspas a ser usado quando um valor de dados é colocado entre aspas.
fieldsTerminatedBy	string Especifica o caractere que separa as colunas em cada linha do arquivo.
linesTerminatedBy	string Usado para separar linhas. Se uma linha não tiver todos os campos, o restante das colunas será definido com os valores padrão.

SqlBakImportOptions

Representação JSON
{ "encryptionOptions": { object (EncryptionOptions) }, "striped": boolean, "noRecovery": boolean, "recoveryOnly": boolean, "bakType": enum (BakType), "stopAt": string, "stopAtMark": string }

Campos
encryptionOptions	object (EncryptionOptions)
striped	boolean Se o conjunto de backup que está sendo restaurado é distribuído ou não. Aplicável apenas ao Cloud SQL para SQL Server.
noRecovery	boolean Indica se a importação do backup vai restaurar o banco de dados com a opção NORECOVERY. Aplicável apenas ao Cloud SQL para SQL Server.
recoveryOnly	boolean Se a solicitação de importação de backup apenas vai colocar o banco de dados on-line sem baixar o conteúdo Bak. Apenas "no_recovery" e "recovery_only" podem ser verdadeiros. Caso contrário, um erro será retornado. Aplicável apenas ao Cloud SQL para SQL Server.
bakType	enum (BakType) Tipo do conteúdo bak, FULL ou DIFF
stopAt	string (Timestamp format) Opcional. O carimbo de data/hora em que a importação deve ser interrompida. Esse carimbo de data/hora está no formato RFC 3339 (por exemplo, 2023-10-01T16:19:00.094). Esse campo é equivalente à palavra-chave STOPAT e se aplica apenas ao Cloud SQL para SQL Server. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
stopAtMark	string Opcional. A transação marcada em que a importação deve ser interrompida. Esse campo é equivalente à palavra-chave STOPATMARK e se aplica apenas ao Cloud SQL para SQL Server.

EncryptionOptions

Representação JSON
{ "certPath": string, "pvkPath": string, "pvkPassword": string, "keepEncrypted": boolean }

Campos
certPath	string Caminho do certificado (.cer) no Cloud Storage, no formato gs://bucketName/fileName. A instância precisa ter permissões de gravação no bucket e acesso de leitura ao arquivo.
pvkPath	string Caminho da chave particular do certificado (.pvk) no Cloud Storage, no formato gs://bucketName/fileName. A instância precisa ter permissões de gravação no bucket e acesso de leitura ao arquivo.
pvkPassword	string A senha que criptografa a chave particular.
keepEncrypted	boolean Opcional. Se o arquivo importado permanece criptografado.

BoolValue

Representação JSON
{ "value": boolean }

Campos
value	boolean O valor booleano.

Carimbo de data/hora

Representação JSON
{ "seconds": string, "nanos": integer }

Campos
seconds	string (int64 format) Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos	integer Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

SqlImportOptions

Representação JSON
{ "threads": integer, "parallel": boolean, "postgresImportOptions": { object (PostgresImportOptions) } }

Campos
threads	integer Opcional. O número de linhas de execução a serem usadas para importação paralela.
parallel	boolean Opcional. Se a importação deve ser paralela ou não.
postgresImportOptions	object (PostgresImportOptions) Opcional. Opções para importar de uma instância do Cloud SQL para PostgreSQL.

Int32Value

Representação JSON
{ "value": integer }

Campos
value	integer O valor int32.

PostgresImportOptions

Representação JSON
{ "clean": boolean, "ifExists": boolean }

Campos
clean	boolean Opcional. A flag --clean para o utilitário pg_restore. Essa flag só se aplica se você tiver ativado o Cloud SQL para importar arquivos em paralelo.
ifExists	boolean Opcional. A flag "--if-exists" para o utilitário pg_restore. Essa flag só se aplica se você tiver ativado o Cloud SQL para importar arquivos em paralelo.

SqlTdeImportOptions

Representação JSON
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string }

Campos
certificatePath	string Obrigatório. Caminho para a chave pública do certificado TDE no formato gs://bucketName/fileName. A instância precisa ter acesso de leitura ao arquivo. Aplicável apenas a instâncias do SQL Server.
privateKeyPath	string Obrigatório. Caminho para a chave privada do certificado TDE no formato gs://bucketName/fileName. A instância precisa ter acesso de leitura ao arquivo. Aplicável apenas a instâncias do SQL Server.
privateKeyPassword	string Obrigatório. A senha que criptografa a chave privada.
name	string Obrigatório. Nome do certificado. Aplicável apenas a instâncias do SQL Server.

Esquema de saída

Um recurso de operação. Para operações bem-sucedidas que retornam um recurso de operação, somente os campos relevantes à operação são preenchidos no recurso.

Operação

Representação 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) } }

Campos
kind	string Esse valor é sempre sql#operation.
targetLink	string
status	enum (SqlOperationStatus) O status de uma operação.
user	string O endereço de e-mail do usuário que iniciou essa operação.
insertTime	string (Timestamp format) A hora em que essa operação foi colocada na fila no fuso horário UTC no formato RFC 3339. Por exemplo, 2012-11-15T16:19:00.094Z. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
startTime	string (Timestamp format) A hora em que essa operação começou no fuso horário UTC no formato RFC 3339. Por exemplo, 2012-11-15T16:19:00.094Z. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime	string (Timestamp format) A hora em que essa operação foi concluída no fuso horário UTC no formato RFC 3339, por exemplo, 2012-11-15T16:19:00.094Z. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
error	object (OperationErrors) Se ocorrerem erros durante o processamento dessa operação, esse campo será preenchido.
apiWarning	object (ApiWarning) Uma mensagem de aviso da API Admin.
operationType	enum (SqlOperationType) O tipo da operação. Os valores válidos são: * CREATE * DELETE * UPDATE * RESTART * IMPORT * EXPORT * BACKUP_VOLUME * RESTORE_VOLUME * CREATE_USER * DELETE_USER * CREATE_DATABASE * DELETE_DATABASE
importContext	object (ImportContext) O contexto da operação de importação, se aplicável.
exportContext	object (ExportContext) O contexto da operação de exportação, se aplicável.
backupContext	object (BackupContext) O contexto da operação de backup, se aplicável.
preCheckMajorVersionUpgradeContext	object (PreCheckMajorVersionUpgradeContext) Esse campo só é preenchido quando o "operation_type" é "PRE_CHECK_MAJOR_VERSION_UPGRADE". A mensagem "PreCheckMajorVersionUpgradeContext" contém os detalhes dessa pré-verificação, como a versão de destino do banco de dados para o upgrade e os resultados da verificação (incluindo avisos ou erros encontrados).
name	string Um identificador que identifica exclusivamente a operação. É possível usar esse identificador para recuperar o recurso Operações que tem informações sobre a operação.
targetId	string Nome do recurso em que essa operação é executada.
selfLink	string O URI desse recurso.
targetProject	string O ID do projeto da instância de destino relacionada a essa operação.
acquireSsrsLeaseContext	object (AcquireSsrsLeaseContext) O contexto da operação de aquisição de concessão do SSRS, se aplicável.
subOperationType	object (SqlSubOperationType) Opcional. A suboperação com base no tipo de operação.

Carimbo de data/hora

Representação JSON
{ "seconds": string, "nanos": integer }

Campos
seconds	string (int64 format) Representa os segundos do horário UTC desde a época Unix 1970-01-01T00:00:00Z. Precisa estar entre -62135596800 e 253402300799 (o que corresponde a 0001-01-01T00:00:00Z a 9999-12-31T23:59:59Z).
nanos	integer Frações não negativas de um segundo com resolução de nanossegundos. Esse campo é a parte de nanossegundos da duração, não uma alternativa aos segundos. Os valores de segundos negativos com frações ainda precisam ter valores em nanossegundos não negativos que representam períodos posteriores. O valor precisa estar entre 0 e 999.999.999 (inclusive).

OperationErrors

Representação JSON
{ "kind": string, "errors": [ { object (OperationError) } ] }

Campos
kind	string Esse valor é sempre sql#operationErrors.
errors[]	object (OperationError) A lista de erros encontrados durante o processamento dessa operação.

OperationError

Representação JSON
{ "kind": string, "code": string, "message": string }

Campos
kind	string Esse valor é sempre sql#operationError.
code	string Identifica o erro específico que ocorreu.
message	string Informações adicionais sobre o erro encontrado.

ApiWarning

Representação JSON
{ "code": enum (SqlApiWarningCode), "message": string, "region": string }

Campos
code	enum (SqlApiWarningCode) Código para identificar exclusivamente o tipo de aviso.
message	string A mensagem de aviso.
region	string O nome da região para o aviso REGION_UNREACHABLE.

ImportContext

Representação JSON
{ "uri": string, "database": string, "kind": string, "fileType": enum (SqlFileType), "csvImportOptions": { object (SqlCsvImportOptions) }, "importUser": string, "bakImportOptions": { object (SqlBakImportOptions) }, "sqlImportOptions": { object (SqlImportOptions) }, "tdeImportOptions": { object (SqlTdeImportOptions) } }

Campos
uri	string Caminho para o arquivo de importação no Cloud Storage, no formato gs://bucketName/fileName. Arquivos gzip compactados (.gz) são compatíveis quando fileType é SQL. A instância precisa ter permissões de gravação no bucket e acesso de leitura ao arquivo.
database	string O banco de dados de destino da importação. Se fileType for SQL, esse campo será obrigatório somente se o arquivo de importação não especificar um banco de dados e for substituído por qualquer especificação de banco de dados no arquivo de importação. Para operações de importação paralela de instâncias inteiras, o banco de dados é substituído pelo nome armazenado no nome do subdiretório. Se fileType for CSV, será preciso especificar um banco de dados.
kind	string Esse valor é sempre sql#importContext.
fileType	enum (SqlFileType) O tipo de arquivo do URI especificado.`SQL: The file contains SQL statements. \CSV`: o arquivo contém dados CSV.
csvImportOptions	object (SqlCsvImportOptions) Opções para importar dados como CSV.
importUser	string O usuário do PostgreSQL para esta operação de importação. Somente instâncias do PostgreSQL.
bakImportOptions	object (SqlBakImportOptions) Parâmetros de importação específicos para arquivos .BAK do SQL Server
sqlImportOptions	object (SqlImportOptions) Opcional. Opções para importar dados de instruções SQL.
tdeImportOptions	object (SqlTdeImportOptions) Opcional. Parâmetros de importação específicos para certificados TDE do SQL Server

SqlCsvImportOptions

Representação JSON
{ "table": string, "columns": [ string ], "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string }

Campos
table	string A tabela para a qual os dados CSV são importados.
columns[]	string As colunas para as quais os dados CSV são importados. Se não for especificado, todas as colunas da tabela do banco de dados serão carregadas com dados CSV.
escapeCharacter	string Especifica o caractere que precisa aparecer antes de um caractere de dados que precisa de escape.
quoteCharacter	string Especifica o caractere de aspas a ser usado quando um valor de dados é colocado entre aspas.
fieldsTerminatedBy	string Especifica o caractere que separa as colunas em cada linha do arquivo.
linesTerminatedBy	string Usado para separar linhas. Se uma linha não tiver todos os campos, o restante das colunas será definido com os valores padrão.

SqlBakImportOptions

Representação JSON
{ "encryptionOptions": { object (EncryptionOptions) }, "striped": boolean, "noRecovery": boolean, "recoveryOnly": boolean, "bakType": enum (BakType), "stopAt": string, "stopAtMark": string }

Campos
encryptionOptions	object (EncryptionOptions)
striped	boolean Se o conjunto de backup que está sendo restaurado é distribuído ou não. Aplicável apenas ao Cloud SQL para SQL Server.
noRecovery	boolean Indica se a importação do backup vai restaurar o banco de dados com a opção NORECOVERY. Aplicável apenas ao Cloud SQL para SQL Server.
recoveryOnly	boolean Se a solicitação de importação de backup apenas vai colocar o banco de dados on-line sem baixar o conteúdo Bak. Apenas "no_recovery" e "recovery_only" podem ser verdadeiros. Caso contrário, um erro será retornado. Aplicável apenas ao Cloud SQL para SQL Server.
bakType	enum (BakType) Tipo do conteúdo bak, FULL ou DIFF
stopAt	string (Timestamp format) Opcional. O carimbo de data/hora em que a importação deve ser interrompida. Esse carimbo de data/hora está no formato RFC 3339 (por exemplo, 2023-10-01T16:19:00.094). Esse campo é equivalente à palavra-chave STOPAT e se aplica apenas ao Cloud SQL para SQL Server. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
stopAtMark	string Opcional. A transação marcada em que a importação deve ser interrompida. Esse campo é equivalente à palavra-chave STOPATMARK e se aplica apenas ao Cloud SQL para SQL Server.

EncryptionOptions

Representação JSON
{ "certPath": string, "pvkPath": string, "pvkPassword": string, "keepEncrypted": boolean }

Campos
certPath	string Caminho do certificado (.cer) no Cloud Storage, no formato gs://bucketName/fileName. A instância precisa ter permissões de gravação no bucket e acesso de leitura ao arquivo.
pvkPath	string Caminho da chave particular do certificado (.pvk) no Cloud Storage, no formato gs://bucketName/fileName. A instância precisa ter permissões de gravação no bucket e acesso de leitura ao arquivo.
pvkPassword	string A senha que criptografa a chave particular.
keepEncrypted	boolean Opcional. Se o arquivo importado permanece criptografado.

BoolValue

Representação JSON
{ "value": boolean }

Campos
value	boolean O valor booleano.

SqlImportOptions

Representação JSON
{ "threads": integer, "parallel": boolean, "postgresImportOptions": { object (PostgresImportOptions) } }

Campos
threads	integer Opcional. O número de linhas de execução a serem usadas para importação paralela.
parallel	boolean Opcional. Se a importação deve ser paralela ou não.
postgresImportOptions	object (PostgresImportOptions) Opcional. Opções para importar de uma instância do Cloud SQL para PostgreSQL.

Int32Value

Representação JSON
{ "value": integer }

Campos
value	integer O valor int32.

PostgresImportOptions

Representação JSON
{ "clean": boolean, "ifExists": boolean }

Campos
clean	boolean Opcional. A flag --clean para o utilitário pg_restore. Essa flag só se aplica se você tiver ativado o Cloud SQL para importar arquivos em paralelo.
ifExists	boolean Opcional. A flag "--if-exists" para o utilitário pg_restore. Essa flag só se aplica se você tiver ativado o Cloud SQL para importar arquivos em paralelo.

SqlTdeImportOptions

Representação JSON
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string }

Campos
certificatePath	string Obrigatório. Caminho para a chave pública do certificado TDE no formato gs://bucketName/fileName. A instância precisa ter acesso de leitura ao arquivo. Aplicável apenas a instâncias do SQL Server.
privateKeyPath	string Obrigatório. Caminho para a chave privada do certificado TDE no formato gs://bucketName/fileName. A instância precisa ter acesso de leitura ao arquivo. Aplicável apenas a instâncias do SQL Server.
privateKeyPassword	string Obrigatório. A senha que criptografa a chave privada.
name	string Obrigatório. Nome do certificado. Aplicável apenas a instâncias do SQL Server.

ExportContext

Representação JSON
{ "uri": string, "databases": [ string ], "kind": string, "sqlExportOptions": { object (SqlExportOptions) }, "csvExportOptions": { object (SqlCsvExportOptions) }, "fileType": enum (SqlFileType), "offload": boolean, "bakExportOptions": { object (SqlBakExportOptions) }, "tdeExportOptions": { object (SqlTdeExportOptions) } }

Campos
uri	string O caminho do arquivo no Google Cloud Storage em que a exportação será armazenada. O URI está no formato gs://bucketName/fileName. Se o arquivo já existir, a solicitação será bem-sucedida, mas a operação vai falhar. Se fileType for SQL e o nome do arquivo terminar com .gz, o conteúdo será compactado.
databases[]	string Bancos de dados a serem exportados. MySQL instances: Se fileType for SQL e nenhum banco de dados for especificado, todos os bancos de dados serão exportados, exceto o banco de dados do sistema mysql. Se fileType for CSV, você poderá especificar um banco de dados usando essa propriedade ou a propriedade csvExportOptions.selectQuery, que tem precedência sobre aquela propriedade. PostgreSQL instances: Se você não especificar um banco de dados por nome, todos os bancos de dados do usuário na instância serão exportados. Isso exclui bancos de dados do sistema e do Cloud SQL usados para gerenciar operações internas. A exportação de todos os bancos de dados de usuários só está disponível para a exportação paralela formatada em diretório. Se fileType for CSV, esse banco de dados precisará corresponder ao especificado na propriedade csvExportOptions.selectQuery. SQL Server instances: Você precisa especificar um banco de dados para exportação, e o fileType precisa ser BAK.
kind	string Esse valor é sempre sql#exportContext.
sqlExportOptions	object (SqlExportOptions) Opções para exportar dados como instruções SQL.
csvExportOptions	object (SqlCsvExportOptions) Opções para exportar dados como CSV. Somente instâncias MySQL e PostgreSQL.
fileType	enum (SqlFileType) O tipo de arquivo do URI especificado.
offload	boolean Se uma exportação sem servidor será realizada.
bakExportOptions	object (SqlBakExportOptions) Opções para exportar dados como arquivos BAK.
tdeExportOptions	object (SqlTdeExportOptions) Opcional. Parâmetros de exportação específicos para certificados TDE do SQL Server

SqlExportOptions

Representação JSON
{ "tables": [ string ], "schemaOnly": boolean, "mysqlExportOptions": { object (MysqlExportOptions) }, "threads": integer, "parallel": boolean, "postgresExportOptions": { object (PostgresExportOptions) } }

Campos
tables[]	string Tabelas a serem exportadas, ou que foram exportadas, do banco de dados especificado. Se você especificar tabelas, especifique apenas um banco de dados. Para instâncias do PostgreSQL, é possível especificar apenas uma tabela.
schemaOnly	boolean Exportar apenas esquemas.
mysqlExportOptions	object (MysqlExportOptions)
threads	integer Opcional. O número de linhas de execução a serem usadas para exportação paralela.
parallel	boolean Opcional. Se a exportação deve ser paralela ou não.
postgresExportOptions	object (PostgresExportOptions) Opcional. Opções para exportar de uma instância do Cloud SQL para PostgreSQL.

MysqlExportOptions

Representação JSON
{ "masterData": integer }

Campos

masterData

integer Opção para incluir a instrução SQL necessária para configurar a replicação. Se definido como 1, o arquivo dump vai incluir uma instrução CHANGE MASTER TO com as coordenadas do registro binário, e --set-gtid-purged será definido como ON. Se definido como 2, a instrução CHANGE MASTER TO será escrita como um comentário SQL e não terá efeito. Se definido como qualquer valor diferente de 1, --set-gtid-purged será definido como OFF.

PostgresExportOptions

Representação JSON
{ "clean": boolean, "ifExists": boolean }

Campos
clean	boolean Opcional. Use essa opção para incluir DROP <object> Instruções SQL. Use estas instruções para excluir objetos do banco de dados antes de executar a operação de importação.
ifExists	boolean Opcional. Opção para incluir uma instrução SQL IF EXISTS com cada instrução DROP produzida por clean.

SqlCsvExportOptions

Representação JSON
{ "selectQuery": string, "escapeCharacter": string, "quoteCharacter": string, "fieldsTerminatedBy": string, "linesTerminatedBy": string }

Campos
selectQuery	string A consulta de seleção usada para extrair os dados.
escapeCharacter	string Especifica o caractere que precisa aparecer antes de um caractere de dados que precisa de escape.
quoteCharacter	string Especifica o caractere de aspas a ser usado quando um valor de dados é colocado entre aspas.
fieldsTerminatedBy	string Especifica o caractere que separa as colunas em cada linha do arquivo.
linesTerminatedBy	string Usado para separar linhas. Se uma linha não tiver todos os campos, o restante das colunas será definido com os valores padrão.

SqlBakExportOptions

Representação JSON
{ "striped": boolean, "stripeCount": integer, "bakType": enum (BakType), "copyOnly": boolean, "differentialBase": boolean, "exportLogStartTime": string, "exportLogEndTime": string }

Campos
striped	boolean Se a exportação deve ser listrada ou não.
stripeCount	integer Opção para especificar quantas listras usar na exportação. Se estiver em branco e o valor do campo listrado for verdadeiro, o número de listras será escolhido automaticamente.
bakType	enum (BakType) O tipo deste arquivo BAK será "export", "FULL" ou "DIFF", somente para SQL Server.
copyOnly (deprecated)	boolean Este item foi descontinuado. Descontinuado: copy_only foi descontinuado. Use differential_base em vez disso
differentialBase	boolean Se o backup pode ser usado como um backup diferencial de base copy_only não pode ser usado como base diferencial
exportLogStartTime	string (Timestamp format) Opcional. O carimbo de data/hora de início em que o registro de transações será incluído na operação de exportação. Formato RFC 3339 (por exemplo, 2023-10-01T16:19:00.094) em UTC. Quando omitido, todos os registros disponíveis desde o início do período de armazenamento serão incluídos. Aplicado apenas ao Cloud SQL para SQL Server. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
exportLogEndTime	string (Timestamp format) Opcional. O carimbo de data/hora de término em que o registro de transações será incluído na operação de exportação. Formato RFC 3339 (por exemplo, 2023-10-01T16:19:00.094) em UTC. Quando omitido, todos os registros disponíveis até o momento atual serão incluídos. Aplicado apenas ao Cloud SQL para SQL Server. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SqlTdeExportOptions

Representação JSON
{ "certificatePath": string, "privateKeyPath": string, "privateKeyPassword": string, "name": string }

Campos
certificatePath	string Obrigatório. Caminho para a chave pública do certificado TDE no formato gs://bucketName/fileName. A instância precisa ter acesso de gravação ao bucket. Aplicável apenas a instâncias do SQL Server.
privateKeyPath	string Obrigatório. Caminho para a chave privada do certificado TDE no formato gs://bucketName/fileName. A instância precisa ter acesso de gravação ao local. Aplicável apenas a instâncias do SQL Server.
privateKeyPassword	string Obrigatório. A senha que criptografa a chave privada.
name	string Obrigatório. Nome do certificado. Aplicável apenas a instâncias do SQL Server.

BackupContext

Representação JSON
{ "backupId": string, "kind": string, "name": string }

Campos
backupId	string (int64 format) O identificador do backup.
kind	string Esse valor é sempre sql#backupContext.
name	string O nome do backup. Formato: projects/{project}/backups/{backup}

PreCheckMajorVersionUpgradeContext

Representação JSON
{ "targetDatabaseVersion": enum (SqlDatabaseVersion), "preCheckResponse": [ { object (PreCheckResponse) } ], "kind": string }

Campos
targetDatabaseVersion	enum (SqlDatabaseVersion) Obrigatório. A versão de destino do banco de dados para fazer upgrade.
preCheckResponse[]	object (PreCheckResponse) Apenas saída. As respostas da operação de pré-verificação.
kind	string Opcional. Esse valor é sempre sql#preCheckMajorVersionUpgradeContext.

PreCheckResponse

Representação 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. }

Campos
actionsRequired[]	string As ações que o usuário precisa realizar. Use "repeated" para várias ações.
Campo de união _message. _message pode ser apenas de um dos tipos a seguir:
message	string A mensagem que será exibida para o usuário.
Campo de união _message_type. _message_type pode ser apenas de um dos tipos a seguir:
messageType	enum (MessageType) O tipo de mensagem, seja de informação, aviso ou erro.

AcquireSsrsLeaseContext

Representação 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. }

Campos
Campo de união _setup_login. _setup_login pode ser apenas de um dos tipos a seguir:
setupLogin	string O nome de usuário a ser usado como login de configuração para se conectar ao servidor de banco de dados na configuração do SSRS.
Campo de união _service_login. _service_login pode ser apenas de um dos tipos a seguir:
serviceLogin	string O nome de usuário a ser usado como login de serviço para se conectar ao banco de dados de relatórios na configuração do SSRS.
Campo de união _report_database. _report_database pode ser apenas de um dos tipos a seguir:
reportDatabase	string O banco de dados de relatórios a ser usado para a configuração do SSRS.
Campo de união _duration. _duration pode ser apenas de um dos tipos a seguir:
duration	string (Duration format) Duração do lease necessária para a configuração do SSRS. Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

Duração

Representação JSON
{ "seconds": string, "nanos": integer }

Campos
seconds	string (int64 format) Segundos assinados do período. Precisa estar entre -315.576.000.000 e +315.576.000.000 (inclusive). Observação: esses limites são calculados da seguinte forma: 60 s/min * 60 min/h * 24 h/dia * 365,25 dias/ano * 10.000 anos
nanos	integer Frações assinadas de um segundo com resolução de nanossegundos do período. Durações menores que um segundo são representadas com um campo seconds 0 e um campo nanos positivo ou negativo. Para durações de um segundo ou mais, um valor diferente de zero para o campo nanos precisa ter o mesmo sinal do campo seconds. Precisa estar entre -999.999.999 e +999.999.999 (inclusive).

SqlSubOperationType

Representação 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. }

Campos
Campo de união sub_operation_details. Detalhes da suboperação correspondentes ao tipo de operação. sub_operation_details pode ser apenas de um dos tipos a seguir:
maintenanceType	enum (SqlMaintenanceType) O tipo de manutenção a ser realizada na instância.

Anotações de ferramentas

Dica destrutiva: ❌ | Dica idempotente: ❌ | Dica somente leitura: ❌ | Dica de mundo aberto: ❌