Skip to main content

A lightweight module that wraps and extends the PyMSSQL library.

Project description

pymssql-utils

A lightweight module that wraps and extends the pymssql library.

The aim of this module is to make it easier to use pymssql by:

  • Reducing the amount of boilerplate code needed.
  • Returning a helpful DatabaseResult class for each execution.
  • Being fully type hinted.
  • Parsing various SQL Types to native Python types that Python misses.
  • Making it easier to serialise your data.
  • Providing various utility functions for building dynamic SQL queries or logging query output.
  • Fixing various edge case bugs that arise when using pymssql.

The trade-off with "baking in" various patterns (primarily opening a new connection on every execution) is that this module is opinionated as to what best practice is, and might not be suitable for all use cases. If this module doesn't make your life easier please raise critiques or suggestions via Github.

This module was created naturally over the course of a few years of using pymssql in various projects.

Installation

This module can be installed via pip: pip install pymssql-utils. This module requires Python >= 3.6

Quick Start (TODO)

Running a simple query:

import os

import pymssqlutils as sql

os.environ["DB_NAME"] = "MASTER"

Notes

Why pymssql when and Microsoft officially recommends pyodbc?

Simply, ODBC drivers add an extra layer between Python and SQL Server which introduce a whole host of obscure issues that I believe outway the current benefits of pyodbc. These drivers are badly supported on linux distributions, and if you develop in containers often I believe using pymssql will work out of the box across many more distributions seamlessly.

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

pymssql-utils-0.0.1.tar.gz (6.1 kB view hashes)

Uploaded Source

Built Distribution

pymssql_utils-0.0.1-py3-none-any.whl (16.2 kB view hashes)

Uploaded Python 3

Supported by

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