✨ output data to file

data.csv

@@ -0,0 +1,2 @@
+ID,NAME,AGE,ADDRESS,SALARY
+1,Paul,32,California,20000

package.json

@@ -27,8 +27,8 @@
     "@types/inquirer": "^9.0.7",
     "@types/mssql": "^9.1.4",
     "@types/pg": "^8.10.9",
-    "csv": "^6.3.6",
     "inquirer": "^9.2.12",
+    "json-2-csv": "^5.0.1",
     "mssql": "^10.0.1",
     "pg": "^8.11.3",
     "prisma": "^5.7.0",

src/AppCommand.ts

@@ -1,19 +1,11 @@
 import {Command, Flags, ux} from '@oclif/core'
 import {Driver, drivers, isDriver, runQuery, sqlqdb} from './database.js'
 import {Connection, PrismaClient} from '@prisma/client'
-import {Format, printFormatted} from './output.js'
+import {Format, outputData} from './output.js'
 
 export abstract class AppCommand extends Command {
   sqlqdb = sqlqdb
 
-  async load<T>(start: string, task: Promise<T>, stop?: string) {
-    ux.action.start(start)
-    const result = await task
-    ux.action.stop(stop)
-
-    return result
-  }
-
   assertConnectionExists(alias: string, connection: Connection | null): asserts connection is Connection {
     if (!connection) {
       ux.error(`Connection with alias '${alias}' not found`)
@@ -43,23 +35,27 @@ export abstract class AppCommand extends Command {
       },
     })
 
-  async printQuery(driver: Driver, connectionString: string, query: string, format: Format) {
-    console.log({query})
-    const message = `Executing query ${query.slice(0, 100)}`
-
-    const result = await this.load(message, runQuery(driver, connectionString, query))
-    printFormatted(format, result)
+  async printQuery(driver: Driver, connectionString: string, query: string, format: Format, file: string | undefined) {
+    const result = await runQuery(driver, connectionString, query)
+    outputData(format, file, result)
 
     return result
   }
 
-  async printQueryWithHistory(driver: string, alias: string, connectionString: string, query: string, format: Format) {
+  async printQueryWithHistory(
+    driver: string,
+    alias: string,
+    connectionString: string,
+    query: string,
+    format: Format,
+    file: string | undefined,
+  ) {
     if (!isDriver(driver)) {
       ux.error(`Connection has driver '${driver}' which is not supported`)
     }
 
     try {
-      await this.printQuery(driver, connectionString, query, format)
+      await this.printQuery(driver, connectionString, query, format, file)
       await this.saveHistory(alias, query, true)
     } catch (err) {
       await this.saveHistory(alias, query, false)
@@ -68,13 +64,10 @@ export abstract class AppCommand extends Command {
   }
 
   getConnection(alias: string) {
-    return this.load(
-      `Getting connection details for '${alias}'`,
-      this.sqlqdb.connection.findFirst({
-        where: {
-          alias,
-        },
-      }),
-    )
+    return this.sqlqdb.connection.findFirst({
+      where: {
+        alias,
+      },
+    })
   }
 }

src/commands/connection/create.ts

@@ -1,6 +1,6 @@
 import {Args, Command, Flags, ux} from '@oclif/core'
 import {PrismaClient} from '@prisma/client'
-import {format, printFormatted} from '../../output.js'
+import {format, outfile, outputData} from '../../output.js'
 import {drivers, sqlqdb} from '../../database.js'
 import {AppCommand} from '../../AppCommand.js'
 
@@ -24,12 +24,13 @@ export default class Create extends AppCommand {
 
   static flags = {
     format,
+    outfile,
   }
 
   async run(): Promise<any> {
     const {args, flags} = await this.parse(Create)
     const {alias, driver, connectionString, description} = args
-    const {format} = flags
+    const {format, outfile} = flags
 
     const connection = await this.sqlqdb.connection.findFirst({
       where: {
@@ -50,6 +51,6 @@ export default class Create extends AppCommand {
       },
     })
 
-    printFormatted(format, result)
+    outputData(format, outfile, result)
   }
 }

src/commands/connection/delete.ts

@@ -1,6 +1,6 @@
 import {Args, Command, Flags, ux} from '@oclif/core'
 import {PrismaClient} from '@prisma/client'
-import {format, printFormatted} from '../../output.js'
+import {format, outfile, outputData} from '../../output.js'
 import {sqlqdb} from '../../database.js'
 import {AppCommand} from '../../AppCommand.js'
 
@@ -17,12 +17,13 @@ export default class Delete extends AppCommand {
 
   static flags = {
     format,
+    outfile,
   }
 
   async run(): Promise<any> {
     const {args, flags} = await this.parse(Delete)
     const {alias} = args
-    const {format} = flags
+    const {format, outfile} = flags
 
     const result = await this.sqlqdb.connection.delete({
       where: {
@@ -31,6 +32,6 @@ export default class Delete extends AppCommand {
       },
     })
 
-    printFormatted(format, result)
+    outputData(format, outfile, result)
   }
 }

src/commands/connection/get.ts

@@ -1,6 +1,6 @@
 import {Args, Command, Flags, ux} from '@oclif/core'
 import {PrismaClient} from '@prisma/client'
-import {format, printFormatted} from '../../output.js'
+import {format, outfile, outputData} from '../../output.js'
 import {sqlqdb} from '../../database.js'
 import {AppCommand} from '../../AppCommand.js'
 
@@ -15,14 +15,15 @@ export default class Get extends AppCommand {
 
   static flags = {
     format,
+    outfile,
   }
 
   static aliases = ['conn:get']
 
   async run(): Promise<any> {
     const {flags, args} = await this.parse(Get)
     const {alias} = args
-    const {format} = flags
+    const {format, outfile} = flags
 
     const result = await this.sqlqdb.connection.findFirst({
       where: {
@@ -32,6 +33,6 @@ export default class Get extends AppCommand {
 
     this.assertConnectionExists(alias, result)
 
-    printFormatted(format, result)
+    outputData(format, outfile, result)
   }
 }

src/commands/connection/list.ts

@@ -1,6 +1,6 @@
 import {Args, Command, Flags} from '@oclif/core'
 import {PrismaClient} from '@prisma/client'
-import {format, printFormatted} from '../../output.js'
+import {format, outfile, outputData} from '../../output.js'
 import {sqlqdb} from '../../database.js'
 import {AppCommand} from '../../AppCommand.js'
 
@@ -20,12 +20,13 @@ export default class List extends AppCommand {
 
   static flags = {
     format,
+    outfile,
   }
 
   async run(): Promise<any> {
     const {args, flags} = await this.parse(List)
     const {search = ''} = args
-    const {format} = flags
+    const {format, outfile} = flags
 
     const result = await this.sqlqdb.connection.findMany({
       where: {
@@ -49,6 +50,6 @@ export default class List extends AppCommand {
       },
     })
 
-    printFormatted(format, result)
+    outputData(format, outfile, result)
   }
 }

src/commands/history/delete.ts

@@ -1,6 +1,6 @@
 import {Args, Command, Flags, ux} from '@oclif/core'
 import {PrismaClient} from '@prisma/client'
-import {format, printFormatted} from '../../output.js'
+import {format, outfile, outputData} from '../../output.js'
 import {sqlqdb} from '../../database.js'
 import {AppCommand} from '../../AppCommand.js'
 
@@ -15,19 +15,20 @@ export default class Delete extends AppCommand {
 
   static flags = {
     format,
+    outfile,
   }
 
   async run(): Promise<any> {
     const {args, flags} = await this.parse(Delete)
     const {id} = args
-    const {format} = flags
+    const {format, outfile} = flags
 
     const result = await this.sqlqdb.history.delete({
       where: {
         id,
       },
     })
 
-    printFormatted(format, result)
+    outputData(format, outfile, result)
   }
 }

src/commands/history/get.ts

@@ -1,6 +1,6 @@
 import {Args, Command, Flags, ux} from '@oclif/core'
 import {PrismaClient} from '@prisma/client'
-import {format, printFormatted} from '../../output.js'
+import {format, outfile, outputData} from '../../output.js'
 import {sqlqdb} from '../../database.js'
 import {AppCommand} from '../../AppCommand.js'
 
@@ -15,12 +15,13 @@ export default class Get extends AppCommand {
 
   static flags = {
     format,
+    outfile,
   }
 
   async run(): Promise<any> {
     const {flags, args} = await this.parse(Get)
     const {id} = args
-    const {format} = flags
+    const {format, outfile} = flags
 
     const result = await this.sqlqdb.history.findFirst({
       where: {
@@ -32,6 +33,6 @@ export default class Get extends AppCommand {
       ux.error(`History with id '${id}' not found`)
     }
 
-    printFormatted(format, result)
+    outputData(format, outfile, result)
   }
 }