Excel Spreadsheet Automation on PostgreSQL Data with the QUERY Formula

The CData Excel Add-In for PostgreSQL provides formulas that can edit, save, and delete PostgreSQL data. The following three steps show how you can automate the following task: Search PostgreSQL data for a user-specified value and then organize the results into an Excel spreadsheet.

The syntax of the CDATAQUERY formula is the following:

=CDATAQUERY(Query, [Connection], [Parameters], [ResultLocation]);

This formula requires three inputs:

• Query: The declaration of the PostgreSQL data records you want to retrieve or the modifications to be made, written in standard SQL.

• Connection: Either the connection name, such as PostgreSQLConnection1, or a connection string. The connection string consists of the required properties for connecting to PostgreSQL data, separated by semicolons.

  To connect to PostgreSQL, set the Server, Port (the default port is 5432), and Database connection properties and set the User and Password you wish to use to authenticate to the server. If the Database property is not specified, the data provider connects to the user's default database.

  SSH Connectivity for PostgreSQL

  You can use SSH (Secure Shell) to authenticate with PostgreSQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

  SSH Connections to PostgreSQL in Password Auth Mode

  To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

  • User: PostgreSQL User name
  • Password: PostgreSQL Password
  • Database: PostgreSQL database name
  • Server: PostgreSQL Server name
  • Port: PostgreSQL port number like 3306
  • UserSSH: "true"
  • SSHAuthMode: "Password"
  • SSHPort: SSH Port number
  • SSHServer: SSH Server name
  • SSHUser: SSH User name
  • SSHPassword: SSH Password

  SSH Connections to PostgreSQL in Public Key Auth Mode

  To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

  • User: PostgreSQL User name
  • Password: PostgreSQL Password
  • Database: PostgreSQL database name
  • Server: PostgreSQL Server name
  • Port: PostgreSQL port number like 3306
  • UserSSH: "true"
  • SSHAuthMode: "Public_Key"
  • SSHPort: SSH Port number
  • SSHServer: SSH Server name
  • SSHUser: SSH User name
  • SSHClientCret: the path for the public key certificate file
• ResultLocation: The cell that the output of results should start from.

Pass Spreadsheet Cells as Inputs to the Query

The procedure below results in a spreadsheet that organizes all the formula inputs in the first column.

1. Define cells for the formula inputs. In addition to the connection inputs, add another input to define a criterion for a filter to be used to search PostgreSQL data, such as ShipCountry.
2. In another cell, write the formula, referencing the cell values from the user input cells defined above. Single quotes are used to enclose values such as addresses that may contain spaces.

=CDATAQUERY("SELECT * FROM Orders WHERE ShipCountry = '"&B6&"'","User="&B1&";Password="&B2&";Database="&B3&";Server="&B4&";Port="&B5&";Provider=PostgreSQL",B7)


3. Change the filter to change the data.