Class DbExecute

packages/migrate/src/commands/DbExecute.ts:41–164

)

export class DbExecute implements Command {
  public static new(): DbExecute {
    return new DbExecute()
  }

  // TODO: This command needs to get proper support for `prisma.config.ts` eventually. Not just taking the schema path
  //  from prisma.config.ts but likely to support driver adapters, too?
  //  See https://linear.app/prisma-company/issue/ORM-639/prisma-db-execute-support-prismaconfigts-and-driver-adapters
  private static help = format(`
${process.platform === 'win32' ? '' : '📝 '}Execute native commands to your database

This command takes as input a datasource defined in ${italic('prisma.config.ts')} and a script, using ${green(
    `--stdin`,
  )} or ${green(`--file`)}.
The script input parameters are mutually exclusive, only 1 must be provided.

The output of the command is connector-specific, and is not meant for returning data, but only to report success or failure.

On SQL databases, this command takes as input a SQL script.
The whole script will be sent as a single command to the database.

${italic(`This command is currently not supported on MongoDB.`)}

${helpOptions}
${bold('Examples')}

  Execute the content of a SQL script file using the datasource configured in prisma.config.ts
  ${dim('$')} prisma db execute --file ./script.sql

  Execute the SQL script from stdin using the configured datasource
  ${dim('$')} echo 'TRUNCATE TABLE dev;' | \\
    prisma db execute \\
    --stdin
`)

  public async parse(argv: string[], config: PrismaConfigInternal, baseDir: string): Promise<string | Error> {
    const args = arg(
      argv,
      {
        '--help': Boolean,
        '-h': '--help',
        '--config': String,
        '--stdin': Boolean,
        '--file': String,
        '--telemetry-information': String,
      },
      false,
    )

    if (isError(args)) {
      return this.help(args.message)
    }

    if (args['--help']) {
      return this.help()
    }

    const cmd = 'db execute'