Create a TCP connection by using Node.js

Opens a TCP connection to Cloud SQL for PostgreSQL by using the Node.js knex module.

Explore further

For detailed documentation that includes this code sample, see the following:

• About connection options
• Connect from App Engine flexible environment
• Connect from App Engine standard environment
• Connect from Cloud Build
• Connect from Cloud Functions
• Connect from Cloud Run
• Connect using the Cloud SQL Auth Proxy
• Manage database connections

Code sample

Node.js

To authenticate to Cloud SQL for PostgreSQL, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

const Knex = require('knex');
const fs = require('fs');

// createTcpPool initializes a TCP connection pool for a Cloud SQL
// instance of Postgres.
const createTcpPool = async config => {
  // Note: Saving credentials in environment variables is convenient, but not
  // secure - consider a more secure solution such as
  // Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
  // keep secrets safe.
  const dbConfig = {
    client: 'pg',
    connection: {
      host: process.env.INSTANCE_HOST, // e.g. '127.0.0.1'
      port: process.env.DB_PORT, // e.g. '5432'
      user: process.env.DB_USER, // e.g. 'my-user'
      password: process.env.DB_PASS, // e.g. 'my-user-password'
      database: process.env.DB_NAME, // e.g. 'my-database'
    },
    // ... Specify additional properties here.
    ...config,
  };
  // Establish a connection to the database.
  return Knex(dbConfig);
};

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.