firebase-orm 0.1.29

NoSQL object model database

FirebaseORM Python

Django like models for NoSQL database Firestore.

---

Installation

$ pip install firebase_orm

Initialize

Create settings.py in the root directory of the project:

settings.py

CERTIFICATE = 'path/to/serviceAccountKey.json'
BUCKET_NAME = '<BUCKET_NAME>.appspot.com'

CERTIFICATE

Once you have created a Firebase console project and downloaded a JSON file with your service account credentials.

BUCKET_NAME

The bucket name must not contain gs:// or any other protocol prefixes. For example, if the bucket URL displayed in the Firebase console is gs://bucket-name.appspot.com, pass the string bucket-name.appspot.com

Usage

Create model:

from firebase_orm import models


class Article(models.Model):
    headline = models.TextField()
    type_article = models.TextField(db_column='type')

    class Meta:
        db_table = 'medications'

    def __str__(self):
        return self.headline

Use API:

Creating objects

To represent cloud firestore data in Python objects, FirebaseORM uses an intuitive system: A model class represents a collection, and an instance of that class represents a document in collection.

To create an object, instantiate it using keyword arguments to the model class, then call save() to save it to the database.

# Import the models we created
>>> from models import Article
# Create a new Article.
>>> a = Article(headline='Django is cool')
# Save the object into the database. You have to call save() explicitly.
>>> a.save()

Retrieving all objects

The simplest way to retrieve documents from a collections is to get all of them. To do this, use the all() method on a Manager:

>>> all_Article = Article.objects.all()

The all() method returns a list instance Article of all the collection in the database.

# Now it has an ID.
>>> a.id
1

# Fields are represented as attributes on the Python object.
>>> a.headline
'Django is cool'

Saving changes to objects

To save changes to an object that’s already in the database, use save().

Given a Article instance a that has already been saved to the database, this example changes its name and updates its record in the database:

>>> a.headline = 'FirebaseORM is cool'
>>> a.save()

This performs an document.update() method behind the scenes. FirebaseORM doesn’t hit the database until you explicitly call save().

# Firebase ORM provides a rich database lookup API.
>>> Article.objects.get(id=1)
<Article: FirebaseORM is cool>
>>> Article.objects.get(id=2)
Traceback (most recent call last):
    ...
DoesNotExist: Article matching query does not exist.

Field options:

The following arguments are available to all field types. All are optional.

Field.db_column

If contains characters that aren’t allowed in Python variable names – use db_column. The name of the firestore key in document to use for this field. If this isn’t given, FirebaseORM will use the field’s name.

Field types:

AutoField

class AutoField()

By default, FirebaseORM gives each model the following field:

id = models.AutoField(primary_key=True)

TextField

class TextField(**options)

Text string Up to 1,048,487 bytes (1 MiB - 89 bytes). Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

TextField has not extra required argument.