Metadata-Version: 1.1
Name: sqlakeyset
Version: 0.1.1472125695
Summary: offset-free paging for sqlalchemy
Home-page: https://github.com/djrobstep/sqlakeyset
Author: Robert Lechte
Author-email: robertlechte@gmail.com
License: UNKNOWN
Description: sqlakeyset: offset-free paging for sqlalchemy
        =============================================
        
        This library implements keyset-based paging for SQLAlchemy (both ORM and core).
        
        This library has been tested with PostgreSQL and MariaDB/MySQL. It should work with other SQLAlchemy-supported databases to provided they support ``row(`` syntax (see below).
        
        Background
        ----------
        
        A lot of people use SQL's ``OFFSET`` syntax to implement paging of query results. The trouble with that is, the more pages you get through, the slower your query gets. Also, if the results you're paging through change frequently, it's possible to skip over or repeat results between pages. Keyset paging avoids these problems: Selecting even the millionth page is as fast as selecting the first.
        
        **sqlakeyset seems to work well so far, but is in its early stages of development, and as such, is alpha software. Treat it accordingly.**
        
        
        Getting Started
        ---------------
        
        Here's how it works with a typical ORM query:
        
        .. code-block:: python
        
            from sqlakeyset import get_page
            from sqlbag import S
        
            from models import Book
        
            with S('postgresql:///books') as s:  # create a session
                q = s.query(Book).order_by(Book.author, Book.title, Book.id)  #
        
                # gets the first page
                page1 = get_page(q, per_page=20)
        
                # gets the key for the next page
                next_page = page1.paging.next
        
                # gets the second page
                page2 = get_page(q, per_page=20, page=next_page)
        
                # returning to the first page, getting the key
                previous_page = page2.paging.previous
        
                # the first page again, backwards from the previous page
                page1 = get_page(q, per_page=20, page=previous_page)
        
                # what if new items were added at the start?
                if page1.paging.has_previous:
        
                    # go back even further
                    previous_page = page1.paging.previous
                    page1 = get_page(q, per_page=20, page=previous_page)
        
        
        Under the Hood
        --------------
        
        sqlakeyset does the following to your query in order to get the paged contents:
        
        - adds a where clause, to get only rows after the specified row key.
        - if getting the previous page, reverses the order by direction in order the get the rows *before* the specified bookmark.
        - adds a limit clause, to fetch only enough items to fill the page, plus one additional (this additional row is used only to test for the existence of further pages after the current one, and is discarded from the results).
        - returns the page contents as an ordinary list that has an attached ``.paging`` attribute with the paging information for this and related pages.
        
        
        Page objects
        ------------
        
        Paged items/rows are returned in a Page object, which is a vanilla python list, except with an attached ``Paging`` object with the paging information.
        
        Properties such as `next` and `previous` return a 2-tuple containing the ordering key for the row, and a boolean to specify if the direction is forwards or backwards.
        
        In our above example, the 2-tuple specifying the second page might look like:
        
        .. code-block:: python
        
            ('Catch 22', 123), False
        
        The `False` means the query will fetch the page *after* the row containing Catch 22. This tuple contains two elements, title and id, to match the order by clause of the query.
        
        The page before this row would be specified as:
        
        .. code-block:: python
        
            ('Catch 22', 123), True
        
        The first and last pages are fetched with `None` instead of a tuple, so for the first page (this is also the default if the page parameter is not specified):
        
        .. code-block:: python
        
            None, False
        
        And the last page:
        
        .. code-block:: python
        
            None, True
        
        Keyset Serialization
        --------------------
        
        You will probably want to turn these keysets/bookmarks for passing around. ``sqlakeyset`` includes code to do this. To get a serialized bookmark, just add ``bookmark_`` to the name of the property that holds the keyset you want.
        
        Most commonly you'll want ``next`` and ``previous``, so:
        
        .. code-block:: python
        
            >>> page.paging.bookmark_previous
            <i:1~i:2015~s:Bad Blood~i:34
            >>> page.paging.bookmark_next
            >i:1~i:2014~s:Shake It Off~i:31
        
        ``sqlakeyset`` uses the python csv row serializer to serialize the bookmark values (using ``~`` instead of a ``,`` as the separator). Direction is indicated by ``>`` (forwards/next), or ``<`` (backwards/previous) at the start of the string.
        
        Limitations
        -----------
        
        - **Golden Rule:** Always ensure your keysets are unique per row. If you violate this condition you risk skipped rows and other nasty problems. The simplest way to do this is to always include your primary key column(s) at the end of your ordering columns.
        
        - If you're using the in-built keyset serialization, this only handles basic data/column types so far (strings, ints, floats, datetimes, dates, booleans, and a few others). The serialization can be extended to serialize more advanced types as necessary (documentation on this is forthcoming).
        
        - **Known MariaDB/MySQL issue:** For performing comparisons, sqlakeyset generates row-value syntax similar to the following:
        
        .. code-block:: sql
        
          where row('a', 1) > row(name, id)
        
        Indexing support for this syntax in MariaDB/MySQL is apparently faulty. So performance on paging large tables may be poor (Meanwhile, PostgreSQL correctly supports indexing for this syntax).
        
        - **sqlakeyset is alpha software** Please be aware that ``sqlakeyset`` is in its early stage of development. That said, please use it! Your feedback is most welcome (good or bad).
        
        
        Documentation
        -------------
        
        ``sqlakeyset`` is in early alpha and documentation other than this README is scarce so far. We are working on remedying this. Watch this space.
        
        
        Installation
        ------------
        
        Assuming you have `pip <https://pip.pypa.io>`_ installed, all you need to do is install as follows:
        
        .. code-block:: shell
        
            $ pip install sqlakeyset
        
        This will install sqlakeyset and also sqlalchemy if not already installed. Obviously you'll need the necessary database driver for your chosen database to be installed also.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
