Skip to content

Fix documentation of SortKey namedtuple. #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix documentation of SortKey namedtuple. #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ Full API
:members:


.. autoclass:: multicorn.SortKey

.. autoclass:: multicorn.Qual
:members:

Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ sphinx
sphinxcontrib-napoleon
mock
sqlalchemy
funcsigs
18 changes: 18 additions & 0 deletions python/multicorn/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,24 @@
["attname", "attnum", "is_reversed",
"nulls_first", "collate"])

"""
A SortKey describes the sort of one column an SQL query requested.

A query can request the sort of zero, one or multiple columns. Therefore, a list
of SortKey is provided to the ForeignDataWrapper, containing zero, one or more
SortKey.

Attributes:
attname(str): The name of the column to sort as defined in the postgresql
table.
attnum(int): The position of the column to sort as defined in the
postgresql table.
is_reversed(bool): True is the query requested a DESC order.
nulls_first(bool): If True, NULL values must appears at the beginning.
Otherwise, they must appear at the end.
collate(str): The collation name to use to sort the data, as appearing
in the postgresql cluster.
"""

class Qual(object):
"""A Qual describes a postgresql qualifier.
Expand Down