Connectivity: Database
Overview
Database connectivity is used to allow direct access to information from the main Database Management Systems on the market: MYSQL, POSTGRESQL, SQL SERVER, FIREBIRD and ORACLE.
For this type of connectivity, the platform allows SQL commands such as SELECT, UPDATE, DELETE and CREATE, among others.
SELECT operations are the most common. They allow a secure query of the database, returning the information in a structured JSON.
UPDATE, DELETE and CREATE operations are used when the system does not have processes created and exposed with APIs and require greater control, since the database will be changed directly. We recommend using views or temporary tables, which will be processed later.
How to connect an account
After defining the type of connectivity, the next step is to choose the type of authentication. Only after these settings have been made will you be able to add a new account, as well as select, edit or remove one of the previously registered accounts.
To add a connected account, click on "Connected account" and then "Add connected account".
Follow the steps according to the type chosen in Database (authentication type):
MySQL
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional).
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
PostgreSQL
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional).
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases
SQL Server
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional);
AppKey (optional): application key.
After filling in the details, click on "Create account".
Done! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
FireBird
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional).
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
FireBird 3+
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional).
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Oracle
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional);
Schema (optional): set of objects (tables, views, etc.) that belong to your account.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
SAP Hana
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional);
Schema (optional): set of objects (tables, views, etc.) that belong to your account.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
InterSystems Caché
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal (optional): if you have a terminal set up, select it so that the connection is made through the corresponding "Agent";
Account name: name of the registered account;
Host: IP of the database host;
Port: port number;
User;
Password;
Database name (optional).
Namespace (optional): must have the same value as the "database name" field.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
ODBC
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Terminal: select a previously configured terminal so that the connection is made through the corresponding “Agent”;
Account name: name of the account to be registered;
Connection string: sequence of characters that provides all the information needed to connect to the ODBC database.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
MongoDB
When you choose the "Add connected account" option, the following modal will be displayed:
Fill in the details:
Account name: name of the account to be registered;
Connection string: sequence of characters that provides all the information needed to connect to the MongoDB database.
After filling in the details, click on "Create account".
That's it! Your connected account has been created and can be used by other modules and flows, appearing among the options of accounts configured in both cases.
Finally, click on "Save changes" to configure your module settings.
Important: after saving the changes, it will no longer be possible to change the Connectivity type and/or Authentication type (Database).
Next step: Create operations for the module
Read also: Connected accounts management
Last updated