SQL Field Report
Author: Will James
About
SQL Field Report is a polars powered data analysis tool, which summarises the schema of a given dataset. This can be a series of flat files (excel/csv) or tables in a database. It returns a table of analysis with the following columns:
| Column | Description |
|---|---|
| Table/File | The table or file of the analysed field |
| Field | The analysed column/field |
| Count | The number of records in the table/file |
| Populated | For the column/field, how many rows are populated |
| Unique | For the column/field, how many unique values are present |
| Datatype | Estimated CRM datatype for the column/field |
Installation
To install use pip:
pip install sql-field-report
To use as a CLI, call "sql-field-report" within a virtual environment:
python -m venv venv
pip install sql-field-report
venv/scripts/activate
sql-field-report --help
Usage
SQL Field Report is a Typer CLI tool to see the available functions run:
sql-field-report --help
Usage: sql-field-report [OPTIONS] COMMAND [ARGS]...
Commands
mssql-database-report MSSQL Database Report
mysql-database-report MySQL Database Report
MSSQL Database Report
Generate an excel report summarising the data in an MSSQL Database
Args:
│ * server TEXT [default: None] [required] │
│ * port INTEGER [default: None] [required] │
│ * user TEXT [default: None] [required] │
│ * password TEXT [default: None] [required] │
│ * database_name TEXT [default: None] [required] │
│ * schema TEXT [default: None] [required] │
│ * output_file_name TEXT [default: None] [required]
SQL Field Report can also be used as an importable package in python code:
from sql_field_report import build_dataframe_field_report, read_file
analysis_files = ["file1.xlsx", "file2.xlsx"]
build_dataframe_field_report(
"Field_Report.xlsx",
analysis_files,
read_file,
)
import uuid
from os import getenv, listdir, remove
from os.path import join
from dotenv import load_dotenv
from sql_field_report.sql_field_report import MSSQL_Database_Report
load_dotenv()
file = f"Test_Report{str(uuid.uuid4())}.xlsx"
MSSQL_Database_Report(
getenv("SERVER"),
getenv("PORT"),
getenv("USER"),
getenv("SQL_SERVER_PASSWORD"),
getenv("DATABASE"),
"dbo",
file,
)
1 maintainer
Metadata
1 maintainer
Release files for sql-field-report 1.2.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sql_field_report-1.2.7.tar.gz | 11.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sql_field_report-1.2.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.9 kB
Release files / sql_field_report-1.2.7.tar.gz
| Download URL | sql_field_report-1.2.7.tar.gz |
|---|---|
| Size | 11.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
330568b1ab3756c03eecdbed910c0dda58d6dbdade20a4d824ae4fdc20b7d5a0
|
|
BLAKE2b-256 checksum How to use checksums |
88a15093fde8c4a84a45358c42e05390ad97b12cfbdc241fd1698e73c45e8b3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.12.3 Linux/6.5.0-1021-azure
|
Release files / sql_field_report-1.2.7-py3-none-any.whl
| Download URL | sql_field_report-1.2.7-py3-none-any.whl |
|---|---|
| Size | 14.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a71f8d7a6e9f69b5a91831477941bdf78bbf554256a7cf394870070bf0e09f87
|
|
BLAKE2b-256 checksum How to use checksums |
0a022b62f9df1aef9c041533701a2e435a9a5be5018a9ba126630d6c4d0062dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.4.2 CPython/3.12.3 Linux/6.5.0-1021-azure
|
