feat(types): add includeArrayTypes param

By default `/types` doesn't return array types like `int8[]`, `text[]`,
etc. This flag lets it include array types to help the typegen associate
type OIDs with type names.

Author: soedirgo

src/lib/PostgresMetaTypes.ts

@@ -11,23 +11,35 @@ export default class PostgresMetaTypes {
   }
 
   async list({
+    includeArrayTypes = false,
     includeSystemSchemas = false,
     limit,
     offset,
   }: {
+    includeArrayTypes?: boolean
     includeSystemSchemas?: boolean
     limit?: number
     offset?: number
   } = {}): Promise<PostgresMetaResult<PostgresType[]>> {
     let sql = typesSql
+    if (!includeArrayTypes) {
+      sql += ` and not exists (
+                 select
+                 from
+                   pg_type el
+                 where
+                   el.oid = t.typelem
+                   and el.typarray = t.oid
+               )`
+    }
     if (!includeSystemSchemas) {
-      sql = `${sql} AND NOT (n.nspname IN (${DEFAULT_SYSTEM_SCHEMAS.map(literal).join(',')}))`
+      sql += ` and n.nspname not in (${DEFAULT_SYSTEM_SCHEMAS.map(literal).join(',')})`
     }
     if (limit) {
-      sql = `${sql} LIMIT ${limit}`
+      sql += ` limit ${limit}`
     }
     if (offset) {
-      sql = `${sql} OFFSET ${offset}`
+      sql += ` offset ${offset}`
     }
     return await this.query(sql)
   }

src/lib/sql/types.sql

@@ -31,12 +31,3 @@ WHERE
         c.oid = t.typrelid
     )
   )
-  AND NOT EXISTS (
-    SELECT
-      1
-    FROM
-      pg_type el
-    WHERE
-      el.oid = t.typelem
-      AND el.typarray = t.oid
-  )

src/server/routes/types.ts

@@ -7,18 +7,25 @@ export default async (fastify: FastifyInstance) => {
   fastify.get<{
     Headers: { pg: string }
     Querystring: {
+      include_array_types?: string
       include_system_schemas?: string
       limit?: number
       offset?: number
     }
   }>('/', async (request, reply) => {
     const connectionString = request.headers.pg
+    const includeArrayTypes = request.query.include_array_types === 'true'
     const includeSystemSchemas = request.query.include_system_schemas === 'true'
     const limit = request.query.limit
     const offset = request.query.offset
 
     const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
-    const { data, error } = await pgMeta.types.list({ includeSystemSchemas, limit, offset })
+    const { data, error } = await pgMeta.types.list({
+      includeArrayTypes,
+      includeSystemSchemas,
+      limit,
+      offset,
+    })
     await pgMeta.end()
     if (error) {
       request.log.error({ error, request: extractRequestForLogging(request) })