Add Prisma Postgres Actions for Database Provisioning, Management & Cleanup via Prisma Management API #18092
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
|
@nurul3101 is attempting to deploy a commit to the Pipedreamers Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughAdds a new Prisma Management API integration: introduces an app client with authenticated HTTP helpers and endpoints for projects, databases, connection strings, and regions; adds multiple action modules for create/list/get/delete operations; updates package dependencies; and includes a comprehensive README. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Action
participant AppClient as Prisma App Client
participant PrismaAPI as Prisma Management API
User->>Action: Provide inputs (e.g., projectId, databaseId)
Action->>AppClient: Call method (create/list/get/delete)
AppClient->>PrismaAPI: HTTP request with Bearer token
PrismaAPI-->>AppClient: HTTP response (data/status)
AppClient-->>Action: Response object
Action-->>User: Return response + $summary
sequenceDiagram
participant User
participant CreateProjectAction as Create Postgres Database
participant AppClient
participant PrismaAPI
User->>CreateProjectAction: name, region
CreateProjectAction->>AppClient: createProject({ name, region })
AppClient->>PrismaAPI: POST /projects
PrismaAPI-->>AppClient: { data: { id, database: { id } } }
AppClient-->>CreateProjectAction: response
CreateProjectAction-->>User: $summary with Project ID and Database ID
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Suggested labels
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified. |
|
Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (33)
components/prisma_management_api/README.md (3)
25-31: Tighten wording and avoid hard-coding region listSmall grammar fix and suggest referencing the regions action instead of a static list to prevent drift.
-#### Create Postgres Database -Creates a new Postgres database project via Prisma Management API. This action creates a complete project with database and provides connection string details in the response for immediate use. +#### Create Postgres Database +Creates a new Prisma Postgres project via the Management API. This creates a complete project with a database and provides connection-string details in the response for immediate use. @@ -**Available regions:** us-east-1, us-west-1, eu-west-3, eu-central-1, ap-northeast-1, ap-southeast-1 +Tip: Regions evolve over time. Use the "Get Prisma Postgres Regions" action at runtime to retrieve the latest supported regions.
104-111: Align terminology: “Service Token” vs “API Token” and add minor punctuationUse a single term throughout (Prisma docs use “Service Token”) and add periods for readability.
-This integration uses API Token authentication. You'll need to provide your Prisma Management API Service token when configuring the connection in Pipedream. +This integration uses Service Token authentication. You'll need to provide your Prisma Management API service token when configuring the connection in Pipedream. @@ -To obtain your API token: -1. Log in to your Prisma account -2. Navigate to your workspace settings -3. Generate a new Service Token -4. Copy the token for use in Pipedream +To obtain your service token: +1. Log in to your Prisma account. +2. Navigate to your workspace settings. +3. Generate a new service token. +4. Copy the token for use in Pipedream.
118-126: Minor copy edits in Example WorkflowsAdd punctuation and consistent phrasing.
-Trigger a workflow when a new project is created in your system, automatically provision a Prisma Postgres database, and store the connection details in your configuration management system. +Trigger a workflow when a new project is created in your system, automatically provision a Prisma Postgres database, and store the connection details in your configuration management system. @@ -Schedule periodic cleanup of unused databases and connection strings to maintain security and reduce costs. +Schedule periodic cleanup of unused databases and connection strings to maintain security and reduce costs. @@ -Create databases across multiple regions for improved performance and redundancy based on your application's geographic distribution. +Create databases across multiple regions for improved performance and redundancy, based on your application's geographic distribution.components/prisma_management_api/prisma_management_api.app.mjs (3)
12-21: Avoid defaulting $ to this in _makeRequestDefaulting $ to this is unconventional and could produce confusing logs/metrics. Prefer requiring $ explicitly; callers already pass it.
- _makeRequest({ - $ = this, path, ...args - }) { - return axios($, { - url: `${this._baseUrl()}${path}`, + _makeRequest({ + $, path, ...args + }) { + return axios($, { + url: `${this._baseUrl()}${path}`, headers: { Authorization: `Bearer ${this.$auth.api_token}`, "Content-Type": "application/json", }, ...args, }); },
23-125: URL-encode path parameters to guard against unsafe charactersDefensive encoding prevents accidental breakage if IDs ever contain reserved URL characters.
_baseUrl() { return "https://api.prisma.io/v1"; }, + _segment(v) { + return encodeURIComponent(String(v)); + }, @@ async deleteProject({ projectId, ...args }) { return this._makeRequest({ - path: `/projects/${projectId}`, + path: `/projects/${this._segment(projectId)}`, method: "delete", ...args, }); }, @@ async getProject({ projectId, ...args }) { return this._makeRequest({ - path: `/projects/${projectId}`, + path: `/projects/${this._segment(projectId)}`, method: "get", ...args, }); }, @@ async createDatabase({ projectId, ...args }) { return this._makeRequest({ - path: `/projects/${projectId}/databases`, + path: `/projects/${this._segment(projectId)}/databases`, method: "post", ...args, }); }, @@ async listDatabases({ projectId, ...args }) { return this._makeRequest({ - path: `/projects/${projectId}/databases`, + path: `/projects/${this._segment(projectId)}/databases`, method: "get", ...args, }); }, @@ async getDatabase({ databaseId, ...args }) { return this._makeRequest({ - path: `/databases/${databaseId}`, + path: `/databases/${this._segment(databaseId)}`, method: "get", ...args, }); }, @@ async deleteDatabase({ databaseId, ...args }) { return this._makeRequest({ - path: `/databases/${databaseId}`, + path: `/databases/${this._segment(databaseId)}`, method: "delete", ...args, }); }, @@ async listConnectionStrings({ databaseId, ...args }) { return this._makeRequest({ - path: `/databases/${databaseId}/connections`, + path: `/databases/${this._segment(databaseId)}/connections`, method: "get", ...args, }); }, @@ async createConnectionString({ databaseId, data, ...args }) { return this._makeRequest({ - path: `/databases/${databaseId}/connections`, + path: `/databases/${this._segment(databaseId)}/connections`, method: "post", data: data || {}, ...args, }); }, @@ async deleteConnectionString({ connectionId, ...args }) { return this._makeRequest({ - path: `/connections/${connectionId}`, + path: `/connections/${this._segment(connectionId)}`, method: "delete", ...args, }); },
6-6: Optional: centralize common propDefinitions for reuse across actionsTo reduce duplication and ensure consistent labels/descriptions across actions, consider defining shared props on the app for projectId, databaseId, and connectionId, then reference them in actions via props: { projectId: app.propDefinitions.projectId, ... }.
Example addition to prisma_management_api.app.mjs (outside current changed lines):
propDefinitions: { projectId: { type: "string", label: "Project ID", description: "The Prisma project ID.", }, databaseId: { type: "string", label: "Database ID", description: "The Prisma Postgres database ID.", }, connectionId: { type: "string", label: "Connection ID", description: "The connection string ID.", }, },components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (1)
17-23: Be resilient to response shape and return the payload, not the raw responseAPIs sometimes return arrays directly or nest them (e.g., { regions: [] }). Compute the list defensively and return it to keep step output clean.
- if (response) { - const count = response.data?.length || 0; - $.export("$summary", `Successfully retrieved ${count} available Postgres region${count !== 1 ? "s" : ""}`); - } - - return response; + if (response) { + const items = Array.isArray(response.data) + ? response.data + : (response.data?.regions || []); + const count = Array.isArray(items) ? items.length : 0; + $.export("$summary", `Successfully retrieved ${count} available Postgres region${count !== 1 ? "s" : ""}`); + return items; + } + return response;components/prisma_management_api/actions/get-database-details/get-database-details.mjs (2)
4-8: Polish name/description for consistency and clarityTitle-case “Details” and tighten the description.
- name: "Get Database details", + name: "Get Database Details", @@ - description: "Get database details of a particular Prisma Postgres database via Prisma Management API. [See docs here](https://www.prisma.io/docs/postgres/introduction/management-api)", + description: "Retrieve details for a Prisma Postgres database via the Prisma Management API. [See docs here](https://www.prisma.io/docs/postgres/introduction/management-api)",
23-28: Return response payload instead of the entire HTTP responseReturning response.data keeps step output clean and consistent.
- return response; + return response?.data ?? response;components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (2)
23-25: Export summary unconditionally after a successful await.If the HTTP client throws on non-2xx, this code path won’t run anyway. The extra condition can hide success summaries if the client returns
undefinedfor 204 responses. Simplify by exporting the summary after the await.Apply this diff:
- if (response || response === null) { - $.export("$summary", `Successfully deleted database with ID ${this.databaseId}`); - } + $.export("$summary", `Successfully deleted database with ID ${this.databaseId}`);
27-31: Consider standardizing return shapes across actions.Some actions return the raw API response, others return a
{ success, id, message }object. Standardizing improves DX for workflows that chain multiple actions.components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
7-7: Description claims pagination support but no pagination is exposed.Currently there are no pagination props or logic passed to
listProjects. Either add pagination props (e.g., cursor/page, limit) and wire them through, or adjust the description to avoid implying pagination.Apply this minimal description fix if you prefer not to add props now:
- description: "List Projects in a Prisma Workspace via Prisma Management API. Supports pagination for large result sets. [See docs here](https://www.prisma.io/docs/postgres/introduction/management-api)", + description: "List Projects in a Prisma Workspace via Prisma Management API. [See docs here](https://www.prisma.io/docs/postgres/introduction/management-api)",components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (2)
23-25: Export summary unconditionally after a successful await.Same reasoning as other delete actions: if the API call fails it will throw. Exporting the summary unconditionally avoids edge cases where clients return
undefinedfor 204 responses.Apply this diff:
- if (response || response === null) { - $.export("$summary", `Successfully deleted database connection with ID ${this.connectionId}`); - } + $.export("$summary", `Successfully deleted database connection with ID ${this.connectionId}`);
27-31: Tighten message wording to “connection string” for clarity.Minor copy nit to match the action name and avoid ambiguity with other connection objects.
Apply this diff:
- message: "Database connection deleted successfully", + message: "Database connection string deleted successfully",components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (2)
20-29: Consider dynamic region options sourced from the API.Hardcoding regions can drift from reality. Prefer populating options from
listRegionsto ensure accuracy and better UX.Two approaches:
- Define a propDefinition in the app with dynamic options and reference it here.
- Or implement a dynamic
optionsfunction that queriesthis.app.listRegionsand returns{ label, value }pairs.Happy to provide a concrete snippet if you share the app’s propDefinition patterns.
55-56: Align return shape with other actions for consistency.This action returns the raw response, while delete actions return a
{ success, id, message }object. Consider standardizing across the suite (either always raw response or always a normalized object plus raw under a key).components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (2)
23-25: Export summary unconditionally after a successful await.Mirror the simplification suggested for the other delete actions to avoid missing summaries on 204/empty responses.
Apply this diff:
- if (response || response === null) { - $.export("$summary", `Successfully deleted Postgres database project with ID ${this.projectId}`); - } + $.export("$summary", `Successfully deleted Postgres database project with ID ${this.projectId}`);
11-15: Optional: Provide dynamic options for selecting a project.To reduce copy/paste of IDs, consider a dynamic options prop that lists projects (via
listProjects) so users can pick a project by name in the UI.components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (2)
11-16: Consider dynamic projectId via propDefinition for UXLeverage a propDefinition (backed by listProjects) so users can pick a project from a dropdown instead of pasting IDs.
Apply this diff if
projectIdpropDefinition exists in the app:- projectId: { - type: "string", - label: "Project ID", - description: "The ID of the project to list databases from", - }, + projectId: { + propDefinition: [app, "projectId"], + description: "Select the project to list databases from", + },If you don't have it yet, add to
prisma_management_api.app.mjs:// Inside export default { ... app ... } propDefinitions: { projectId: { type: "string", label: "Project", description: "Select a Prisma project", async options({ $ }) { const res = await this.listProjects({ $ }); const items = res?.data ?? []; return items.map((p) => ({ label: `${p.name} (${p.id})`, value: p.id })); }, }, },
23-26: Make summary resilient to varied response shapesIf your app client ever returns arrays at the top level (vs under
data), count can be wrong.Apply:
- const count = response.data?.length || 0; + const items = Array.isArray(response?.data) ? response.data : (Array.isArray(response) ? response : []); + const count = items.length;components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (3)
11-16: Enable databaseId selection via propDefinitionImprove DX by letting users select a database from a list (backed by listDatabases).
- databaseId: { - type: "string", - label: "Database ID", - description: "The ID of the database to create a connection string for", - }, + databaseId: { + propDefinition: [app, "databaseId"], + description: "Select the database to create a connection string for", + },Add to
prisma_management_api.app.mjsif missing:propDefinitions: { // ...projectId as shown earlier... databaseId: { type: "string", label: "Database", description: "Select a database within a project", async options({ $ }) { // Optionally gate by selected projectId from other props // e.g. const { projectId } = this; // const res = await this.listDatabases({ $, projectId }); // If no projectId context, fetch recently used or all (if API supports). return []; }, }, },
31-33: Use robust ID fallback in summaryThe ID may come as
response.idorresponse.data.iddepending on the app client shape.- $.export("$summary", `Successfully created connection string for database ${this.databaseId}${response.id ? ` with connection ID ${response.id}` : ""}`); + const id = response?.id ?? response?.data?.id; + $.export("$summary", `Successfully created connection string for database ${this.databaseId}${id ? ` with connection ID ${id}` : ""}`);
35-36: Be mindful of returning secrets in step outputCreating a connection string may return the raw DSN with credentials. Returning the full response is often desired, but it can expose secrets in step results. Consider a boolean prop to control whether to return the raw string or to return only metadata by default.
I can draft a small change to add a
returnConnectionStringboolean (default false) and conditionally filter the returned payload.components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (3)
11-15: Tighten copy and enable dynamic selection
- Wording: use “connection strings” for clarity.
- Prefer
propDefinitionfordatabaseIdto enable dropdown selection.- databaseId: { - type: "string", - label: "Database ID", - description: "The ID of the database to list connections for", - }, + databaseId: { + propDefinition: [app, "databaseId"], + description: "The database to list connection strings for", + },
23-26: Defensive count calc across response shapesMirror the pattern suggested in the other list action for resilience.
- const count = response.data?.length || 0; + const items = Array.isArray(response?.data) ? response.data : (Array.isArray(response) ? response : []); + const count = items.length;
17-21: Implement pagination forlistConnectionStringsThe
listConnectionStringshelper in
•components/prisma_management_api/prisma_management_api.app.mjs(around lines 91–94)
currently just calls_makeRequestwith no loop over anextLink, so it will only return the first page of results. Likewise, the action in
•components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs(lines 17–21)
simply forwards that call, without handling pagination.Please update the wrapper (or the action) to:
- Detect and follow a
nextLink(or equivalent pagination token) in the response, aggregating all pages before returning.- Or expose standard paging controls (e.g.,
top,skipToken) so callers can request subsequent pages as needed.components/prisma_management_api/actions/get-project-details/get-project-details.mjs (3)
4-4: Title case the action name for consistencyMinor naming nit.
- name: "Get Project details", + name: "Get Project Details",
11-16: Use propDefinition for project selectionImproves UX by letting users select a project from a list.
- projectId: { - type: "string", - label: "Project ID", - description: "The ID of the project to retrieve information for", - }, + projectId: { + propDefinition: [app, "projectId"], + description: "Select the project to retrieve information for", + },
23-25: Enrich summary with project name when availableSmall UX win.
- $.export("$summary", `Successfully retrieved project information for ID ${this.projectId}`); + const name = response?.name ?? response?.data?.name; + $.export("$summary", `Successfully retrieved project ${name ? `"${name}"` : `ID ${this.projectId}`}`);components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (4)
10-16: Adopt propDefinition for projectIdFacilitates selection from workspace projects.
- projectId: { - type: "string", - label: "Project ID", - description: "The ID of the project where the database should be created", - }, + projectId: { + propDefinition: [app, "projectId"], + description: "Select the project where the database should be created", + },
16-29: Prefer dynamic region options from API instead of hardcodingRegions can change; fetch dynamically via
listRegions. If you have aregionpropDefinition in the app, use that; otherwise add an async options function.Option A (propDefinition):
- region: { - type: "string", - label: "Region", - description: "The AWS region where the database should be created", - options: [ - "us-east-1", - "us-west-1", - "eu-west-3", - "eu-central-1", - "ap-northeast-1", - "ap-southeast-1", - ], - optional: true, - }, + region: { + propDefinition: [app, "region"], + optional: true, + description: "Select the region for the new database", + },Add to
prisma_management_api.app.mjsif missing:propDefinitions: { // ... region: { type: "string", label: "Region", description: "Select a Prisma Postgres region", async options({ $ }) { const res = await this.listRegions({ $ }); const items = res?.data ?? []; return items.map((r) => ({ label: `${r.name} (${r.id})`, value: r.id })); }, }, },Option B (inline async options if you prefer not to touch the app yet):
- region: { - type: "string", - label: "Region", - description: "The AWS region where the database should be created", - options: [ - "us-east-1", - "us-west-1", - "eu-west-3", - "eu-central-1", - "ap-northeast-1", - "ap-southeast-1", - ], - optional: true, - }, + region: { + type: "string", + label: "Region", + description: "Select the region for the new database", + optional: true, + async options({ $ }) { + const res = await app.listRegions({ $ }); + const items = res?.data ?? []; + return items.map((r) => ({ label: `${r.name} (${r.id})`, value: r.id })); + }, + },
39-42: Slightly cleaner payload constructionMinor readability improvement using object spread.
- const data = {}; - if (this.region) data.region = this.region; - if (this.isDefault !== undefined) data.default = this.isDefault; + const data = { + ...(this.region && { region: this.region }), + ...(this.isDefault !== undefined && { default: this.isDefault }), + };
49-51: Use robust ID fallback in summaryMirror the ID fallback used elsewhere.
- $.export("$summary", `Successfully created database in project ${this.projectId}${response.id ? ` with ID ${response.id}` : ""}`); + const id = response?.id ?? response?.data?.id; + $.export("$summary", `Successfully created database in project ${this.projectId}${id ? ` with ID ${id}` : ""}`);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (15)
components/prisma_management_api/README.md(1 hunks)components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs(1 hunks)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs(1 hunks)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs(1 hunks)components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs(1 hunks)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs(1 hunks)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs(1 hunks)components/prisma_management_api/actions/get-database-details/get-database-details.mjs(1 hunks)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs(1 hunks)components/prisma_management_api/actions/get-project-details/get-project-details.mjs(1 hunks)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs(1 hunks)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs(1 hunks)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs(1 hunks)components/prisma_management_api/package.json(1 hunks)components/prisma_management_api/prisma_management_api.app.mjs(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-12-12T19:23:09.039Z
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.
Applied to files:
components/prisma_management_api/package.json
🧬 Code Graph Analysis (13)
components/prisma_management_api/actions/get-database-details/get-database-details.mjs (10)
components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
response(23-29)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
response(32-38)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (1)
response(13-15)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
response(18-21)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (1)
response(18-21)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
response(13-15)
components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (11)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
response(23-29)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (1)
response(13-15)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
response(18-21)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (1)
response(18-21)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
response(13-15)
components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (4)
components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
response(18-21)
components/prisma_management_api/prisma_management_api.app.mjs (2)
components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (2)
projectId(41-41)databaseId(42-42)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
data(39-39)
components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (11)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
response(23-29)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
response(32-38)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (1)
response(13-15)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
response(18-21)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (1)
response(18-21)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
response(13-15)
components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (11)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
response(23-29)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
response(32-38)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (2)
response(18-21)count(24-24)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (2)
response(18-21)count(24-24)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (2)
response(13-15)count(18-18)
components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (9)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
response(32-38)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (1)
response(13-15)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
response(18-21)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (1)
response(18-21)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
response(13-15)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (4)
components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (1)
response(18-21)
components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (8)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
response(32-38)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (2)
response(13-15)count(18-18)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (2)
response(18-21)count(24-24)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (2)
response(13-15)count(18-18)
components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (11)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
response(23-29)components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
response(43-47)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
response(32-38)components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (1)
response(18-21)components/prisma_management_api/actions/get-project-details/get-project-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (2)
response(13-15)count(18-18)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (2)
response(18-21)count(24-24)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (2)
response(13-15)count(18-18)
components/prisma_management_api/actions/get-project-details/get-project-details.mjs (5)
components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/get-postgres-regions/get-postgres-regions.mjs (1)
response(13-15)components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (1)
response(18-21)components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
response(13-15)
components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (5)
components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
response(18-21)components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
response(23-29)components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
response(18-21)components/prisma_management_api/actions/get-database-details/get-database-details.mjs (1)
response(18-21)components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
response(18-21)
components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (2)
response(18-21)count(24-24)
🪛 LanguageTool
components/prisma_management_api/README.md
[grammar] ~25-~25: There might be a mistake here.
Context: ... This action creates a complete project with database and provides connection string...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ... #### List Projects in Prisma Workspace Retrieves all projects within your Prism...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...sma workspace. #### Get Project Details Retrieves detailed information about a s...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ... retrieve #### Delete Postgres Database Removes an entire Postgres database proj...
(QB_NEW_EN)
[grammar] ~50-~50: There might be a mistake here.
Context: ... Create New Database in Existing Project Adds a new database to an existing Prism...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...roject #### List Databases from Project Retrieves all databases within a specifi...
(QB_NEW_EN)
[grammar] ~64-~64: There might be a mistake here.
Context: ...f the project #### Get Database Details Retrieves detailed information about a s...
(QB_NEW_EN)
[grammar] ~70-~70: There might be a mistake here.
Context: ...ase #### Delete Database by Database ID Removes a specific database by its ID. ...
(QB_NEW_EN)
[grammar] ~78-~78: There might be a mistake here.
Context: ... #### Create Database Connection String Generates a new connection string for da...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...n #### List Database Connection Strings Retrieves all connection strings for a s...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ... #### Delete Database Connection String Removes a specific connection string. *...
(QB_NEW_EN)
[grammar] ~99-~99: There might be a mistake here.
Context: ...lities #### Get Prisma Postgres Regions Retrieves the list of available regions ...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ...in Pipedream. To obtain your API token: 1. Log in to your Prisma account 2. Navigat...
(QB_NEW_EN)
[grammar] ~118-~118: There might be a mistake here.
Context: ...utomated Database Setup for New Projects Trigger a workflow when a new project is...
(QB_NEW_EN)
[grammar] ~121-~121: There might be a mistake here.
Context: ...system. ### Database Cleanup Automation Schedule periodic cleanup of unused data...
(QB_NEW_EN)
[grammar] ~124-~124: There might be a mistake here.
Context: ...s. ### Multi-Region Database Deployment Create databases across multiple regions...
(QB_NEW_EN)
🔇 Additional comments (15)
components/prisma_management_api/package.json (2)
15-17: Dependency addition looks goodAdding "@pipedream/platform": "^1.5.1" is appropriate for Pipedream actions, and you avoided adding Node built-ins as deps (per our past guidance). JSON structure is valid with the trailing comma after publishConfig.
15-17: Confirm Pipedream Platform Version AlignmentI scanned every
package.jsonand found that:
- components/prisma_management_api/package.json and the repo root use ^1.5.1
- The majority of components have migrated to ^3.x
- Several others are still on ^2.x, ^0.x or various patch versions
Such a spread of major versions can lead to subtle runtime and API differences. Please review whether this package should stay on v1, or be bumped to align with the current stable major across the repo—and then update its
"@pipedream/platform"range accordingly.components/prisma_management_api/README.md (1)
31-31: Region list verified
The explicit list in components/prisma_management_api/README.md (line 31) matches the Prisma Postgres regions documented as of August 18, 2025.(Optional) For future-proofing, consider calling the Management API endpoint GET /regions/postgres to retrieve this list programmatically.
components/prisma_management_api/prisma_management_api.app.mjs (1)
8-11: Confirmed Prisma Management API Base URLThe base URL and version (
https://api.prisma.io/v1) are correct for endpoints like/projects,/databases,/connections, and/regions/postgres. No changes required.components/prisma_management_api/actions/delete-database-by-database-id/delete-database-by-database-id.mjs (1)
1-16: Solid action metadata and props.Name, key, description, and props follow Pipedream conventions and clearly convey the destructive nature of the operation.
components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs (1)
12-16: LGTM: clear run flow and concise summary.The call to
this.app.listProjectsand the summary export are consistent with other actions. Returning the raw response is appropriate if callers need full metadata.Also applies to: 22-23
components/prisma_management_api/actions/delete-database-connection-string/delete-database-connection-string.mjs (2)
3-16: Well-defined destructive action and props.Naming, description, and the
connectionIdprop are clear and consistent with the rest of the suite.
17-21: Parameter name verified
ThedeleteConnectionStringmethod inprisma_management_api.app.mjsis declared as:async deleteConnectionString({ connectionId, ...args }) { … }so passing
connectionId: this.connectionIdis correct. No changes needed.components/prisma_management_api/actions/create-postgres-database/create-postgres-database.mjs (1)
40-53: Nice summary assembly with conditional IDs.Building a clear $summary that includes discovered IDs is helpful for users scanning step results.
components/prisma_management_api/actions/delete-postgres-database/delete-postgres-database.mjs (1)
1-16: Clear destructive action with accurate labeling.Action metadata, prop definition, and description align with the create/list/get counterparts.
components/prisma_management_api/actions/list-databases-from-project/list-databases-from-project.mjs (2)
3-16: Solid action scaffold and consistent metadataNaming, key, description, and props structure align well with other actions in this suite.
17-21: Verify cursor-based pagination for listDatabasesI didn’t see any pagination logic in the
listDatabasesimplementation—it simply forwardsprojectId(and any extra args) to_makeRequest. If the Management API paginates, this action will return only the first page. Please:
- Confirm whether
this.app.listDatabasessupports pagination parameters (e.g.cursor,limit,page, etc.).- If it does, update the action to loop through all pages (e.g. calling
listDatabaseswith the returned cursor until no more pages).- If it doesn’t paginate (all results are returned at once), add a note in the docs or code comment to affirm no pagination is needed.
Also applies to the similar calls in lines 28–29 of the same file.
components/prisma_management_api/actions/create-database-connection-string/create-database-connection-string.mjs (1)
3-21: Good, follows the established action patternClear props and description; run implementation matches the app method contract used elsewhere.
components/prisma_management_api/actions/list-database-connection-strings/list-database-connection-strings.mjs (1)
3-16: Consistent list action implementationStructure, metadata, and call pattern are consistent with the rest of the actions.
components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs (1)
3-9: Well-structured action and clear descriptionThe action follows the established pattern and is easy to follow.
| async run({ $ }) { | ||
| const data = {}; | ||
| if (this.region) data.region = this.region; | ||
| if (this.isDefault !== undefined) data.default = this.isDefault; | ||
|
|
||
| const response = await this.app.createDatabase({ | ||
| $, | ||
| projectId: this.projectId, | ||
| data, | ||
| }); |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Confirm whether region is required by the API
If region is mandatory for creating a DB in an existing project, mark it required. If not, current optional behavior is fine.
I can update the prop to be required and adjust copy accordingly if the API mandates it. To check the app method and docs quickly:
Also applies to: 53-54
🏁 Script executed:
#!/bin/bash
# Look for createDatabase implementation and payload expectations
rg -n -C3 'createDatabase\s*\(' components/prisma_management_api/prisma_management_api.app.mjsLength of output: 245
🌐 Web query:
Does the Prisma Data Platform Management API require a "region" parameter when creating a new database via the createDatabase endpoint?
💡 Result:
The Prisma Data Platform Management API does require a "region" parameter when creating a new database via the createDatabase endpoint (or when creating a project with a database). This is evident from multiple official and practical code examples:
-
The [Prisma Management API guide][5] demonstrates a code sample where
regionis explicitly included in the request payload for creating a project (which triggers default database creation):const createProjectRes = await axios.post( `${API_URL}/projects`, { name: projectName, region }, // region is required here { headers } );
Omitting the
regionwould likely cause the API to reject the request or default to a region based on other context, but the documented examples always specify it[5]. -
The [official API documentation and partner provisioning guide][9] emphasize sending a "database provisioning request," but do not explicitly show omission of the region, and all public guides and CLI flows for provisioning (such as
npx create-db) always prompt for and include a region parameter[9].
No evidence from the documentation or reference implementations suggests that the region parameter is optional for this endpoint.
Summary:
The "region" parameter is required when creating a database with the Prisma Management API's createDatabase (or project creation) endpoint[5][9].
References:
[5] Prisma Management API "Programmatically create a new project with a database" (code sample shows required region)
[9] Partner Database Provisioning docs (further conceptual and process details, always includes region in practical flows)
Citations:
- 1: https://www.youtube.com/watch?v=j81bcq0_fy0
- 2: https://betterstack.com/community/guides/scaling-nodejs/prisma-orm/
- 3: https://docs.paloaltonetworks.com/prisma/prisma-access/preferred/2-2/prisma-access-panorama-admin/prisma-access-overview/prisma-access-apis
- 4: https://blog.tericcabrel.com/rest-api-nodejs-prisma-planetscale/
- 5: https://www.prisma.io/docs/guides/management-api-basic
- 6: https://www.prisma.io/blog/nestjs-prisma-rest-api-7D056s1BmOL0
- 7: https://docs.prismacloud.io/en/enterprise-edition/content-collections/data-security-posture-management/api-documentation/authenticate-and-call-your-first-api
- 8: https://docs.aws.amazon.com/pdfs/security-lake/latest/userguide/security-lake-userguide.pdf
- 9: https://www.prisma.io/docs/guides/management-api
- 10: https://devblogs.microsoft.com/azure-sql/modern-application-development-with-prisma-graphql-rest-and-azure-sql/
Make region input required
The Prisma Data Platform Management API mandates a region parameter when creating a new database. Please update the action’s input schema and docs accordingly.
- In
components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs, markregionas required:inputs: { - region: { type: 'string', description: 'Region for the new database' },
- region: {
-
type: 'string', -
description: 'Region for the new database (required by the API)', -
required: true, - },
…
}
- Update any related usage examples or README entries to indicate that `region` is now mandatory.
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
// In components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs
export default {
// … other top-level properties …
inputs: {
region: {
type: 'string',
description: 'Region for the new database (required by the API)',
required: true,
},
// …other inputs (projectId, isDefault, etc.)…
},
async run({ $ }) {
const data = {};
// `region` is now guaranteed to be present
data.region = this.region;
if (this.isDefault !== undefined) data.default = this.isDefault;
const response = await this.app.createDatabase({
$,
projectId: this.projectId,
data,
});
// …
},
};
🤖 Prompt for AI Agents
In
components/prisma_management_api/actions/create-new-database-in-existing-project/create-new-database-in-existing-project.mjs
around lines 38 to 47, the action currently treats region as optional but the
Prisma Data Platform requires region when creating a database; update the
action's input schema to mark region as required (remove optional flag/undefined
checks), ensure the runtime no longer skips setting region (validate/panic if
missing), and update any related usage examples and README entries to document
that region is a mandatory input and show an example value and format.
There was a problem hiding this comment.
I'll push a commit to address the feedback.
There was a problem hiding this comment.
@nurul3101 Perfect! Thank you for confirming you'll address the region parameter requirement. Looking forward to seeing the updated commit that makes region a required input for the database creation action.
| if (response) { | ||
| const count = response.data?.length || 0; | ||
| $.export("$summary", `Successfully retrieved ${count} project${count !== 1 ? "s" : ""}`); | ||
| } |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify shape of response.data to avoid incorrect counts.
Assumes response.data is an array. If the app client returns { data: { items: [] } } or another shape, count will be wrong.
Run this script to inspect the listProjects implementation and confirm the response shape:
🏁 Script executed:
#!/bin/bash
# Find and show the listProjects method to confirm returned shape
rg -n -C3 'listProjects\s*\(' components/prisma_management_api/prisma_management_api.app.mjs || true
# Also search for the response handling pattern inside the app
rg -n -C3 'listProjects' components/prisma_management_api/prisma_management_api.app.mjs || trueLength of output: 530
🏁 Script executed:
#!/bin/bash
# Locate and display the full _makeRequest implementation to verify the shape of the returned payload
rg -n -C5 'async _makeRequest' components/prisma_management_api/prisma_management_api.app.mjs || trueLength of output: 102
🏁 Script executed:
#!/bin/bash
# Display the top of the SDK file to locate _makeRequest or its import
sed -n '1,100p' components/prisma_management_api/prisma_management_api.app.mjs
# Search the entire repo for the _makeRequest implementation
rg -n '_makeRequest' -C5 .Length of output: 312673
Fix response-shape assumption in list-projects-in-prisma-workspace
Brief: Confirmed — prisma_management_api._makeRequest returns axios($, {...}) with no returnFullResponse, so callers typically get the response body directly. The action currently assumes a full axios response (response.data), which will make the count incorrect.
Files to update:
- components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs — lines shown in PR (uses response.data?.length).
- components/prisma_management_api/prisma_management_api.app.mjs — methods._makeRequest (returns axios(...), i.e. the body by default).
Suggested replacement (handle both possible shapes):
if (response) {
const items = Array.isArray(response)
? response
: Array.isArray(response?.data)
? response.data
: [];
const count = items.length;
$.export("$summary", `Successfully retrieved ${count} project${count !== 1 ? "s" : ""}`);
}
🤖 Prompt for AI Agents
In
components/prisma_management_api/actions/list-projects-in-prisma-workspace/list-projects-in-prisma-workspace.mjs
around lines 17 to 20, the code assumes response is a full axios response and
uses response.data?.length which is incorrect because _makeRequest returns the
response body by default; update the logic to normalize both shapes by
extracting items as: if response is an array use it, else if response.data is an
array use that, otherwise use an empty array, then compute count = items.length
and export the summary using that count.
There was a problem hiding this comment.
I'll push a commit to address the feedback.
There was a problem hiding this comment.
@nurul3101 Perfect! Thank you for confirming you'll address the response shape issue. The suggested normalization logic will handle both possible response formats correctly and ensure accurate project counts in the summary.
Hi Pipedream team! 👋
I'm from the Prisma team. This PR adds actions that allows users to automate Prisma Postgres database provisioning, management, and cleanup directly within their Pipedream workflows.
Here are the actions:
All actions have been tested and documented following Pipedream's component guidelines.
Please let me know if any changes are needed from our end.
Thank you!
Summary by CodeRabbit