Locoia
Search…
SQL Connector

Setting up your SQL Helper

Connector Auth

To start setting up your connector auth, either go to Settings -> Connector Auth and add a new auth, or add the SQL Helper to a flow and click "Create new Auth".

API Endpoint

The API-Endpoint for your SQL Connector Auth has the following Schema:
1
<database driver[+dialect]>://<host>/<database>
Copied!
For a list of available drivers and dialects, please visit the SQLAlchemy Dialects Page. In most cases, you will not need a dialect at all. If you get an error message, try the first listed dialect for your database. As of this writing, we support PostgreSQL, MySQL, MariaDB, SQLite, Oracle and Microsoft SQL Server.
Your API-Endpoint should look something like this for AWS RDS:
1
postgresql://testdb.123456.eu-central-1.rds.amazonaws.com/mysubdatabase
Copied!
For an on-premise Oracle database, the API-endpoint look like:
1
oracle://testdb.my-domain.com:1234/mysubdatabase
Copied!

Username and Password

In almost all cases, it is advisable to create a separate user for Locoia. To find out how to create a user and manage permissions, please consult your respective database's user guide.
Once you have a user you want to use for DI, simply enter the username and password in these fields.

Connecting to Amazon RDS

If you need help connecting your DI SQL Helper to Amazon RDS, consult this article.

Oracle

To connect to Oracle, append your service name to the end of the connection string, where you would normally enter the database name (</database>).
Known errors and their meanings:
    TNS : listener does not currently know of SID given in connect descriptor => The database name is not provided correctly. This needs to be added at the end with a slash like above mysubdatabase.
    ORA-00900: Invalid SQL statement / Ungültige SQL-Anweisung =>The SQL statement is not correct. Please check your syntax and confirm with the Oracle reference.
Last modified 26d ago