Skip to main content
Bancos de dados são expostos pelo módulo api.databases. Disponível nos planos Standard, Pro e Enterprise.

Criando um banco

api.databases.create(options) provisiona um novo banco. A password e o certificate são retornados apenas no momento da criação — armazene-os agora.
Versões atuais por engine: A resposta de create() retorna { id, name, memory, cpu, type, password, certificate?, connection_url, cluster }. cpu é a CPU alocada (shares); password e certificate só estão presentes nesta resposta de criação, não em buscas posteriores. Um type não suportado falha com code: "INVALID_DATABASE_TYPE"; memory insuficiente para o plano falha com code: "INSUFFICIENT_MEMORY"; uma falha durante o provisionamento falha com code: "DATABASE_CREATION_FAILED".

Listando seus bancos

api.user.get() popula user.databases com uma Collection contendo todos os bancos da conta:

Buscando um banco específico

Ciclo de vida

Status e métricas

Status resumido de todos os bancos

Atualizando

db.update(options) altera o nome de exibição e/ou a memória alocada. Pelo menos um campo deve ser fornecido.

Credenciais

db.credentials.certificate() retorna o certificado TLS (PEM codificado em base64):
db.credentials.reset(type) rotaciona a senha ou o certificado.
db.credentials.certificate() e db.credentials.reset() exigem que o banco esteja rodando.

Snapshots

db.snapshots espelha a API de snapshots de aplicações.
Diferente de app.snapshots.restore({ snapshotId, versionId }), db.snapshots.restore(snapshotId, versionId) usa argumentos posicionais.

Excluindo um banco

Excluir um banco é irreversível. Garanta um snapshot recente caso precise recuperar os dados.