machinepack-postgresql/machines/destroy-manager.js

Structured Node.js bindings for connecting and running queries against a PostgreSQL database.

module.exports = {


  friendlyName: 'Destroy manager',


  description: 'Destroy the specified connection manager and destroy all of its active connections.',


  inputs: {

    manager: {
      friendlyName: 'Manager',
      description: 'The connection manager instance to destroy.',
      extendedDescription: 'Only managers built using the `createManager()` method of this driver are supported. Also, ' +
        'the database connection manager instance provided must not have already been destroyed--i.e. once `destroyManager()` ' +
        'is called on a manager, it cannot be destroyed again (also note that all existing connections become inactive).',
      example: '===',
      required: true
    },

    meta: {
      friendlyName: 'Meta (custom)',
      description: 'Additional stuff to pass to the driver.',
      extendedDescription: 'This is reserved for custom driver-specific extensions.',
      example: '==='
    }

  },


  exits: {

    success: {
      description: 'The specified manager and all of its active connections were successfully destroyed.',
      outputVariableName: 'report',
      outputDescription: 'The `meta` property is reserved for custom driver-specific extensions.',
      outputExample: '===',
      // example: {
      //   meta: '==='
      // }
    },

    failed: {
      friendlyName: 'Failed',
      description: 'Could not destroy the provided connection manager.',
      extendedDescription:
        'Usually, this means the manager has already been destroyed. But depending on the driver ' +
        'it could also mean that database cannot be accessed. In production, this can mean that the database ' +
        'server(s) became overwhelemed or were shut off while some business logic was in progress.',
      outputVariableName: 'report',
      outputDescription: 'The `error` property is a JavaScript Error instance with more information and a stack trace. ' +
        'The `meta` property is reserved for custom driver-specific extensions.',
      outputExample: '===',
      // example: {
      //   error: '===',
      //   meta: '==='
      // }
    }

  },


  fn: function destroyManager(inputs, exits) {
    inputs.manager.pool.end(function cb(err) {
      if (err) {
        return exits.failed({
          error: new Error('Failed to destroy the Postgres connection pool and/or gracefully end all connections in the pool. ' +
          'Details:\n=== === ===\n' + err.stack),
          meta: inputs.meta
        });
      }

      // All connections in the pool have ended.
      return exits.success({
        meta: inputs.meta
      });
    });
  }


};