MCP Tools Reference: cloud-sql

Ferramenta: update_user

Atualize um usuário de banco de dados para uma instância do Cloud SQL. Um caso de uso comum para o update_user é conceder a um usuário a função cloudsqlsuperuser, que pode fornecer a ele muitas permissões necessárias.

Essa ferramenta só aceita a atualização de usuários para atribuir papéis de banco de dados.

  • Essa ferramenta 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.
  • Antes de chamar a ferramenta update_user, sempre verifique a configuração atual do usuário, como o tipo de usuário, com a ferramenta list_users.
  • Como um caso especial para o MySQL, se a ferramenta list_users retornar um endereço de e-mail completo para o campo iamEmail, por exemplo, {name=test-account, iamEmail=test-account@project-id.iam.gserviceaccount.com}, na solicitação update_user, use o endereço de e-mail completo no campo iamEmail do campo name do toolrequest. Exemplo: name=test-account@project-id.iam.gserviceaccount.com.

Parâmetros principais para atualizar as funções dos usuários:

  • database_roles: uma lista de papéis de banco de dados a serem atribuídos ao usuário.
  • revokeExistingRoles: um campo booleano (padrão: "false") que controla como as funções atuais são processadas.

Como as atualizações de função funcionam:

  1. Se revokeExistingRoles for verdadeiro:

    • Todas as funções concedidas ao usuário, mas NÃO na lista database_roles fornecida, serão REVOGADAS.
    • A revogação se aplica apenas a papéis que não são do sistema. Funções do sistema, como cloudsqliamuser, não serão revogadas.
    • Todas as funções na lista database_roles que o usuário ainda NÃO tem serão CONCEDIDAS.
    • Se database_roles estiver vazio, TODOS os papéis não relacionados ao sistema serão revogados.
  2. Se revokeExistingRoles for "false" (padrão):

    • Todas as funções na lista database_roles que o usuário ainda NÃO tem serão CONCEDIDAS.
    • Os papéis atuais que NÃO estão na lista database_roles são MANTIDOS.
    • Se database_roles estiver vazio, não haverá mudança nos papéis do usuário.

Exemplos:

  • Funções atuais: [roleA, roleB]

    • Solicitação: database_roles: [roleB, roleC], revokeExistingRoles: true
    • Resultado: revoga roleA e concede roleC. As funções de usuário se tornam [roleB, roleC].
    • Solicitação: database_roles: [roleB, roleC], revokeExistingRoles: false
    • Resultado: concede roleC. As funções de usuário se tornam [roleA, roleB, roleC].
    • Solicitação: database_roles: [], revokeExistingRoles: true
    • Resultado: revoga roleA e roleB. As funções de usuário se tornam [].
    • Solicitação: database_roles: [], revokeExistingRoles: false
    • Resultado: nenhuma mudança. As funções de usuário permanecem [roleA, roleB].

O exemplo a seguir demonstra como usar curl para invocar a ferramenta update_user 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": "update_user",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Esquema de entrada

Solicitação de atualização do usuário para o MCP.

SqlUsersUpdateMcpRequest

Representação JSON
{
  "host": string,
  "instance": string,
  "name": string,
  "project": string,
  "databaseRoles": [
    string
  ],
  "type": enum (SqlUserType),

  // Union field _revoke_existing_roles can be only one of the following:
  "revokeExistingRoles": boolean
  // End of list of possible types for union field _revoke_existing_roles.
}
Campos
host

string

Opcional. Host do usuário na instância.

instance

string

Obrigatório. ID da instância do banco de dados. Isso não inclui o ID do projeto.

name

string

Obrigatório. Nome do usuário na instância.

project

string

Obrigatório. ID do projeto com a instância.

databaseRoles[]

string

Opcional. Lista de funções de banco de dados a serem concedidas ao usuário. body.database_roles será ignorado para solicitações de atualização.

type

enum (SqlUserType)

Obrigatório. O tipo de usuário. Ele determina o método para autenticar o usuário durante o login. O padrão é o tipo de usuário integrado do banco de dados.

Campo de união _revoke_existing_roles.

_revoke_existing_roles pode ser apenas de um dos tipos a seguir:

revokeExistingRoles

boolean

Opcional. Revogue os papéis concedidos ao usuário.

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: É preciso 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 do arquivo BAK será "export", "FULL" ou "DIFF", somente para SQL Server.

copyOnly
(deprecated)

boolean

Descontinuado: copy_only foi descontinuado. Use differential_base em vez disso

differentialBase

boolean

Se o backup pode ser usado como uma cópia de base diferencial, o backup 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 retenção 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 a 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: ❌