Skip to main content
api.databases gerencia os bancos de dados gerenciados da Square Cloud (MongoDB, MySQL, PostgreSQL e Redis). Todos os métodos, exceto create e statusAll, recebem o id do banco de dados primeiro. Para listar seus bancos de dados, use api.account.me(): seu array databases contém todos os bancos de dados que a chave pode ver. A hospedagem de bancos de dados requer um plano Standard, Pro ou Enterprise. Os exemplos usam o cliente api de Criando o cliente. databaseId é o id de um dos seus bancos de dados: api.account.me() lista todos.

Criando um banco de dados

O password e o certificate são retornados apenas por create() (e por resetCredentials()). A chamada espera pelo menos 120 s antes de expirar.

Obtendo um banco de dados

Atualizando um banco de dados

update(databaseId, { name, ram }) renomeia ou redimensiona um banco de dados. Passe pelo menos um campo (caso contrário, 400 NO_UPDATE_DATA).

Iniciar e parar

Assim como as chamadas de ciclo de vida das aplicações, elas esperam pelo menos 120 s, e uma recusa resulta em 409 com um código e uma mensagem vazia: CONTAINER_ALREADY_STARTED, CONTAINER_ALREADY_STOPPED, CONTAINER_NOT_FOUND, CONTAINER_INSUFFICIENT_DISK_SPACE, CONTAINER_NETWORK_CONFLICT ou ACTION_FAILED. Enquanto uma restauração de snapshot está em andamento, elas resultam em 403 RESTORE_IN_PROGRESS.

Status e métricas

status(databaseId) retorna valores formatados; { raw: true } retorna números. statusAll() retorna um resumo por banco de dados. metrics(databaseId) retorna as últimas 24 horas, um ponto a cada 5 minutos, do mais recente para o mais antigo.
Os campos de status são os mesmos do status de aplicações.

Credenciais

certificate(databaseId) retorna o certificado TLS como PEM codificado em base64. resetCredentials(databaseId, type) rotaciona a senha (e retorna a nova) ou o certificado (e retorna ""). O banco de dados precisa estar em execução (400 DATABASE_NOT_RUNNING).

Excluindo um banco de dados

A exclusão é permanente. Crie um snapshot antes, caso você possa precisar dos dados novamente.

Snapshots

api.databases.snapshots tem os mesmos list, create e restore das aplicações. Veja Snapshots.

Próximos passos

Workspaces

Compartilhe aplicações com sua equipe.

Referência da API de bancos de dados

Os endpoints REST por trás destes métodos.

Bancos de dados pela CLI

As mesmas ações pelo terminal.