Skip to main content

A simple psycopg2 based wrapper for nosql like database interaction with python.

Project description

Build Status Code Climate Latest Version Development Status Python Versions License

A simple psycopg2 based wrapper for nosql like database interaction with python.

Why another wrapper?

The wrapper was developed to work with JSON postgres storage like a real NoSQL DB (e.g. MongoDB). After a long research with google there was no library found which helps to work with JSON and PostgreSQL so I decided to develop one.

The strength of the wrapper is that you still can have multiple relational colums in your table.

Installation

Using Python Package Index (PIP)

Just run the command: pip install pg4nosql

During alpha stage the api will change with each build. So try to stay with one version if you want to use it.

The hacky way (newer release)

  1. download or clone this repository

  2. run the command python setup.py install

Changelog

  • Version 0.3.2

  • project cleanup

  • Version 0.3.1

  • auto-commit for very operation as default

  • save does not affect saving object anymore

  • bug fixes

  • Version 0.2.4

  • a lot of bug fixes

  • Version 0.2.0

  • added port argument

  • replaced dictionary argument with **keyword syntax

  • switched result.relational with result.json

  • add bracket syntax to get database or table

  • renamed table.get_or_create to match codestyle

Example

These examples show the funcionality of the wrapper. There are some functions which are not covered by the examples (like removing of a table) but the importent ones are explained.

Dataschema Creation

To create the dataschema you can use normal database tools if you want. A document table has two fields:

  • id with data type serial

  • json with data type JSON which represents the document

But pg4nosql also provides methods to create your database schema on the fly. This is useful to create tables and databases software controlled.

This example shows how to create a database and their tables. The cities table is special because it also contains relational data like a normal table would:

# create pg4nosql client
pg4nosql = PostgresNoSQLClient(host='localhost')

# create demo database
demo_db = pg4nosql['demo']

# create document only table
users = demo_db['users']

# create document & relational table
cities = demo_db.get_or_create_table('cities', size='real NOT NULL')

Insert Data

To insert data into the table you just hand over a dictionary or an object which is json serializable. If there are relational columns defined you can set those by the table name as keyword and the value:

# store data into users table
users.put({'name': 'Florian', 'age': 24})
users.put({'name': 'Markus', 'age': 24})
users.put({'name': 'Sara', 'age': 22})
users.put({'name': 'Thomas', 'age': 25})

# store data into cities table
cities.put({'name': 'Zurich'}, size=87.88)
cities.put({'name': 'Berlin'}, size=891.8)
cities.put({'name': 'Bern'}, size=51.6)
cities.put({'name': 'London'}, size=1572)

# commit data
demo_db.commit()

Query Data

To get your data back you can run a query over it. This works like normal SQL WHERE queries. For JSON data you have to use the json column:

# query all users which are 24 years old
users_24 = users.query("json->>'age'='24'")

And here the result of the user query:

[
   "{'json': {u'age': 24, u'name': u'Florian'}, 'id': 1}",
   "{'json': {u'age': 24, u'name': u'Markus'}, 'id': 2}"
]

You can also combine relational and JSON queries together like this:

# query all cities which start with be and are bigger than 100 km
big_ber_cities = cities.query("json->>'name' LIKE 'Ber%'"
                              "AND size > 100")

Here the result of this query:

[
   "{'json': {u'name': u'Berlin'}, 'id': 2, 'size': 891.8}"
]

Query Data Access

To access the JSON fields of the result there is an attribute called json:

# get first city of the result array
first_city = big_ber_cities[0]

# read JSON attribute
city_name = first_city.json['name']

To access the relational fields of the result you have to use square brackets ([]) on the result:

# read relational attribute
city_size = first_city['size']

Update Data

With those access methods you can also write into the result and change the values of the fields. To save it just call save(obj) on the table object.

# change florian's age
florian = users_24[0]
florian.json['age'] = 25

users.save(florian)
users.commit()

The same works also for the relational fields:

# make zurich a bit bigger
zurich = cities.query_one("data->>'name'='Zurich'")
zurich['size'] = 90

cities.save(zurich)
cities.commit()

Close Connection

Finally don’t forget to close the connection to the database.

# close db
demo_db.close()

About

The wrapper has been written for a science project and is still an early alpha version! Idea and implementation by Florian (cansik)

MIT License Copyright (c) 2015

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

pg4nosql-0.3.4.tar.gz (5.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page