{"library":"sequelize-pg-utilities","title":"Sequelize Postgres Utilities","description":"sequelize-pg-utilities is an opinionated set of database utilities designed to simplify the configuration and connection process for PostgreSQL databases when used with Sequelize or the Sequelize CLI. It standardizes database configuration by integrating values from config files, environment variables, and sensible defaults, and also provides a mechanism for creating the database itself. The current stable version is 2.0.2, with recent updates focused on dependency upgrades and maintenance. The library differentiates itself by addressing the configuration discrepancies between Sequelize and the Sequelize CLI and offering built-in database creation capabilities, abstracting away common setup complexities for PostgreSQL users. Releases typically occur as needed for dependency updates, bug fixes, or significant API changes.","language":"javascript","status":"active","last_verified":"Wed Apr 22","install":{"commands":["npm install sequelize-pg-utilities"],"cli":null},"imports":["const { configure } = require('sequelize-pg-utilities');","const pgUtilities = require('sequelize-pg-utilities');\n// then use pgUtilities.configure(...)","import type { ConfigureResult, DbConfig } from 'sequelize-pg-utilities';"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"const { configure } = require('sequelize-pg-utilities');\nconst { Sequelize } = require('sequelize'); // Assuming Sequelize is installed\n\n// Mock a config/config.json structure\nconst appConfig = {\n  development: {\n    username: process.env.DB_USER ?? 'my-dev-user',\n    password: process.env.DB_PASS ?? 'my-dev-password',\n    database: process.env.DB_NAME ?? 'my-project-development'\n  },\n  test: { /* ... */ },\n  production: { /* ... */ }\n};\n\n// To simulate different environments for quickstart\nprocess.env.NODE_ENV = 'development'; \n\nasync function initializeDatabase() {\n  try {\n    const { name, user, password, options, dbNew } = await configure(appConfig);\n\n    console.log(`Database '${name}' initialized. New database created: ${dbNew}`);\n    console.log(`Attempting to connect with user: ${user}`);\n\n    const sequelize = new Sequelize(name, user, password, options);\n\n    await sequelize.authenticate();\n    console.log('Database connection has been established successfully.');\n    \n    // Example: Run a simple query\n    const [results] = await sequelize.query('SELECT 1+1 AS solution');\n    console.log('Query result:', results[0].solution);\n\n    await sequelize.close();\n    console.log('Database connection closed.');\n  } catch (error) {\n    console.error('Unable to connect to the database or an error occurred:', error);\n    process.exit(1);\n  }\n}\n\ninitializeDatabase();","lang":"javascript","description":"This quickstart demonstrates how to use `sequelize-pg-utilities` to configure and connect to a PostgreSQL database with Sequelize, including handling environment variables and illustrating database creation.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}