Skip to main content
Build Downloads Latest Version Supported Python versions License

Raw SQL results returns as dictionary.

Developers who has lots of works on databases, sometimes, especially written raw sql result or in other words selects become to much to handle, so to play with the result of that sqls become pain; columns has to be remembered which index of result list refers which column etc. (ORM usage is fix this issue but has consequences so even if you are using ORM sometimes as said writing raw sqls preferred)

To have a key value pair like dictionaries for sql results will be much more useful, and the pain will become less.

Installation

Using pip library will be installed as following

$ pip install sqltodict
$ pip install psycopg2
$ pip install mysql-connector-repackaged

Usage for PostgreSQL

To play with postgress database, required connection is as following;

: from sqltodict.connections.postgresqlconnection import PostgreSQLConnection

There are two ways to make class one is giving all required attributes for making the connection;

: pc = PostgreSQLConnection(sql="""select id, code
                                   from product
                                   limit 10
                                """,
                            database='template1'
                            user='dbuser'
                            host='localhost'
                            password='dbpass',
                            port=5433)

Other one is; cursor will be already generated and it could be enough to making the class;

: import psycopg2
: conn = psycopg2.connect(dbname='template1',
                          user='dbuser',
                          host='localhost',
                          password='dbpass',
                          port=5433)
: cursor = conn.cursor()
: pc = PostgreSQLConnection(sql="""select id, code
                                   from product
                                   limit 10
                                """,
                            cursor=cursor)

Execution is simple as it is;

: pc.execute_sql()

The result will as following, as default sql select result which is sometimes so hard to continue working.

: pc.result
[(62392, '4YAL61165JW'),
 (41308, 'Y14FCD010394'),
 (61397, '4YAL16490IK'),
 (4396, 'W2WCR0040'),
 (61696, '4YAK71063AA'),
 (57895, '4YAK38077PW'),
 (64853, 'V0400710218'),
 (61870, 'Y14LGD021110'),
 (55054, '4YAM19187LK'),
 (61027, '4YAM19698LK')]

For dictionary conversion the sql result will be following, as understandable list.

: pc.execute_return_as_dict()
[{'code': '4YAL61165JW', 'id': 62392},
 {'code': 'Y14FCD010394', 'id': 41308},
 {'code': '4YAL16490IK', 'id': 61397},
 {'code': 'W2WCR0040', 'id': 4396},
 {'code': '4YAK71063AA', 'id': 61696},
 {'code': '4YAK38077PW', 'id': 57895},
 {'code': 'V0400710218', 'id': 64853},
 {'code': 'Y14LGD021110', 'id': 61870},
 {'code': '4YAM19187LK', 'id': 55054},
 {'code': '4YAM19698LK', 'id': 61027}]

Usage for MYSQL

Playing with an mysql database there are slightly differences; starts with import;

: from sqltodict.connections.mysqlconnection import MYSQLConnection

There are two ways again to make the class usable;

: mc = MYSQLConnection(sql="""select id, code
                              from product
                              limit 10
                           """,
                       database='template1'
                       user='dbuser'
                       host='localhost'
                       password='dbpass',
                       port=3306)

… or in other way is as mentioned before, as following;

: import mysql.connector
: conn = mysql.connector.connect(user='root',
                                 password='',
                                 host='localhost',
                                 database='template1',
                                 port=3306)
: cursor = conn.cursor()
: mc = MYSQLConnection(sql="""select id, code
                              from product
                              limit 10
                           """,
                       cursor=cursor)

Execution is simple if result is wanted as default one;

: mc.execute_sql()
: mc.result
[(62392, '4YAL61165JW'),
 (41308, 'Y14FCD010394'),
 (61397, '4YAL16490IK'),
 (4396, 'W2WCR0040'),
 (61696, '4YAK71063AA'),
 (57895, '4YAK38077PW'),
 (64853, 'V0400710218'),
 (61870, 'Y14LGD021110'),
 (55054, '4YAM19187LK'),
 (61027, '4YAM19698LK')]

If dictionary type of result is requested, directly;

: mc.execute_return_as_dict()
[{'code': u'W2WCR0040', 'id': 4396},
 {'code': u'Y14FCD010394', 'id': 41308},
 {'code': u'4YAM19187LK', 'id': 55054},
 {'code': u'4YAK38077PW', 'id': 57895},
 {'code': u'4YAM19698LK', 'id': 61027},
 {'code': u'4YAL16490IK', 'id': 61397},
 {'code': u'4YAK71063AA', 'id': 61696},
 {'code': u'Y14LGD021110', 'id': 61870},
 {'code': u'4YAL61165JW', 'id': 62392},
 {'code': u'V0400710218', 'id': 64853}]

Metadata

Release files for sqltodict 1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sqltodict 1.2
File Size Uploaded
sqltodict-1.2.tar.gz 4.2 kB Details

Release files / sqltodict-1.2.tar.gz

Download URL sqltodict-1.2.tar.gz
Size 4.2 kB
Tags Source
SHA-256 checksum
How to use checksums
be56d8493b7debf0000ed4248cc5a49b4226f0cb66481cb714e61ddc2460899f
BLAKE2b-256 checksum
How to use checksums
f928dd6110055bc56772091376258d9e76b28b47cf515981f2b0224e500a1597
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

1.2 This release

1 release file

1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page