chore: add comment about closing PrismaClient and Connector (#353)

GoogleCloudPlatform · May 28, 2024 · d6d653e · d6d653e
1 parent dc7e0d0
commit d6d653e
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 0 deletions.
diff --git a/examples/prisma/mysql/connect.cjs b/examples/prisma/mysql/connect.cjs
@@ -29,6 +29,9 @@ async function connect({instanceConnectionName, user, database}) {
   const datasourceUrl = `mysql://${user}@localhost/${database}?socket=${path}`;
   const prisma = new PrismaClient({datasourceUrl});
 
+  // Return PrismaClient and close() function. Call close() when you are
+  // done using the PrismaClient to ensure client gracefully disconnects and
+  // local Unix socket file created by the Connector is deleted.
   return {
     prisma,
     async close() {

diff --git a/examples/prisma/mysql/connect.mjs b/examples/prisma/mysql/connect.mjs
@@ -29,6 +29,9 @@ export async function connect({instanceConnectionName, user, database}) {
   const datasourceUrl = `mysql://${user}@localhost/${database}?socket=${path}`;
   const prisma = new PrismaClient({datasourceUrl});
 
+  // Return PrismaClient and close() function. Call close() when you are
+  // done using the PrismaClient to ensure client gracefully disconnects and
+  // local Unix socket file created by the Connector is deleted.
   return {
     prisma,
     async close() {

diff --git a/examples/prisma/mysql/connect.ts b/examples/prisma/mysql/connect.ts
@@ -33,6 +33,9 @@ export async function connect({instanceConnectionName, user, database}) {
   const datasourceUrl = `mysql://${user}@localhost/${database}?socket=${path}`;
   const prisma = new PrismaClient({datasourceUrl});
 
+  // Return PrismaClient and close() function. Call close() when you are
+  // done using the PrismaClient to ensure client gracefully disconnects and
+  // local Unix socket file created by the Connector is deleted.
   return {
     prisma,
     async close() {

diff --git a/examples/prisma/postgresql/connect.cjs b/examples/prisma/postgresql/connect.cjs
@@ -32,6 +32,9 @@ async function connect({instanceConnectionName, user, database}) {
   const datasourceUrl = `postgresql://${user}@localhost/${database}?host=${process.cwd()}`;
   const prisma = new PrismaClient({datasourceUrl});
 
+  // Return PrismaClient and close() function. Call close() when you are
+  // done using the PrismaClient to ensure client gracefully disconnects and
+  // local Unix socket file created by the Connector is deleted.
   return {
     prisma,
     async close() {

diff --git a/examples/prisma/postgresql/connect.mjs b/examples/prisma/postgresql/connect.mjs
@@ -32,6 +32,9 @@ export async function connect({instanceConnectionName, user, database}) {
   const datasourceUrl = `postgresql://${user}@localhost/${database}?host=${process.cwd()}`;
   const prisma = new PrismaClient({datasourceUrl});
 
+  // Return PrismaClient and close() function. Call close() when you are
+  // done using the PrismaClient to ensure client gracefully disconnects and
+  // local Unix socket file created by the Connector is deleted.
   return {
     prisma,
     async close() {

diff --git a/examples/prisma/postgresql/connect.ts b/examples/prisma/postgresql/connect.ts
@@ -36,6 +36,9 @@ export async function connect({instanceConnectionName, user, database}) {
   const datasourceUrl = `postgresql://${user}@localhost/${database}?host=${process.cwd()}`;
   const prisma = new PrismaClient({datasourceUrl});
 
+  // Return PrismaClient and close() function. Call close() when you are
+  // done using the PrismaClient to ensure client gracefully disconnects and
+  // local Unix socket file created by the Connector is deleted.
   return {
     prisma,
     async close() {