fix(configuration): Add pool and connection object to SQL database de…

…fault configuration (#3023)
feathersjs · Jan 29, 2023 · 092c749 · 092c749
1 parent 3692fd5
commit 092c749
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 2 deletions.
diff --git a/docs/guides/cli/databases.md b/docs/guides/cli/databases.md
@@ -17,6 +17,34 @@ Depending on the SQL database you selected, a `src/<database>.ts` file will be c
 const knex = app.get('<database>Client')
 ```
 
+The database pool size can be set in the [configuration](./default.json.md) like this:
+
+```json
+"postgresql": {
+  "client": "pg",
+  "connection": "<pg connection string>",
+  "pool": {
+    "min": 0,
+    "max": 7
+  }
+},
+```
+
+`connection` can also be an object instead of a connection string:
+
+```json
+"postgresql": {
+  "client": "pg",
+  "connection": {
+    "host": "localhost",
+    "port": 5432,
+    "user": "postgres",
+    "password": "postgres",
+    "database": "pgtest"
+  }
+}
+```
+
 </DatabaseBlock>
 
 <DatabaseBlock global-id="mongodb">

diff --git a/packages/schema/src/default-schemas.ts b/packages/schema/src/default-schemas.ts
@@ -117,7 +117,28 @@ export const sqlSettingsSchema = {
   type: 'object',
   properties: {
     client: { type: 'string' },
-    connection: { type: 'string' }
+    pool: {
+      type: 'object',
+      properties: {
+        min: { type: 'number' },
+        max: { type: 'number' }
+      }
+    },
+    connection: {
+      oneOf: [
+        { type: 'string' },
+        {
+          type: 'object',
+          properties: {
+            host: { type: 'string' },
+            port: { type: 'number' },
+            user: { type: 'string' },
+            password: { type: 'string' },
+            database: { type: 'string' }
+          }
+        }
+      ]
+    }
   }
 } as const
 

diff --git a/packages/typebox/src/default-schemas.ts b/packages/typebox/src/default-schemas.ts
@@ -58,7 +58,24 @@ export const authenticationSettingsSchema = Type.Object({
 export const sqlSettingsSchema = Type.Optional(
   Type.Object({
     client: Type.String(),
-    connection: Type.String()
+    connection: Type.Union([
+      Type.String(),
+      Type.Partial(
+        Type.Object({
+          host: Type.String(),
+          port: Type.Number(),
+          user: Type.String(),
+          password: Type.String(),
+          database: Type.String()
+        })
+      )
+    ]),
+    pool: Type.Optional(
+      Type.Object({
+        min: Type.Number(),
+        max: Type.Number()
+      })
+    )
   })
 )