Database

Connect to an external database and run SQL queries.

The following databases are supported:

• PostgreSQL
• MySQL
• MariaDB

SDK Import:

from admyral.actions import run_sql_query

Connect your Database

In order to connect your database, you need to store the database URI as a secret.

Go to your Settings page in Admyral and click on Add New Secret in the Secrets section. Give your credential a name. The following secret structure is expected:

Then, click on Save.

Alternatively, you can use the following CLI command structure:

admyral secret set database_connection --value uri=postgresql://postgres:your-super-secret-and-long-postgres-password@localhost:5432/admyral

Example connection strings:

• PostgreSQL: postgresql://postgres:your-super-secret-and-long-postgres-password@localhost:5432/admyral
• MySQL: mysql://testuser:testpassword@localhost:3306/testdb
• MariaDB: mysql://testuser:testpassword@localhost:3307/testdb

Arguments:

Returns

A list of rows.

Required Secrets

SDK Example

response = run_sql_query(
	sql_query="select count(*) from students;",
	secrets={
		"DB_URI": "my_database_connection"
	}
)