Verify the PI SQL Client JDBC installation on Windows

PI SQL Client JDBC includes the IPISQL command-line tool, which you can use to validate the installation on Windows.

The IPISQL command-line tool is located in the Tools directory of the PI SQL Client JDBC installation. IPISQL works with raw URLs. For more information, see Connection URL format.

1. Open a command window as an administrator.

2. Use cd to change to the following directory: PIHOME\SQL\SQL Client\JDBC\Tools\IPISQL\bin.

3. To set the path to the Java Runtime Environment, type set path=%path%;<Java_Path>\bin, where Java_Path is the directory of your installed Java Runtime Environment, then press Enter.

4. Type java IPISQL and press Enter.

   Note: The IPISQL command name is case sensitive and needs to be typed in all capital letters.

   You can specify the URL when you call the tool as follows:

   PIHOME\SQL\SQL Client\JDBC\Tools\IPISQL\bin>java IPISQL -url
   "jdbc:pisqlclient://myAfServer/myAfDatabase;"

   Note: If you do not specify credentials in the URL, the tool uses a trusted connection.

5. If you did not specify the URL, enter the following parameters:

   • PI Asset Framework Server Name

     The name of the PI Asset Framework. This parameter is required.

   • PI Asset Framework Database Name

     The name of the PI Asset Framework database. This parameter is required.

   • Use trusted connection?

     Whether you want to use Kerberos authentication, either Yes or No. The default is Yes. If you enter No, you will be prompted to enter credentials.

If the installation was successful, you should see results similar to the following:

Connected to PI SQL Data Access Server (RTQP Engine) 2018 SP3 Patch 3, 1.8.21196.1
Driver name: PI SQL Client, version: 4.2.22020.1.

Item: AF SDK Version: 2.10.9.593 FriendlyVersion: 2018 SP3 Patch 3
Item: AF Server Version: 2.10.9.593 FriendlyVersion: 2018 SP3 Patch 3
Item: Master Catalog Version: 2 FriendlyVersion: null
Item: Model Schema Version: 3 FriendlyVersion: null
Item: Operating System Version: 6.2.9200.0 FriendlyVersion: Microsoft Windows 10 Enterprise
Item: Query Processor Version: 1.8.21196.1 FriendlyVersion: 2018 SP3 Patch 3
Item: SQL Server Version: 15.0.2080.9 FriendlyVersion: Microsoft SQL Server 2019 (RTM-GDR) (KB4583458) - 15.0.2080.9 (X64)

Note: Installation of PI SQL Data Access Server (RTQP Engine) requires you to connect to the PI SQL Client. For more information, see the PI SQL Data Access Server (RTQP Engine) Administrator Guide.

If PI SQL Data Access Server (RTQP Engine) is not installed or the PI AF Server machine is not accessible, you should see an error similar to the following:

URL: jdbc:pisqlclient://FRA2-AF210AC/NuGreen;

java.sql.SQLException: Connection failed. Please make sure the PI SQL DAS service is running, and you have supplied the correct port number. Connection refused: connect