Database Library for Robot Framework

2.4.1 · active · verified Tue Apr 14

The Database Library for Robot Framework allows users to query databases and verify results within Robot Framework tests. It is currently at version 2.4.1 and maintains an active release cadence, with frequent minor and patch updates to introduce new features, fix bugs, and enhance compatibility.

Warnings

deprecated Keywords `Check If Exists In Database` and `Check If Not Exists In Database` are deprecated and will be removed in future versions.
Fix: Migrate to `Check Row Count` with the assertion engine, for example: `Check Row Count SELECT id FROM person WHERE first_name = 'Franz Allan' >= 1`.
gotcha The library itself does NOT include database drivers. You must manually install the appropriate Python DB API 2.0 compliant driver (e.g., `pip install pymysql` for MySQL, `pip install psycopg2` for PostgreSQL) for the database you intend to connect to.
Fix: Ensure the required database driver is installed via pip before using `Connect To Database`.
breaking Several parameters were renamed in version 2.0, notably `sqlScriptFileName` to `sql_script_file` and `sansTran` to `no_transaction`.
Fix: Update your Robot Framework test files to use the new parameter names.
gotcha When using `Check Query Result`, type mismatch issues can occur if comparing numeric database results (e.g., INTEGER) directly with string literals from Robot Framework.
Fix: For versions 2.3.2 and later, use the `assert_as_string=True` parameter in `Check Query Result` to ensure all comparisons are made as strings. Alternatively, cast values in your SQL query to match expected types.

Install

pip install robotframework-databaselibrary Core library
pip install sqlparse Optional for advanced SQL string splitting
pip install pymysql Example: MySQL driver

Imports

DatabaseLibrary
```
Library    DatabaseLibrary
```
Imported directly in Robot Framework Settings table.

Quickstart

This example demonstrates connecting to an in-memory SQLite database, creating a table, inserting data, querying it, and asserting results using various keywords. It highlights the basic workflow without requiring external database setup beyond the library itself, as `sqlite3` is a built-in Python module.

*** Settings ***
Library    DatabaseLibrary

*** Test Cases ***
Example Database Interaction
    Connect To Database    sqlite3    :memory:
    Execute SQL String    CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)
    Execute SQL String    INSERT INTO users (name) VALUES ('Alice')
    Execute SQL String    INSERT INTO users (name) VALUES ('Bob')
    ${result}=    Query    SELECT name FROM users WHERE id = 1
    Check Query Result    SELECT name FROM users WHERE id = 1    equals    Alice
    Check Row Count    SELECT * FROM users    ==    2
    Disconnect From Database

view raw JSON →