> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Prisma

> Prisma Data Platform provides database tools including Accelerate (global database cache), Optimize (AI-driven query analysis), and Prisma Postgres (managed PostgreSQL)

Prisma Data Platform provides database tools including Accelerate (global database cache), Optimize (AI-driven query analysis), and Prisma Postgres (managed PostgreSQL). Manage workspaces, projects, environments, and API keys programmatically.

`prisma` · **22 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth prisma
run auth prisma --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run prisma          # common commands
run prisma --all    # every command
```

```ts theme={"theme":"github-dark"}
import { prisma } from "@boxd/run";
```

## Common tools

| Tool                          | What it does                                                                                                                                                         |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `create-connection`           | Create new API key connection for database access. Creates connection string with embedded credentials for application database access.                              |
| `create-database`             | Create new postgres database in an existing Prisma project. Creates database in specified region with connection strings and API keys.                               |
| `create-project`              | Create new Prisma project with managed postgres database. Creates project in authenticated user's workspace with postgres database in specified region.              |
| `execute-sql-command`         | Execute SQL commands that modify database data or structure.                                                                                                         |
| `execute-sql-query`           | Execute SQL SELECT queries against Prisma Postgres databases.                                                                                                        |
| `get-database`                | Retrieve specific Prisma database by ID. Returns database details including status, project context, and regional deployment.                                        |
| `get-database-usage`          | Retrieve usage metrics for a specific Prisma database. Returns metrics including storage usage and operation counts (reads/writes) for the specified time period.    |
| `get-project`                 | Retrieve specific Prisma project by ID. Returns project details including name, creation timestamp, and workspace information.                                       |
| `inspect-database-schema`     | Inspect database schema structure and table information. Returns comprehensive schema details including tables, columns, data types, constraints, and relationships. |
| `list-accelerate-regions`     | Retrieve all available regions for Prisma Accelerate. Returns regions where Accelerate global database cache can be deployed.                                        |
| `list-backups`                | Retrieve list of available backups for a specific database. Returns backup details including status, size, type, and restoration readiness.                          |
| `list-connections`            | Retrieve paginated list of connections for a specific database.                                                                                                      |
| `list-databases`              | Retrieve paginated list of databases for a specific Prisma project.                                                                                                  |
| `list-postgres-regions`       | Retrieve all available regions for Prisma Postgres. Returns regions where Prisma Postgres databases can be deployed with current availability status.                |
| `list-projects`               | Retrieve paginated list of Prisma projects accessible to authenticated user.                                                                                         |
| `list-workspace-integrations` | Retrieve paginated list of integrations for a specific Prisma workspace.                                                                                             |
| `list-workspaces`             | Retrieve paginated list of Prisma workspaces accessible to authenticated user.                                                                                       |
| `restore-backup`              | Restore database backup to new database instance. Creates new database from existing backup with specified name.                                                     |
| `transfer-project`            | Transfer Prisma project ownership to another user's workspace.                                                                                                       |

<Accordion title="All 22 tools" icon="list">
  | Tool                          | What it does                                                                                                                                                         |
  | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `create-connection`           | Create new API key connection for database access. Creates connection string with embedded credentials for application database access.                              |
  | `create-database`             | Create new postgres database in an existing Prisma project. Creates database in specified region with connection strings and API keys.                               |
  | `create-project`              | Create new Prisma project with managed postgres database. Creates project in authenticated user's workspace with postgres database in specified region.              |
  | `delete-connection`           | Permanently delete database connection and revoke API key access.                                                                                                    |
  | `delete-database`             | Permanently delete Prisma database and all stored data. WARNING: This action cannot be undone.                                                                       |
  | `delete-project`              | Permanently delete Prisma project and all associated resources.                                                                                                      |
  | `execute-sql-command`         | Execute SQL commands that modify database data or structure.                                                                                                         |
  | `execute-sql-query`           | Execute SQL SELECT queries against Prisma Postgres databases.                                                                                                        |
  | `get-database`                | Retrieve specific Prisma database by ID. Returns database details including status, project context, and regional deployment.                                        |
  | `get-database-usage`          | Retrieve usage metrics for a specific Prisma database. Returns metrics including storage usage and operation counts (reads/writes) for the specified time period.    |
  | `get-project`                 | Retrieve specific Prisma project by ID. Returns project details including name, creation timestamp, and workspace information.                                       |
  | `inspect-database-schema`     | Inspect database schema structure and table information. Returns comprehensive schema details including tables, columns, data types, constraints, and relationships. |
  | `list-accelerate-regions`     | Retrieve all available regions for Prisma Accelerate. Returns regions where Accelerate global database cache can be deployed.                                        |
  | `list-backups`                | Retrieve list of available backups for a specific database. Returns backup details including status, size, type, and restoration readiness.                          |
  | `list-connections`            | Retrieve paginated list of connections for a specific database.                                                                                                      |
  | `list-databases`              | Retrieve paginated list of databases for a specific Prisma project.                                                                                                  |
  | `list-postgres-regions`       | Retrieve all available regions for Prisma Postgres. Returns regions where Prisma Postgres databases can be deployed with current availability status.                |
  | `list-projects`               | Retrieve paginated list of Prisma projects accessible to authenticated user.                                                                                         |
  | `list-workspace-integrations` | Retrieve paginated list of integrations for a specific Prisma workspace.                                                                                             |
  | `list-workspaces`             | Retrieve paginated list of Prisma workspaces accessible to authenticated user.                                                                                       |
  | `restore-backup`              | Restore database backup to new database instance. Creates new database from existing backup with specified name.                                                     |
  | `transfer-project`            | Transfer Prisma project ownership to another user's workspace.                                                                                                       |
</Accordion>

[Open Prisma in the console →](https://app.boxd.sh/integrations/detail/prisma)
