Skip to Content

PostgreSQL Connection Guide

Overview

This guide describes the system requirements and instructions for connecting Vinyl to a PostgreSQL database server.

This guide assumes you have an existing PostgreSQL database that you are looking to connect to Vinyl. The PostgreSQL database User Name and Password values are required when configuring the connection to it from Vinyl.

To connect your servers, you must have Vinyl 3.3+ installed.

System Requirements

Database Server

PostgreSQL Database Server

Client Web Browser

  • Chrome: 84+

  • Firefox: 73+

  • Safari: 13.0.1+

  • Edge: 84+

Connection Instructions

Configure a Data Server in Vinyl

  1. Navigate to the Vinyl IDE

  2. From the Connect menu, click the Data Servers button

  3. Click the + Server button on the Data Servers panel. This will bring up the Server page. Provide the following information:

    • Server Name: Identifiable name for server connection

    • Type: PostgreSQL

    • Host Name: Endpoint associated with PostgreSQL Database instance

    • Port: Not usually required (Vinyl will use defaults for connection type), default for PostgreSQL is 5432

    • User Name: Credentials associated with PostgreSQL Database instance

    • Password: Credentials associated with PostgreSQL Database instance

    Note

    A PostgreSQL database with the same name as the instance's User Name must exist for Vinyl to connect

    attachment

  4. Click Save to complete server connection

  5. Expand Testing and click Test Connection to ensure connection works properly

Create a New Data Source

  1. Navigate to the Vinyl IDE

  2. From the Connect menu, click the Data Servers button

  3. Locate the PostgreSQL Data Server created in the prior step, and select it

  4. Click the + Source button

  5. Click the + Create Database button

  6. Provide an identifiable name for the Data Source Name

    • Confirm Connection is the PostgreSQL server created in prior step

    attachment

  7. Click the Next button

  8. Click the Done button

Import the Database

  1. Click the Details button for the new Data Source

  2. Click the Import button

  3. Expand Import Capabilities, and click the Import button

  4. Click Proceed to the prompt asking if you want to import physical model into logical

  5. Click Proceed to the prompt instructing that Change Sets won't be created

    • The import will be scheduled to run as a background task