Mercurial > p > roundup > code
annotate doc/postgresql.txt @ 5639:f576957cbb1f
Add support for prev/next/self links when returning paginated results.
To do this:
1) change "data" envelope from an array to a dict
2) move the "data" array to the "collection" property,
which is an array of elements in the collection.
3) add @links dict keyed by link relation: self, next, prev.
Each relation is an array of dicts with uri and rel keys.
In this case there is only one element, but there is nothing
preventing a relation from having multiple url's. So this follows
the formatting needed for the general case.
Relations are present only if it makes sense. So first page has no
prev and last page has no next.
4) add @total_size with number of element selected if they were
not paginated. Replicates data in X-Count-Total header.
Changed index to start at 1. So the first page is page_index 1 and not
page_index 0. (So I am no longer surprised when I set page_index to 1
and am missing a bunch of records 8-)).
Also a small fixup, json response ends with a newline so printing
the data, or using curl makes sure that anything printing after the
json output (like shell prompts) is on a new line.
Tests added for all cases.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 09 Mar 2019 11:06:10 -0500 |
| parents | 76b71c9bd50d |
| children | e48b039b0ec0 |
| rev | line source |
|---|---|
|
1873
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1 ========================== |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 PostgreSQL/psycopg Backend |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ========================== |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
|
3059
213468d6e7c9
Add installation documentation for tsearch2.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
2860
diff
changeset
|
5 This are notes about PostqreSQL backend based on the psycopg adapter for |
|
213468d6e7c9
Add installation documentation for tsearch2.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
2860
diff
changeset
|
6 Roundup issue tracker. |
|
1873
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 Prerequisites |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 ============= |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 To use PostgreSQL as backend for storing roundup data, you should |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 additionally install: |
|
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
4718
76b71c9bd50d
Updated recommended version infos for psycopg and PostgreSQL.
Bernhard Reiter <bernhard@intevation.de>
parents:
4513
diff
changeset
|
14 1. PostgreSQL 8.x or higher - http://www.postgresql.org/ |
|
1873
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 |
|
1875
3ffb7b56172a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1873
diff
changeset
|
16 2. The psycopg python interface to PostgreSQL: |
|
3666
8304a1c1cc98
encourage use of latest psycopg
Richard Jones <richard@users.sourceforge.net>
parents:
3500
diff
changeset
|
17 |
|
8304a1c1cc98
encourage use of latest psycopg
Richard Jones <richard@users.sourceforge.net>
parents:
3500
diff
changeset
|
18 http://initd.org/software/initd/psycopg |
|
8304a1c1cc98
encourage use of latest psycopg
Richard Jones <richard@users.sourceforge.net>
parents:
3500
diff
changeset
|
19 |
|
1873
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 |
|
1906
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
21 Running the PostgreSQL unit tests |
|
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
22 ================================= |
|
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
23 |
|
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
24 The user that you're running the tests as will need to be able to access |
|
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
25 the postgresql database on the local machine and create and drop |
|
4513
6a32a2fb95b4
Docs update for mysql and postgresl: Mentioned test/db_test_base.py because
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4512
diff
changeset
|
26 databases. See the config values in 'test/db_test_base.py' |
|
6a32a2fb95b4
Docs update for mysql and postgresl: Mentioned test/db_test_base.py because
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents:
4512
diff
changeset
|
27 about which database connection, name and user will be used. |
|
1906
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
28 |
|
f255363e6d97
PostgreSQL backend lands.
Richard Jones <richard@users.sourceforge.net>
parents:
1875
diff
changeset
|
29 |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
1906
diff
changeset
|
30 Credit |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
1906
diff
changeset
|
31 ====== |
|
1873
f63aa57386b0
Backend improvements.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 |
|
2594
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
1906
diff
changeset
|
33 The postgresql backend was originally submitted by Federico Di Gregorio |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
1906
diff
changeset
|
34 <fog@initd.org> |
|
c0d6d5004464
rdbms doc updates
Richard Jones <richard@users.sourceforge.net>
parents:
1906
diff
changeset
|
35 |
