Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ttafsir/ansible-collection-sqlite-utils
Ansible Lookup module for SQLite databases based on the sqlite-utils library
https://github.com/ttafsir/ansible-collection-sqlite-utils
Last synced: 28 days ago
JSON representation
Ansible Lookup module for SQLite databases based on the sqlite-utils library
- Host: GitHub
- URL: https://github.com/ttafsir/ansible-collection-sqlite-utils
- Owner: ttafsir
- Created: 2023-10-07T21:55:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-21T19:50:24.000Z (10 months ago)
- Last Synced: 2024-04-16T07:09:50.600Z (8 months ago)
- Language: Python
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
Awesome Lists containing this project
README
# Ansible Collection - ttafsir.sqlite_utils
[](https://opensource.org/licenses/MIT)
[](https://github.com/ttafsir/ansible-collection-sqlite-utils/actions/workflows/ci.yml)
A collection of Ansible plugins to manage SQLite databases leveraging the `sqlite-utils` Python package.
## Requirements
- Ansible 2.9 or later
- `sqlite-utils` package
## Collection contents
### Plugins
### Modules
* `ttafsir.sqlite_utils.run_sql`: Ansible module to query a sqlite database and return list of dictionaries.
* `ttafsir.sqlite_utils.create`: Ansible module create a table. The module will also create a database file if it doesn't exist.
* `ttafsirsqlite_utils.insert`: Ansible module to insert records into a database table. Supports inserting single and multiple records with a single dictionary or list of dictionaries.
* `ttafsirsqlite_utils.insert_json`: Ansible module to insert records into a database table from JSON files.
#### Lookup Plugins
* `ttafsir.sqlite_utils.sqlite`: A lookup plugin that returns query results from a sqlite database using the sqlite-utils library.
## Usage Examples
### `run_sql` module
```yaml
- name: Fetch data from database
ttafsir.sqlite_utils.run_sql:
db_path: database.sqlite
query: "SELECT * FROM emails ORDER BY email_id"
register: query_1
- debug: var=query_1.rows
- name: Fetch data based on ID
ttafsir.sqlite_utils.run_sql:
db_path: database.sqlite
query: "SELECT * FROM emails WHERE email_id = ?;"
params: [3]
register: query_2
- debug: var=query_2.rows
- name: Fetch data based on name and age
ttafsir.sqlite_utils.run_sql:
db_path: database.sqlite
query: |-
SELECT * FROM emails
WHERE subject = :subject
AND email_id = :email_id
params:
subject: "Hello World"
email_id: 1
register: query_3
- debug: var=query_3.rows
- name: Update data based on ID
ttafsir.sqlite_utils.run_sql:
db_path: database.sqlite
query: "UPDATE emails SET subject = ? WHERE email_id = ?;"
params: ["Hello World Updated", 1]
register: update_result
- debug: var=query_3.rows_affected
```
### Create a table and insert data
```yaml
- name: Create database
ttafsir.sqlite_utils.create:
db_path: database.db
table: emails
columns: {"email_id": "int", "subject": "str", "body": "str"}
pk: email_id
- name: Insert single records into database
ttafsir.sqlite_utils.insert:
db_path: database.db
table: emails
records: {"email_id": 2, "subject": "Hello World 2", "body": "body of the email"}
- name: Insert from json file
ttafsir.sqlite_utils.insert_json:
db_path: network.db
table: interfaces
file_path: interfaces.json
flatten: true
alter: true
```
### Lookup
```yaml
---
- hosts: localhost
gather_facts: no
vars:
where_arg: {"subject": "Peek #4"}
tasks:
- name: Fetch two columns from SQLite
debug:
msg: "{{
lookup(
'ttafsir.sqlite_utils.sqlite',
table='emails',
db_path=database,
select='email_id, subject')
}}"
- name: Fetch row from SQLite where email subject matches
debug:
msg: "{{
lookup(
'ttafsir.sqlite_utils.sqlite',
table='emails',
db_path='database.sqlite',
where='subject = :subject',
where_args=where_arg
)
}}"
```
See the lookup plugin documentation for more details.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/ttafsir/ansible-collection-sqlite-utils/blob/main/LICENSE) file for details.
## Links
- [sqlite-utils Python package](https://pypi.org/project/sqlite-utils/)