Changes between Version 30 and Version 31 of NonSqlBackends

12/10/10 18:04:10 (12 years ago)
Waldemar Kornewald



  • NonSqlBackends

    v30 v31  
    1 = This page is outdated =
    3 For the latest updates you should see the [ Django nonrel blog] and the [ Django App Engine backend] project page.
    5 = Original content =
    7 Here we collect the high-level refactorings required for non-sql (or non-relational) backends.
    9 The Django ORM work for supporting non-relational DB backends and possibly other Django-internal changes are in:
    12 Related tickets: #10355
    14 Specific backend specifications: AppEngine, [wiki:SimpleDB]
    16 = Basics =
    18 Database query operations (get, count, ... entities) are provided to Django models via managers. Managers basically wrap around QuerySet methods. Internally Django's QuerySet class uses sql.Query whose default is sql.BaseQuery. sql.Query can be overridden to use a custom Query class (the backend). So we end up writting a Query class in order to provide a specific backend. So anything done in Django's Model methods or QuerySet methods which cannot be done for a specific backend should be moved into the Query in order to allow backends to specify what to do in such cases.
    19 Additionally the backends Query class should not be referenced by sql.Query (cause it can have nothing to do with sql)
    21 == Emulation of SQL features ==
    23 If we emulate certain SQL features (e.g., a JOIN), it must be possible to detect when something gets emulated. This is important because you might mistakenly develop code that doesn't scale when your database grows beyond a certain size. In we could have a flag which specifies whether to throw warnings for emulated features (ENABLE_DB_EMULATION_WARNINGS?). By default, warnings should be enabled, so you never miss potential sources of problems.
    25 = sql.subqueries =
    27 The query classes defined in this module are used by QuerySet and Model. Their use should be handled by sql.Query, instead, so non-relational backends can override them.
    29 = Fields =
    31 == AutoField ==
    33 In some DB systems the primary key is a string. Currently, AutoField assumes that it's always an Integer.
    35 Implementing an auto-increment field in SimpleDB would be extremely difficult.  I would say impossible, actually.  The eventual consistency model just doesn't support it.  For the persistence layers I have written on top of SimpleDB, I use a UUID (type 4) as the ID of the object.  --garnaat
    37 Conclusion: Portable code should never assume that the "pk" field is a number. If an entity uses a string pk the application should continue to work.
    39 = Model =
    41 == Multi-table inheritance ==
    43 In the current implementation, multi-table inheritance requires reads and writes across multiple tables. On non-relational DBs this has to be solved differently. For example, with a ListField type you could store all models which you derived from (inspired by App Engine's PolyModel). E.g., if model B derives from model A you'd store model B in the table for model A and add B's name (app_b) to the ListField.
    45 On App Engine this adds deeper composite indexes which is a problem when filtering against multiple ListFields combining that with inequality filters or results ordering (exploding indexes). Thus, this should only be used at the second inheritance level (seen from Model base class).
    47 Problem:
    48 Model A doesn't know about model B, but since both of them live in the same table an A instance has to know about B's fields, so when A is saved it can preserve B's data (you can't modify only specific fields; you always replace the whole row). Either we always keep all data (which means you never free up data after schema changes unless you use a lower-level API) or we keep track of all derived models' fields and preserve those while removing all unused fields (e.g., A would know about B's fields and preserve them when saving). Probably the first solution is the safest.
    50 TODO: How do we store field data that doesn't exist in any model definition?
    52 ''There are some broken assumptions here. Multi-table inheritance is, by definition, just syntactic sugar for one-to-one relations to other tables. This proposal suggests effectively converting multi-table inheritance to single-table inheritance, which breaks the only reason it exists: (a) a single table to query for common parent information and (b) the ability to extend third-party models without modification, whilst still updating the third-party tables. But only on app-engine, leading to different behaviour there than on relational storage systems, meaning nobody can make reasonable assumptions about how their app would run if they are required to have it work in a storage-agnostic fashion. We should fail properly for unsupported features, not have behavioural breakage by appearing to run, but not work the same. If a third-party storage engine cannot support linked tables by any kind of fakery, then apps using multi-table inheritance just can't run on those storage engines. Django shouldn't be crippled to support the lack of relational support in such storage engines. It's called an O*R*M, after all. This isn't a race for the bottom, trying to find the lowest common denominator. Not everything can run on every storage engine (otherwise the only possible option is to only design Django to work with CSV files, since everything else has some features that storage system doesn't). -- Malcolm Tredinnick''
    54 ''What's the problem exactly? I don't see a lot of cases where this would break assumptions. At the Model level it's fully abstracted away, anyway. As long as you don't make explicit queries against the underlying tables, but just work with the models it will be 100% the same behavior. Also, the alternative is that the code doesn't work, at all, on App Engine, so it's better to have 50% of all Django apps that use multi-table inheritance work correctly than 0%. -- wkornewald''
    56 == save_base() ==
    58 The distinction between insert and update should be done by sql.Query because not all backends make that distinction, at all. The check whether the pk already exists (which is part of the distinction) should be moved out, too, because it would be unnecessarily inefficient on those backends.
    60 == delete() ==
    62 model.delete() collects all related objects using _collect_sub_objects(). For non-sql backends this is not always possible, for example, when running in a transaction on App Engine (only entities in the same entity group can be fetched from the datastore). This means that we can't guarantee referential integrity and we can't efficiently emulate SQL in this case. So model_instance.delete() should only delete the model_instance by calling sql.Query.delete(). This gives backends the flexibility to override sql.Query.delete() and make use of _collet_sub_objects() if desired and possible.
    64 = Transactions =
    66 Not all backends support transactions, at all (e.g., SimpleDB). Some (e.g., App Engine) only support transactions similar to "SELECT ... FOR UPDATE" (which isn't exactly the same as @commit_on_success because it really locks items for read/write access). Not all backends support a BEGIN/END TRANSACTION operation, but only provide an interface for calling a function transactionally (like the @commit_on_success decorator).
    68 = Queries =
    70 TODO: Let's wait for App Engine to support its new bookmarks mechanism before implementing this (key-based pagination doesn't work in all situations).  (Is there a link to info about app engine bookmarks?  I only found one sentence about cursors on the [ official roadmap].)
    72 On App Engine you can only retrieve the first 1000 query results. There needs to be support for "bookmarks" which mark the next starting point.
    74 On SimpleDB you can directly retrieve the bookmark of the Nth item and run the query from there.
    76 TODO(mitch?): Find out if this is efficient (even for millions of items) or if it's better to provide bookmarks at a higher level.
    78 SimpleDB provides it's own paging mechanism, returning a token with your result set if there are more results available.  You then issue the same query again, passing the token as a parameter.  This is by far the most efficient way to handle it in simpledb and scales very well.  In boto, I wrapped that whole thing in a generator so you can seamlessly iterate over the entire resultset without dealing with the additional requests so if we wanted to handle paging at a higher level we could use that approach.
    80 == count() ==
    82 query.count() will be problematic since a scalable count() method doesn't exist in app engine (does it exist in SimpleDB?).  Perhaps this will be alleviated by cursors/bookmarks, but I suspect we'll have to address this some other way.  An automatic sharded counter in the manager would allow for an "almost accurate" count in most situations.  It would certainly be good enough for the most popular use case, "how many pages of results do I have?"
    84 SimpleDB supports count() directly.  --garnaat
    86 The sharded counter can only be used for counting a very specific query, so you'd either have to specify all possible queries upfront or manage the counter manually. --wkornewald
     1This page has moved to NoSqlSupport
Back to Top