Skip to main content

PySQLTools

Project description

pysqltools

PySQLTools tries to ease the interaction between Python and SQL. The idea behind this project is to provide an easy framework to manage the interaction between this two languages. It allows dynamic queries management, using parameters in the SQL queries that can be later easily manipulated with the provided tools.

Install

you can install the latest distribution by pip install pysqltools

Current Features

Query Module

The query module provides a Query class to work with Query objects, which will allow to modify the SQL Queries on an easy way with the class methods, and easily access the sql string with the sql attribute of the objects.

To add parameters to the query, use {{parameter}} on the SQL String.

The current methods are:

  • ctes: Generator that yields the CTEs of the Query
  • selects: Generator that yields the Select statements of the Query
  • Windows: Generator that yields the Window Function contents of the query
  • tables: Generator that yields the detected tables on the query
  • parameters: Generator that yields all the parameters on the Query
  • format: allows to assign values to the parameters in the query. Current supported types are str, int, float, datetime.datetime, list[int, float, str] To call the format function, just call the parameters you have defined on your query. Example: query: select * from {{table_param}} limit 20

function call: query = Query(sql = sql).format(table_param = "MyTable")

Insert Module

More to be developed. For now, it contains a Generator generate_insert_query twith the following inputs:

  • df: pd.DataFrame containing the data we want to insert
  • table: name of the table we want to insert into
  • schema: name of the schema were the table is located
  • batch_size: How many rows on one insert query Note: if no table is provided, a parameter {{table}} will be automatically created on the Query object. It can be later changed using the .format() method.

The Generator yields Insert Queries (with batch_size rows) that can be iterated to execute.

Table Module

Allows to create tables on a SQL Database given a pandas DataFrame. Also contains the option to insert the data of the dataframe in the new table by calling the insert module

Delete Module

Contains the function delete_from_dataframe. This function allows to generate a Query object that will contain a SQL to delete all the rows in the target table that meet the conditions on the dataframe rows

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysqltools-1.1.1.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

pysqltools-1.1.1-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file pysqltools-1.1.1.tar.gz.

File metadata

  • Download URL: pysqltools-1.1.1.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.5 Darwin/24.3.0

File hashes

Hashes for pysqltools-1.1.1.tar.gz
Algorithm Hash digest
SHA256 ac2a307193ebca81a894c7819e2c0171a727c8181996487290bf8ce9f4c80dc0
MD5 88c5271313fe1dbfd9fc4ece783db5ea
BLAKE2b-256 d244262cf32c05bb3844e2271546422fef9aaf9ddd5ae05c3953319a4a183128

See more details on using hashes here.

File details

Details for the file pysqltools-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: pysqltools-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.5 Darwin/24.3.0

File hashes

Hashes for pysqltools-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 300ef2178ee9d2c48567b6fecdd57beae4691dd30e54d213f305350058b07950
MD5 ff367e510eda316a0d5f1f9690edc7aa
BLAKE2b-256 9552fed8bd6aa138911dd7476b2ceacd8325a7255834d23a31617716fe8d7313

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page