Merge pull request #4 from GabrielTorelo/develop

Beta Version (v1.0.0) - OK

Author: GabrielTorelo

.gitignore

@@ -0,0 +1,79 @@
+# Byte-compiled / optimized / DLL files
+*/__pycache__/*
+*.py[cod]
+*$py.class
+
+# Local use
+Output.json
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# documentation
+docs/*
+
+# PyBuilder
+.pybuilder/
+target/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# pytype static type analyzer
+.pytype/
+
+# PyCharm
+.idea/

MOCK/.gitignore

@@ -0,0 +1,2 @@
+# Ignore directory contents
+/OUTPUT_DB/*

MOCK/DATA/.gitignore

@@ -0,0 +1,3 @@
+# Ignore everything in this directory
+*
+!.gitignore

MOCK/PATTERN/.gitignore

@@ -0,0 +1,3 @@
+# Ignore everything in this directory
+*
+!.gitignore

README.md

@@ -1,2 +1,118 @@
 # Database_Difference_Checker-Python_SQLite
-Python script to read SQLite files and check the differences between them
+Python script to read SQLite files and check the differences between them.
+
+## Before you start!
+This document provides a step-by-step guide to performing comparison between SQLite databases using the `Database_Difference_Checker-Python_SQLite` script.
+
+## Instructions for Use
+### 1. Using filters for tables and/or columns _(Optional Step)_
+- **Table Filters**: Edit the `constants/general.py` file and add the names of the tables you want to exclude from the comparison within the `EXCLUDED_TABLES` constant.
+  #### Example:
+  ```
+  EXCLUDED_TABLES = {"table1", "table2", "table3"}
+  ```
+- **Column Filters**: Edit the same file and add the names of the columns to be excluded from the comparison within the `EXCLUDED_COLUMNS` constant.
+  #### Example:
+  ```
+  EXCLUDED_COLUMNS = {"column1", "column2", "column3"}
+  ```
+
+### 2. Adding SQLite databases for comparison
+Place the SQLite `(.db)` files you want to compare inside the `MOCK/DATA` folder.
+
+- For contexts of different databases _(for example, databases from different companies)_, it is ideal, but not mandatory, to organize the databases in different folders within `MOCK/DATA`.
+  #### Example:
+  ![image](https://github.com/user-attachments/assets/4d439483-bdcb-4bb4-aa0e-7f73a28ae0b6)
+
+### 3. Adding the reference file
+Add the file with the reference data to the `MOCK/PATTERN` folder. **The reference file can be in `.txt`, `.json`, `.sqlite` or `.db` format**.
+
+### **Important**
+- **The `.sqlite` and `.db` files take precedence over the others**
+- The file must follow the pattern **_key-value_** _(key: value)_, with the **VALUE ALWAYS WRAPPED IN BRACKETS**.
+  #### Examples for text file `(.txt)`:
+  - **Example 1 (without line break):**
+    ```
+    TABLE_1:[{...}]TABLE_2:[...]TABLE_3:[...]
+    ```
+  - **Example 2 (with line break):**
+    ```
+    TABLE_1:[{...}, {...}]
+    TABLE_2:[{...}]
+    TABLE_3:[...]
+    ```
+  #### Example for JSON file `(.json)`:
+  ```
+  {
+      "TABLE_1": [
+          {
+              "name": "XXXX",
+              "type": "XXXX"
+          },
+          {
+              "name": "XXXX",
+              "type": "XXXX"
+          }
+      ],
+      "TABLE_2": [
+          {
+              "name": "XXXX",
+              "type": "XXXX"
+          }
+      ],
+      ...
+  }
+  ```
+
+### 4. Analysis of Results
+After executing the script, check the `trackingCode`. The code `00` indicates that the process completed without errors (other tracking codes in the section below).
+
+**The comparison results will be saved in a JSON file in the project root folder, called `Output.json` .**
+
+#### Example of `Output.json` file:
+```
+{
+    "MAIN_DATABASE_1": {
+        "DATABASE_SQLite_1": {
+            "Missing_Tables": [...],
+            "Missing_Data": {
+                "TABLE_1": [
+                {
+                    "name": "XXXX",
+                    "type": "XXXX"
+                }
+                ],
+                "TABLE_2": [...]
+            }
+        },
+        "DATABASE_SQLite_2": {...}
+    },
+    "MAIN_DATABASE_2": {...}
+}
+```
+
+## Tracking Codes
+
+Tracking codes indicate the status of the process:
+
+- `00`: **Finished without errors**
+- `01`: **An unexpected error occurred**
+- `02`: **Error reading file(s)**
+- `03`: **Error reading file(s) from directory**
+- `04`: **Error in the comparison process**
+- `05`: **Error generating `Output.json` file**
+- `06`: **Error reading data from databases**
+- `07`: **Error generating JSON from databases**
+- `08`: **Error when fetching JSON files from databases**
+- `09`: **Error creating reference JSON**
+- `10`: **Invalid file extension**
+
+## 🛠 Used Packages
+
+| Name      | Version |
+| :-------- | :------ |
+| 🐍 Python | `3.8.0` |
+
+## 🔗 Links
+
+[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GabrielTorelo/Database_Difference_Checker-Python_SQLite)

constants/__init__.py

@@ -0,0 +1,2 @@
+from .general import *
+from .sqlite_queries import *

constants/general.py

@@ -0,0 +1,7 @@
+TRACKING_CODE = "PRJ0000.X.X"
+DB_PATHS = "MOCK/DATA"
+PATTERN_PATH = "MOCK/PATTERN"
+PATTERN_PATH_JSON = "MOCK/PATTERN/padrao_db.json"
+OUTPUT_DB_PATH = "MOCK/OUTPUT_DB"
+EXCLUDED_TABLES = {"android_metadata", "sqlite_sequence"}
+EXCLUDED_COLUMNS = {""}

constants/sqlite_queries.py

@@ -0,0 +1,2 @@
+SELECT_TABLES = "SELECT name FROM sqlite_master WHERE type='table';"
+PRAGMA_TABLE_INFO = "PRAGMA table_info(%s);"

dao/__init__.py

@@ -0,0 +1 @@
+from .db_sqlite import *

dao/db_sqlite.py

@@ -0,0 +1,32 @@
+from sqlite3 import connect
+from err import Errors
+from constants import SELECT_TABLES, EXCLUDED_TABLES, EXCLUDED_COLUMNS, PRAGMA_TABLE_INFO
+
+
+def list_tables(db_path):
+    tables_info = {}
+
+    try:
+        connection = connect(db_path)
+        cursor = connection.cursor()
+        
+        cursor.execute(SELECT_TABLES)
+        tables = [row[0] for row in cursor.fetchall()]
+
+        tables = sorted(tables)
+        
+        for table in tables:
+            if table in EXCLUDED_TABLES:
+                continue
+
+            cursor.execute(PRAGMA_TABLE_INFO % table)
+            columns = cursor.fetchall()
+
+            tables_info[table] = sorted([
+                {'name': col[1], 'type': col[2]} for col in columns if col[1] not in EXCLUDED_COLUMNS
+            ], key=lambda x: x['name'])
+        
+        connection.close()
+        return tables_info
+    except Exception as e:
+        raise Errors(code=6, message=f"Error listing database tables: {e}")