Pular para o conteúdo

Prisma

Prisma

O Prisma Data Platform oferece ferramentas de banco de dados que incluem o Accelerate (cache global de banco de dados), o Optimize (análise de consultas por IA) e o Prisma Postgres (PostgreSQL gerenciado). Com a integração no SquadOS, seus agentes podem gerenciar workspaces, projetos, ambientes e chaves de API de forma programática, além de executar consultas SQL diretamente nos bancos de dados.

Esta ferramenta suporta OAuth 2.0 (OAUTH2) e chave de API (API_KEY) para conectar.

Consulte a Composio para os campos obrigatórios de conexão.

  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Prisma.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso (OAuth 2.0) ou informa as credenciais obtidas acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

PRISMA_CREATE_CONNECTION

Cria uma nova conexão (chave de API) para acesso ao banco de dados. Gera uma string de conexão com credenciais incorporadas prontas para uso imediato pela aplicação.

NomeTipoObrigatórioDescrição
namestringSimNome legível para a nova conexão/chave de API. Será exibido nas interfaces e usado para identificação. Escolha nomes descritivos como ‘Production API Key’, ‘Analytics Access’, ‘Dev Environment’, etc.
databaseIdstringSimIdentificador único do banco de dados para o qual criar a conexão (formato: ‘db_xxxxx’). Deve ser um banco de dados ao qual o usuário autenticado tem acesso de escrita.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_CREATE_DATABASE

Cria um novo banco de dados PostgreSQL em um projeto Prisma existente. Cria o banco de dados na região especificada com strings de conexão e chaves de API. Retorna os detalhes completos do banco de dados prontos para uso imediato.

NomeTipoObrigatórioDescrição
namestringSimNome legível para o novo banco de dados. Será exibido nas interfaces e usado para identificação. Escolha nomes descritivos como ‘Production DB’, ‘Analytics’, etc.
regionstringSimRegião AWS onde o banco de dados será implantado. Valores válidos: ‘us-east-1’, ‘us-west-1’, ‘eu-central-1’, ‘eu-west-3’, ‘ap-southeast-1’, ‘ap-northeast-1’. Escolha a região mais próxima dos seus usuários para melhor desempenho. Use LIST_POSTGRES_REGIONS para obter as regiões disponíveis.
isDefaultbooleanNãoSe este banco de dados deve ser o padrão do projeto. Padrão: false. Apenas um banco de dados pode ser o padrão por projeto.
projectIdstringSimIdentificador único do projeto onde criar o banco de dados (formato: ‘prj_xxxxx’). Deve ser um projeto ao qual o usuário autenticado tem acesso de escrita.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_CREATE_PROJECT

Cria um novo projeto Prisma com banco de dados PostgreSQL gerenciado. Cria o projeto no workspace do usuário autenticado com banco de dados na região especificada. Retorna os detalhes completos do projeto incluindo strings de conexão e chaves de API.

NomeTipoObrigatórioDescrição
namestringSimNome legível para o novo projeto. Será exibido nas interfaces e usado para identificação. Escolha nomes descritivos como ‘Production API’, ‘Dev Environment’, etc.
regionstringSimRegião AWS onde o banco de dados PostgreSQL será implantado. Regiões disponíveis: ‘us-east-1’, ‘us-west-1’, ‘eu-central-1’, ‘eu-west-3’, ‘ap-southeast-1’, ‘ap-northeast-1’. Escolha a região mais próxima dos seus usuários para melhor desempenho.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_DELETE_CONNECTION

Exclui permanentemente uma conexão de banco de dados e revoga o acesso da chave de API. Esta ação revoga imediatamente o acesso ao banco de dados para qualquer aplicação que use esta string de conexão. Certifique-se de que nenhum sistema crítico depende desta conexão.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único da conexão a excluir (formato: ‘con_xxxxx’). Esta ação revoga permanentemente o acesso da chave de API ao banco de dados. Aplicações que usam esta string de conexão perderão acesso imediatamente. Não pode ser desfeito.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_DELETE_DATABASE

Exclui permanentemente um banco de dados Prisma e todos os dados armazenados. Esta ação não pode ser desfeita. Todos os dados no banco de dados serão destruídos permanentemente. Bancos de dados padrão normalmente não podem ser excluídos.

NomeTipoObrigatórioDescrição
databaseIdstringSimIdentificador único do banco de dados a excluir (formato: ‘db_xxxxx’). Esta ação exclui permanentemente o banco de dados e todos os dados armazenados. Não pode ser desfeito. Certifique-se de que todos os dados importantes estejam com backup antes da exclusão.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_DELETE_PROJECT

Exclui permanentemente um projeto Prisma e todos os recursos associados. Esta ação não pode ser desfeita. Todos os bancos de dados, ambientes e dados do projeto serão destruídos permanentemente. Use com extrema cautela em ambientes de produção.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único do projeto a excluir (formato: ‘proj_xxxxx’). Esta ação exclui permanentemente o projeto e todos os dados associados, incluindo bancos de dados, ambientes e configurações. Não pode ser desfeito.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_EXECUTE_SQL_COMMAND

Executa comandos SQL que modificam dados ou a estrutura do banco de dados. Executa INSERT, UPDATE, DELETE, CREATE TABLE e outros comandos de modificação de dados com segurança através do driver PostgreSQL com suporte a consultas parametrizadas.

NomeTipoObrigatórioDescrição
commandstringSimComando SQL a executar no banco de dados (INSERT, UPDATE, DELETE, CREATE TABLE, etc.). Exemplos: ‘INSERT INTO users (name, email) VALUES ($1, $2)’, ‘UPDATE users SET active = $1 WHERE id = $2’, ‘DELETE FROM sessions WHERE expires_at < NOW()’.
parametersarrayNãoArray opcional de parâmetros para comandos parametrizados usando placeholders $1, $2, etc. Exemplo: command=‘INSERT INTO users (name, email) VALUES ($1, $2)’, parameters=[‘John Doe’, ‘john@example.com’]. Os parâmetros são escapados automaticamente para evitar injeção de SQL.
connectionStringstringSimString de conexão PostgreSQL para acesso direto ao banco de dados. Use o formato: ‘postgresql://USER:PASSWORD@HOST:PORT/DATABASE?sslmode=require’. Obtenha as credenciais da resposta de create_connection ou create_database. Não use URLs do Prisma Accelerate (prisma+postgres://…) — essas são apenas para o Prisma Client SDK.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_EXECUTE_SQL_QUERY

Executa consultas SQL SELECT nos bancos de dados Prisma Postgres. Executa consultas somente leitura com segurança através de conexão PostgreSQL direta com SSL. Ideal para análise de dados, inspeção de schema e operações de relatório.

NomeTipoObrigatórioDescrição
hoststringSimHost do banco de dados com porta (formato: ‘db.prisma.io:5432’). Obtenha da resposta da ação create_connection no campo ‘host’.
userstringSimUsuário do banco de dados (tenant ID do Prisma). Obtenha da resposta de create_connection no campo ‘user’.
querystringSimConsulta SQL SELECT a executar no banco de dados. Use sintaxe PostgreSQL padrão. Exemplos: ‘SELECT * FROM users LIMIT 10’, ‘SELECT name, email FROM customers WHERE active = true’. Evite INSERT/UPDATE/DELETE — use execute_sql_command para essas operações.
passwordstringSimSenha do banco de dados (chave secreta do Prisma). Obtenha da resposta de create_connection no campo ‘pass’. Formato típico: ‘sk_xxxxx’. Mantenha seguro.
parametersarrayNãoArray opcional de parâmetros para consultas parametrizadas usando placeholders %s. Exemplo: query=‘SELECT * FROM users WHERE id = %s AND active = %s’, parameters=[123, true]. Os parâmetros são escapados automaticamente para evitar injeção de SQL.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_GET_DATABASE

Recupera um banco de dados Prisma específico pelo ID. Retorna detalhes do banco de dados, incluindo status, contexto do projeto e implantação regional. Use para monitoramento, validação e operações administrativas de banco de dados.

NomeTipoObrigatórioDescrição
databaseIdstringSimIdentificador único do banco de dados a recuperar (formato: ‘db_xxxxx’). Este ID é obtido de operações de listagem ou criação de banco de dados. Deve ser um banco de dados ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_GET_DATABASE_USAGE

Recupera métricas de uso de um banco de dados Prisma específico. Retorna métricas incluindo uso de armazenamento e contagens de operações (leituras/escritas) para o período de tempo especificado. Use para monitoramento de consumo de recursos, análise de custos e planejamento de capacidade.

NomeTipoObrigatórioDescrição
endDatestringNãoData de término para a consulta de métricas no formato ISO 8601 (ex.: ‘2025-07-31T23:59:59Z’). Padrão: data atual se não fornecida.
startDatestringNãoData de início para a consulta de métricas no formato ISO 8601 (ex.: ‘2025-07-01T00:00:00Z’). Padrão: início do mês atual se não fornecido. Use para especificar intervalos de datas personalizados para análise de uso.
databaseIdstringSimIdentificador único do banco de dados para recuperar métricas de uso (formato: ‘db_xxxxx’). Deve ser um banco de dados ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_GET_PROJECT

Recupera um projeto Prisma específico pelo ID. Retorna detalhes do projeto, incluindo nome, timestamp de criação e informações do workspace. Use para visualização de detalhes do projeto, validação e operações administrativas.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único do projeto a recuperar (formato: ‘proj_xxxxx’). Este ID é obtido de operações de listagem ou criação de projetos. Deve ser um projeto ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_INSPECT_DATABASE_SCHEMA

Inspeciona a estrutura do schema e as informações das tabelas do banco de dados. Retorna detalhes completos do schema, incluindo tabelas, colunas, tipos de dados, restrições e relacionamentos. Essencial para entender a estrutura do banco de dados antes de executar consultas.

NomeTipoObrigatórioDescrição
hoststringSimHost do banco de dados com porta (formato: ‘db.prisma.io:5432’). Obtenha da resposta da ação create_connection no campo ‘host’.
userstringSimUsuário do banco de dados (tenant ID do Prisma). Obtenha da resposta de create_connection no campo ‘user’.
passwordstringSimSenha do banco de dados (chave secreta do Prisma). Obtenha da resposta de create_connection no campo ‘pass’. Formato típico: ‘sk_xxxxx’. Mantenha seguro.
tableNamestringNãoNome específico da tabela a inspecionar (opcional). Se fornecido, retorna informações detalhadas das colunas apenas para essa tabela. Se omitido, retorna visão geral de todas as tabelas do banco de dados.
includeIndexesbooleanNãoSe deve incluir informações de índice nos resultados do schema. Quando true, exibe chaves primárias, chaves estrangeiras e outros índices. Útil para entender relacionamentos entre tabelas e otimização de consultas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_ACCELERATE_REGIONS

Recupera todas as regiões disponíveis para o Prisma Accelerate. Retorna as regiões onde o cache global de banco de dados Accelerate pode ser implantado. Use para seleção de região de cache para minimizar a latência para seus usuários.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_BACKUPS

Recupera a lista de backups disponíveis para um banco de dados específico. Retorna detalhes do backup incluindo status, tamanho, tipo e prontidão para restauração. Use para monitoramento de backups, planejamento de restauração e auditoria de conformidade.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de backups a retornar em uma única requisição. Padrão: 25. Intervalo típico: 1–100. Use valores menores (10–25) para paginação de UI, valores maiores (50–100) para processamento.
databaseIdstringSimIdentificador único do banco de dados para listar backups (formato: ‘db_xxxxx’). Deve ser um banco de dados ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_CONNECTIONS

Recupera lista paginada de conexões para um banco de dados específico. Retorna detalhes das conexões incluindo nomes, datas de criação e contexto do banco de dados. Use para gerenciamento de chaves de API, auditorias de segurança e controle de acesso.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de conexões a retornar em uma única requisição. Padrão: 100. Intervalo válido: 1–500. Use valores menores (10–50) para respostas mais rápidas quando precisar de poucas conexões.
cursorstringNãoCursor de paginação para recuperar a próxima página de resultados. Use o valor ‘nextCursor’ de uma resposta anterior para obter páginas subsequentes. Deixe nulo para a primeira página.
databaseIdstringSimIdentificador único do banco de dados para listar conexões (formato: ‘db_xxxxx’). Deve ser um banco de dados ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_DATABASES

Recupera lista paginada de bancos de dados para um projeto Prisma específico. Retorna detalhes dos bancos de dados incluindo status, região e contexto do projeto. Use para descoberta de bancos de dados, monitoramento e administração de projetos.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de bancos de dados a retornar em uma única requisição. Padrão: 100. Intervalo válido: 1–500.
cursorstringNãoCursor de paginação para recuperar a próxima página de resultados. Use o valor ‘nextCursor’ de uma resposta anterior. Deixe nulo para a primeira página.
projectIdstringSimIdentificador único do projeto para listar os bancos de dados (formato: ‘prj_xxxxx’). Deve ser um projeto ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_POSTGRES_REGIONS

Recupera todas as regiões disponíveis para o Prisma Postgres. Retorna as regiões onde bancos de dados Prisma Postgres podem ser implantados com status de disponibilidade atual. Use para seleção de região durante a criação do banco de dados e planejamento de capacidade.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_PROJECTS

Recupera lista paginada de projetos Prisma acessíveis ao usuário autenticado. Retorna IDs de projetos, nomes, informações do workspace e timestamps com paginação baseada em cursor. Use para descoberta de projetos, fluxos de seleção de UI e operações administrativas.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de projetos a retornar em uma única requisição. Padrão: 100. Intervalo válido: 1–500. A API pode retornar menos resultados do que o solicitado se houver menos projetos.
cursorstringNãoCursor de paginação para recuperar a próxima página de resultados. Use o valor ‘nextCursor’ de uma resposta anterior. Deixe nulo para a primeira página.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_WORKSPACE_INTEGRATIONS

Recupera lista paginada de integrações para um workspace Prisma específico. Retorna detalhes das integrações incluindo informações do cliente OAuth, escopos concedidos e criador. Use para auditorias de segurança, gerenciamento de integrações e administração do workspace.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de integrações a retornar em uma única requisição. Padrão: 100. Intervalo válido: 1–500.
cursorstringNãoCursor de paginação para recuperar a próxima página de resultados. Use o valor ‘nextCursor’ de uma resposta anterior. Deixe nulo para a primeira página.
workspaceIdstringSimIdentificador único do workspace para listar as integrações (formato: ‘wksp_xxxxx’). Deve ser um workspace ao qual o usuário autenticado tem acesso.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_LIST_WORKSPACES

Recupera lista paginada de workspaces Prisma acessíveis ao usuário autenticado. Retorna IDs dos workspaces, nomes e timestamps de criação com paginação baseada em cursor. Use para descoberta de workspaces, fluxos de seleção de UI e operações administrativas.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de workspaces a retornar em uma única requisição. Padrão: 100. Intervalo válido: 1–500. A API pode retornar menos resultados do que o solicitado se houver menos workspaces.
cursorstringNãoCursor de paginação para recuperar a próxima página de resultados. Use o valor ‘nextCursor’ de uma resposta anterior. Deixe nulo para a primeira página.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_RESTORE_BACKUP

Restaura um backup de banco de dados em uma nova instância de banco de dados. Cria um novo banco de dados a partir de um backup existente com o nome especificado. A operação é assíncrona — monitore o status do banco de dados retornado para acompanhar a conclusão. A restauração pode levar vários minutos.

NomeTipoObrigatórioDescrição
backupIdstringSimIdentificador único do backup a restaurar. Deve ser um backup concluído do banco de dados especificado. Use a ação list_backups para encontrar os IDs de backup disponíveis.
databaseIdstringSimIdentificador único do banco de dados de origem que contém o backup (formato: ‘db_xxxxx’). Deve ser um banco de dados ao qual o usuário autenticado tem acesso.
targetDatabaseNamestringSimNome para o novo banco de dados criado a partir da restauração do backup. Escolha nomes descritivos como ‘Restored DB 2025-01-20’, ‘Production Rollback’, etc.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

PRISMA_TRANSFER_PROJECT

Transfere a propriedade de um projeto Prisma para o workspace de outro usuário. Transfere o projeto e todos os seus bancos de dados do usuário autenticado atual para o destinatário especificado pelo seu token de acesso OAuth2. Normalmente usado em integrações de parceiros onde os bancos de dados são provisionados no workspace do parceiro e posteriormente transferidos para os usuários finais. O proprietário atual perde o acesso a menos que o novo proprietário conceda explicitamente.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único do projeto a transferir (formato: ‘proj_xxxxx’). Obtenha de PRISMA_LIST_PROJECTS ou da resposta de PRISMA_CREATE_PROJECT. Deve ser um projeto de propriedade do workspace do usuário autenticado. Após a transferência, o usuário atual perde o acesso a menos que seja concedido explicitamente pelo novo proprietário.
recipientAccessTokenstringSimToken de acesso OAuth2 do usuário destinatário que receberá a propriedade do projeto. Este token deve ser obtido através do fluxo OAuth2 do Prisma para o usuário destinatário. O workspace do destinatário deve ter cota suficiente para receber o projeto. Normalmente usado em integrações de parceiros para transferir bancos de dados provisionados para usuários finais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.