Skip to content

Commit

Permalink
Fix and align docs and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amochin committed Sep 27, 2024
1 parent 1a268fb commit 1b2912f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ perform a check according to the specified condition - using the [Assertion Engi

## Examples
```RobotFramework
Check Row Count SELECT id FROM person == 2
Check Query Result SELECT first_name FROM person contains Allan
Check Row Count SELECT id FROM person == 2
Check Query Result SELECT first_name FROM person contains Allan
```

# Retry mechanism
Expand All @@ -179,8 +179,9 @@ The retry mechanism is disabled by default - ``retry_timeout`` is set to ``0``.

## Examples
```RobotFramework
Check Row Count SELECT id FROM person == 2 retry_timeout=10 seconds
Check Query Result SELECT first_name FROM person contains Allan retry_timeout=5s retry_timeout=1s
${sql}= Catenate SELECT first_name FROM person
Check Row Count ${sql} == 2 retry_timeout=10 seconds
Check Query Result ${sql} contains Allan retry_timeout=5s retry_pause=1s
````

# Logging query results
Expand Down
2 changes: 1 addition & 1 deletion doc/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/DatabaseLibrary/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ class DatabaseLibrary(ConnectionManager, Query, Assertion):
Examples:
| Check Row Count | SELECT id FROM person | *==* | 2 | retry_timeout=10 seconds |
| Check Query Result | SELECT first_name FROM person | *contains* | Allan | retry_timeout=5s | retry_timeout=1s |
| Check Query Result | SELECT first_name FROM person | *contains* | Allan | retry_timeout=5s | retry_pause=1s |
= Logging query results =
Keywords, that fetch results of a SQL query, print the result rows as a table in RF log.
Expand Down

0 comments on commit 1b2912f

Please sign in to comment.