Working with SQL Connections
SQL Connections
The Kinetic Platform supports direct connections to PostgreSQL and SQL Server databases. These SQL Connections allow you to securely query external databases and integrate live data into your forms and workflows using parameterized Operations.
Your SQL database must be accessible over the internet. Connections must be able to reach the database from the Kinetic Platform’s infrastructure.
Accessing a SQL Connection
To get started with SQL integrations, you’ll first need to set up a connection to your PostgreSQL or SQL Server database. This is typically done from the Plugins page in the Space Console.
Follow these steps:
- From the Space Console, click Plugins to open the Connections tab.
- Click New Connection.
- In the New Connection modal, select SQL, then choose either PostgreSQL or SQL Server as your database type.
Creating a SQL Connection
When creating a SQL Connection, you will be prompted to enter configuration details specific to your target database.
Connection Fields
-
Connection Name
Required. A friendly name to help you identify this connection across the platform. -
Description
An optional description of the system or purpose this connection supports. -
Database Type
Required. Choose eitherPostgreSQL
orSQL Server
. -
Host
Required. The hostname or IP address of your database (e.g.,db.mycompany.com
or35.123.45.67
). -
Port
Required. The port used to access the database. Default values:- PostgreSQL:
5432
- SQL Server:
1433
- PostgreSQL:
-
Database Name
Required. The name of the specific database you want to connect to. -
Username
Required. The database account that will execute queries. -
Password
Required. The password associated with the provided username.
Make sure your firewall rules, network security groups, or hosting provider allow inbound connections from Kinetic’s cloud environment.
Editing a SQL Connection
Once a SQL Connection is created, it can only be modified from the Plugins > Connections tab.
To edit:
- Go to the Space Console and click Plugins.
- Select the connection you'd like to edit.
- From the Actions menu, choose Edit.
- Make any changes and click Update Connection.
Changes will affect all Operations that rely on this connection.
Related Topics
Updated 1 day ago