version 20241027.1, deprecated datastore, welcome firestore

Author: mdipierro

pydal/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "20241020.1"
+__version__ = "20241027.1"
 
 from .base import DAL
 from .helpers.classes import SQLCustomType

pydal/adapters/google.py

@@ -106,6 +106,45 @@ def _find_work_folder(self):
             self.folder = os.path.relpath(self.folder, os.getcwd())
 
 
+# db = DAL("firestore") on Google App Engine
+# db = DAL("firestore://cred=credentials.json") everywhere else
+# (get credentials.json from google console)
+#
+# supports:
+# db(db.table).select(...)
+# db(db.table.id==id).select(...)
+# db(db.table.id>0).select(...)
+# db(db.table.field==value).select(...)
+# db(db.table.field!=value).select(...)
+# db(db.table.field>value).select(...)
+# db(db.table.field<value).select(...)
+# db(db.table.field>=value).select(...)
+# db(db.table.field<=value).select(...)
+# db(db.table.field.belnogs(values)).select(...)
+# db(~db.table.field.belnogs(values)).select(...)
+# db(simple_query1|simple_query2|simple_query3).select(...)
+# db(simple_query1&simple_query2&simple_query3).select(...)
+# db(or_query1&or_query2&or_query3).select(...)
+# db.table(id)
+# db.table(field1=value, field2=value)
+# db.table(id, field1=value, field2=value)
+# db(...).delete()
+# db(...).update(...) but only reliable when updating one or a few records
+#
+# does not support:
+# - joins
+# - transaction
+# - composition of queries involving field id
+# - or of and such as db(query1|(query2&query2))
+# - db.table.field.contains(...)
+# - db.table.field.like(...)
+# - db.table.field.startswith(...)
+# - non-zero offset such as select(limitby=(3,7))
+#
+# supports but unreliable
+# db(...).update(...) for many records
+
+
 @adapters.register_for("firestore")
 class Firestore(NoSQLAdapter):
     dbengine = "firestore"
@@ -174,6 +213,8 @@ def apply_filter(self, source, table, query):
         if isinstance(query, Query) and query.first is table._id:
             if query.op.__name__ == "eq":
                 return source.document(str(query.second)).get()
+            elif isinstance(query, Table):
+                return source
             elif query.op.__name__ == "gt" and query.second == 0:
                 return source
             raise RuntimeError("operator not supported")
@@ -265,6 +306,9 @@ def count(self, query, distinct=None, limit=None):
         table = self.get_table(query)
         source = self._client.collection(table._tablename)
         source = self.apply_filter(source, table, query)
+        # deal with the case or returning a single item which may be empty
+        if not hasattr(source, "where"):
+            return 1 if source.to_dict() else 0
         aggregate_query = aggregation.AggregationQuery(source)
         aggregate_query.count()
         results = aggregate_query.get()
@@ -274,12 +318,13 @@ def count(self, query, distinct=None, limit=None):
 
     def delete(self, table, query):
         counter = 0
-        docs = list(self.get_docs(table, query))
-        batch = self._client.batch()
-        for doc in docs:
-            batch.delete(doc.reference)
-            counter += 1
-        batch.commit()
+        while self.db(query).count() > 0:
+            docs = list(self.get_docs(table, query))
+            batch = self._client.batch()
+            for doc in docs:
+                batch.delete(doc.reference)
+                counter += 1
+            batch.commit()
         return counter
 
     def update(self, table, query, update_fields):

pydal/dialects/google.py

@@ -49,10 +49,10 @@ def comma(self, first, second, query_env={}):
         raise NotImplementedError
 
     def belongs(self, first, second, query_env={}):
-        return FieldFilter(first.name, "in", [[item] for item in second])
+        return FieldFilter(first.name, "in", second)
 
     def contains(self, first, second, case_sensitive=True, query_env={}):
-        return FieldFilter(first.name, "array-contains", second)
+        raise NotImplementedError
 
     def _not(self, val, query_env={}):
         op, f, s = val.op, val.first, val.second
@@ -71,6 +71,8 @@ def _not(self, val, query_env={}):
             rv = FieldFilter(f.name, "<=", s)
         elif op == self.gte:
             rv = FieldFilter(f.name, "<", s)
+        elif op == self.belongs:
+            rv = FieldFilter(f.name, "not-in", s)
         else:
             # TODO the IN operator must be split into a sequence of
             # (field!=value) AND (field!=value) AND ...

pydal/helpers/classes.py

@@ -189,14 +189,14 @@ def as_yaml(self, sanitize=True):
         return serializers.yaml(self.as_dict(flat=True, sanitize=sanitize))
 
 
-class Reference(long):
+class Reference(int):
     def __allocate(self):
         if not self._record:
-            self._record = self._table[long(self)]
+            self._record = self._table[int(self)]
         if not self._record:
             raise RuntimeError(
                 "Using a recursive select but encountered a broken "
-                + "reference: %s %d" % (self._table, long(self))
+                + "reference: %s %d" % (self._table, int(self))
             )
 
     def __getattr__(self, key, default=None):

pydal/parsers/google.py

@@ -1,7 +1,8 @@
 import base64
 
 from ..adapters.google import Firestore
-from . import Parser, before_parse, for_type, parsers
+from ..helpers.classes import Reference
+from . import before_parse, for_type, parsers
 from .base import BasicParser, JSONParser
 
 
@@ -18,7 +19,7 @@ def _boolean(self, value):
     @for_type("id")
     def _id(self, value):
         if not isinstance(value, int):
-            return int(value, 16)
+            return int(value)
         return value
 
     @for_type("json")
@@ -36,7 +37,7 @@ def reference_extras(self, field_type):
     @for_type("reference")
     def _reference(self, value, referee):
         if not isinstance(value, int):
-            value = long(value, 16)
+            value = int(value)
         if "." not in referee:
             value = Reference(value)
             value._table, value._record = self.adapter.db[referee], None

pydal/representers/google.py

@@ -29,6 +29,10 @@ def _json(self, value):
     def _json(self, value):
         return base64.b64decode(value)
 
+    @for_type("reference")
+    def _json(self, value):
+        return str(value)
+
     @for_type("list:integer")
     def _list_integer(self, value):
         if not isinstance(value, list):

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pydal"
-version = "20241020.1"
+version = "20241027.1"
 authors = [{ name="Massimo Di Pierro", email="massimo.dipierro@gmail.com" },]
 description = 'pyDAL is a Database Abstraction Layer. It generates queries for SQlite, PotsgreSQL, MySQL, and other backends. It was originally part of the web2py frameworks but it is now an independent project. Example: db.define_table("thing",Field("name")) and db.thing.insert(name="Pizza")'
 readme = "README.md"