Oleksandr Shulgin
9386653d72
Update docs on ReplicationCursor
2015-07-01 14:08:32 +02:00
Oleksandr Shulgin
318706f28c
Update docs for Replication protocol
2015-06-30 16:17:31 +02:00
Oleksandr Shulgin
e3c3a2c19e
Merge branch 'master' into feature/replication-message-object
...
Conflicts:
lib/extensions.py
2015-06-30 10:30:32 +02:00
Daniele Varrazzo
925fdf5731
Fixed doc about libpq version availability
2015-06-02 17:11:09 +01:00
btubbs
06b4b1de94
Notify example should pop the oldest message in conn.notifies, not the newest.
2015-06-02 17:07:10 +01:00
Daniele Varrazzo
1f330e9cac
Allow connection.notices and notifies to be replaced.
...
Close #326
2015-06-02 17:02:04 +01:00
Pete Hollobon
5712f30169
Change "non desiderable" to "undesirable" in docs
...
"desiderable" is considered obsolete
2015-06-02 13:00:25 +01:00
Oleksandr Shulgin
cc08e14162
Merge branch 'master' into feature/parse-dsn
...
Conflicts:
lib/extensions.py
2015-06-02 12:42:03 +02:00
Daniele Varrazzo
c2955fb8fc
Version function/constant docs improved
2015-06-02 11:20:02 +01:00
Oleksandr Shulgin
4bb6f9cef2
Add libpq version discovery
2015-06-01 18:05:11 +02:00
Oleksandr Shulgin
6a2f21aa14
Move parse_dsn to extensions, add tests
2015-06-01 15:11:12 +02:00
Oleksandr Shulgin
e32e1b834e
Add support for streaming replication protocol
...
Introduce ReplicationConnection and ReplicationCursor classes, that
incapsulate initiation of special type of PostgreSQL connection and
handling of special replication commands only available in this special
connection mode.
The handling of stream of replication data from the server is modelled
largely after the existing support for "COPY table TO file" command and
pg_recvlogical tool supplied with PostgreSQL (though, it can also be
used for physical replication.)
2015-06-01 11:45:04 +02:00
Oleksandr Shulgin
6c57e4a648
Add parse_dsn module function
...
Calls PQconninfoParse to parse the dsn into a list of keyword and value
structs, then constructs a dictionary from that. Can be useful when one
needs to alter some part of the the connection string reliably, but
doesn't want to get into all the details of parsing a dsn string:
quoting, URL format, etc.
2015-06-01 10:16:07 +02:00
Daniele Varrazzo
1b7e3c6da4
Improve docs about connection's with only closing the transaction
2015-05-03 12:01:06 +01:00
Daniele Varrazzo
4078b89521
Added makefile target to upload docs
2015-05-03 10:30:33 +01:00
Daniele Varrazzo
1d006ccbe9
Added note about table names to be escaped in copy_*() methods.
2015-05-03 10:30:28 +01:00
Daniele Varrazzo
f27ca25d2e
Wordsmith on connection.set_session()
...
Fixes #310 .
2015-05-03 10:30:05 +01:00
Daniele Varrazzo
54ebf90fc6
Document that LO64 is only available on Py 64 builds
2015-02-08 02:21:22 +00:00
Daniele Varrazzo
2332f2c99e
Merge branch 'timetz'
2014-12-25 15:09:15 +01:00
Daniele Varrazzo
c008f9d1ce
Added documentation about the lo64 support
2014-12-25 15:06:18 +01:00
Daniele Varrazzo
6bccb05c90
timetz adaptation documented
2014-12-25 14:57:31 +01:00
Asmund Tokheim
ab4afd0e2f
Correction to type adaption example, making it more transparent
2014-11-02 14:15:51 +01:00
Daniele Varrazzo
48a32b766b
In 2010 I couldn't speak English
2014-09-16 06:57:34 +01:00
Tomer Chachamu
6de7315210
Fix typo in docs
2014-09-01 16:29:38 +01:00
Daniele Varrazzo
8e06a51884
Added plural version of the tickets role
2014-08-31 03:05:03 +01:00
Daniele Varrazzo
7d81c48849
Point tickets to GitHub instead of Lighthouse
...
Keep into account the numbers reshuffling: Lighthouse bugs with a number
matching a GitHub merge request are shifted ahead.
2014-08-31 03:05:03 +01:00
Daniele Varrazzo
4a4e0d8f9a
Self-updating copyright year in docs
2014-08-24 23:07:22 +01:00
Daniele Varrazzo
c1da93a7b2
Document we known 9.4 errorcodes
2014-08-24 22:11:21 +01:00
Daniele Varrazzo
2ad67ee56e
Move the extras
module up in the docs
...
It is more interesting than `tz` and `pool`.
2014-08-24 22:10:24 +01:00
Daniele Varrazzo
843de765a1
Fixed doc example about Error attributes
...
Catch the Error, not everything!
Also, whitespaces.
2014-08-24 22:08:33 +01:00
Daniele Varrazzo
d8bbaf0481
Added info about running the test suite in the docs
...
They were in the INSTALL file, which is quite out-of-date now.
Also fixed a couple of other things.
2014-08-24 02:06:09 +01:00
Daniele Varrazzo
c475a0db95
Document PostgreSQL 9.4 as supported
...
Actually there is a test failing in the test suite in PG 9.4beta2, but
it's probably because the default logging level is to DEBUG. Will wait
for the final release to check if the test is to be fixed. All other
tests pass no problem.
2014-08-13 02:09:04 +01:00
Daniele Varrazzo
f40ad93a37
Added jsonb docs
2014-08-13 02:02:04 +01:00
Daniele Varrazzo
6bca443e37
Added name param to register_json()
2014-08-13 02:01:55 +01:00
Daniele Varrazzo
44281d6692
Fix supported Py/PG versions in docs
2014-08-04 22:39:52 +01:00
Daniele Varrazzo
6d6fd9acf7
Parse errocodes for PG 9.3 too
...
There is no new errcode defined so no need to release this as a change,
only change the docs.
2014-07-31 13:35:04 +01:00
Daniele Varrazzo
40dca9924d
Add a few missing errcodes
...
They are used in the code but not defined in the SGML docs so the script
failed to parse them.
2014-07-31 13:34:53 +01:00
Daniele Varrazzo
abd975ae40
set_session() params documented in a more Python-friendly way
2014-05-05 23:06:23 +01:00
Daniele Varrazzo
09fb131f1a
Don't specify 0 or 1 in closed docs
...
There's also 2 which means broken. But I prefer to leave that as
implementation detail.
2014-04-05 16:03:19 +01:00
Daniele Varrazzo
33f2301772
Clarify in the docs that mogrify() and query always return bytes
2014-04-03 02:46:54 +01:00
Daniele Varrazzo
25e3a5f744
Explicit the fact that closed connections have undefined status
2014-04-03 02:07:38 +01:00
Daniele Varrazzo
212f4e3538
Docs wordsmithing about Range order
2014-02-22 23:01:02 +00:00
Chris Withers
6cd0647da9
documentation changes now that Range objects can be ordered
2014-02-18 21:24:59 +00:00
Daniele Varrazzo
4ed9dc1435
Added doc notes about how to avoid JSON parsing
...
Added FAQ too as it has bitten more than one user
(see tickets #172 , #190 ).
2014-01-14 18:33:05 +00:00
Daniele Varrazzo
6ab1ec1c37
Typo fixes and improvements to new_array_type() docs
2013-10-21 15:27:31 +01:00
Daniele Varrazzo
bc70902ea5
Use bytestrings in infinite dates adapter example
...
Returning strings would result in unclear tracebacks on Py3 (see ticket #163 ).
2013-10-21 14:30:25 +01:00
Daniele Varrazzo
5c99d2a456
Document that named cursors don't raise an exception going out-of-bound
...
See issue #174 for the details.
2013-10-16 19:10:20 +01:00
Daniele Varrazzo
a0a63e3ac7
Document that using %, (, ) in the placeholder name is not supported
2013-10-16 17:50:11 +01:00
Daniele Varrazzo
497247a528
Fixed doc index entry for infinite dates
2013-06-23 02:14:01 +01:00
Daniele Varrazzo
83c5d12cf1
Added doc example to convert date.max to infinity
...
See issue #163 .
2013-06-18 15:00:30 +01:00
Daniele Varrazzo
bbe0bf955c
A few docs fixes to the usage page
2013-05-01 22:40:19 +01:00
Daniele Varrazzo
1ff3ea0745
Dropped a lot of words from the front matter
...
Replaced with links to the types adaptation table and the extension docs.
2013-04-26 10:06:26 +01:00
Piotr Kasprzyk
31b6ec63f8
Fix multiple misspellings
2013-04-26 09:59:40 +01:00
Daniele Varrazzo
884a7f7db6
A couple of typos fixed
2013-04-07 16:05:36 +01:00
Daniele Varrazzo
9e15f54fe8
Added cursor_factory connection attribute and connect() parameter
2013-04-07 02:30:12 +01:00
Daniele Varrazzo
b6873ee1ab
Dropped support for Python 2.4
2013-03-20 23:40:13 +00:00
Daniele Varrazzo
75811f5bb1
Note than Python 3.3 is supported in install docs
2013-03-20 13:08:01 +00:00
Daniele Varrazzo
73949cd1b8
Merge branch 'diagnostics' into devel
2013-03-20 01:47:14 +00:00
Daniele Varrazzo
114c62fac8
Added tests to verify the new Diagnostics properties
...
diag can be used on exceptions raised without cursor and is independent from
the cursor.
Docs updated to reflect the changes.
2013-03-20 00:03:58 +00:00
Daniele Varrazzo
e86efa7e30
Added summary data types conversion table to the docs
...
It allows looking at a glance both basic and extended type casters,
with plenty of links to the detailed explanations.
2013-03-18 19:22:31 +00:00
Daniele Varrazzo
abb3027aa3
NEWS file reformatted to reST and included in the docs
2013-03-18 15:42:10 +00:00
Daniele Varrazzo
93928a7141
Document that errorcodes is updated to 9.2
2013-03-18 15:10:24 +00:00
Daniele Varrazzo
ae918c34b8
Copyright year bumped to 2013 in docs footer
2013-03-18 15:10:06 +00:00
Daniele Varrazzo
97311967e8
Merge branch 'diagnostics' into devel
2013-03-18 02:21:09 +00:00
Daniele Varrazzo
678f0dc949
Added documentation about the Diagnostics object
2013-03-18 02:11:45 +00:00
Daniele Varrazzo
e1ff432f4c
Merge branch 'dead-bytes' into devel
2013-03-16 16:25:17 +00:00
Idan Kamara
7f86529183
docs: grammar fix in extras.rst
2013-03-06 11:36:32 +02:00
Daniele Varrazzo
e8db9954d1
Improvements to the connect() docs
...
- links updated to the current PG docs, which include the syntax as url
and lists the parameters in a separate chapter
- more evident links to the PG docs
- mutually exclusive use of dsn and **kwargs specified
See ticket #143
2013-01-09 12:56:06 +00:00
Daniele Varrazzo
49af4fe539
Fixed interactive sessions docs examples
2013-01-09 03:10:32 +00:00
Daniele Varrazzo
c2f284cd3b
Added documentation for the with statement
2012-12-03 03:18:51 +00:00
Daniele Varrazzo
8e08aeb690
Dropped Zope support
2012-12-03 02:53:20 +00:00
Daniele Varrazzo
02ffb7423a
Splitting the release of new features in version 2.5
2012-12-03 00:39:19 +00:00
Daniele Varrazzo
896ad7c827
Fixed a couple of terms in the docs
...
After Pierre-Louis Bonicoli's suggestions in ticket #138 .
2012-11-12 01:32:38 +00:00
Daniele Varrazzo
10476200fd
Added note about the adapted attribute in the module-level wrappers
...
Specifying it otherwise people expects the wrappers to have full datetime
semantics: see ticket #136 .
2012-10-27 22:24:48 +01:00
Daniele Varrazzo
6b8861d2d5
Clarification in copy_expert docs
...
Closes ticket #134 .
2012-10-15 00:47:22 +01:00
Daniele Varrazzo
ee763e0f47
Copyright bumped to 2012 in docs pages
2012-10-07 13:14:31 +01:00
Daniele Varrazzo
a666432329
Docs front page adjustments
2012-10-07 02:07:47 +01:00
Daniele Varrazzo
82dc32cebd
Added install section to the manual
2012-10-07 02:04:39 +01:00
Daniele Varrazzo
4244d5953a
Merge branch 'range-type' into devel
2012-09-27 00:48:05 +01:00
Daniele Varrazzo
dda24f082f
Merge branch 'json' into devel
2012-09-27 00:41:04 +01:00
Daniele Varrazzo
33043cd038
Merge branch 'composite-custom' into devel
2012-09-27 00:38:00 +01:00
Daniele Varrazzo
f70e6a1519
Grammar correction for RangeCaster.array_typecaster
2012-09-24 12:13:46 +01:00
Daniele Varrazzo
71e2f190c2
Json documentation improved
2012-09-24 11:51:35 +01:00
Daniele Varrazzo
c756d580f2
Added documentation for range types and adaptation
2012-09-24 00:49:44 +01:00
Daniele Varrazzo
9949e04c70
Added schema attribute to CompositeCaster
2012-09-22 15:10:40 +01:00
Daniele Varrazzo
59151886a0
Info about hstore versions history moved from code to docs
2012-09-22 02:10:58 +01:00
Daniele Varrazzo
26cfdc1234
Info about versions history moved from code to docs
2012-09-22 02:08:21 +01:00
Daniele Varrazzo
fa9393b587
Added documentation about CompositeCaster subclassing
2012-09-22 02:01:04 +01:00
Daniele Varrazzo
7386b8327c
Dropped keywords passthrough in Json adapter
...
Pass a dumps function instead. Allow customizing by either arg passing or
subclassing.
The basic Json class now raises ImportError on getquoted() if json is not
available, thus allowing using a customized Json subclass even when the json
module is not available.
2012-09-19 16:32:57 +01:00
Daniele Varrazzo
d963b478e2
Added register_default_json() function
...
Register a typecaster for PostgreSQL 9.2 json.
2012-09-19 15:49:00 +01:00
Daniele Varrazzo
024f0dbada
Added json typecaster
2012-09-19 04:26:35 +01:00
Daniele Varrazzo
b8e7f02256
Added Json adapter
2012-09-19 04:12:20 +01:00
Daniele Varrazzo
64e3e1199e
Fixed note on rollback on close in the doc
...
It's not like we call "rollback()": we close the connection and the
backend rolls back on its own. It may have differences, e.g. conn poolers.
2012-09-18 12:54:41 +01:00
Daniele Varrazzo
9ae4bbd195
Fixed smell of pizza in the docs
2012-09-18 12:54:41 +01:00
Daniele Varrazzo
99b7683338
Added documentation for scrollable cursors
2012-08-15 11:26:45 +01:00
Daniele Varrazzo
8666693512
Fixed incorrect and outdated connection.commit() doc
2012-07-27 17:44:28 +01:00
Brian Sutherland
2371166383
grammar
2012-07-27 12:48:28 +03:00
Daniele Varrazzo
3559ea0d10
Fixed typo in docs
...
Ticket #115 closed.
2012-07-08 22:52:24 +01:00
Daniele Varrazzo
08c8b62e1b
Added %% use to the docs
2012-05-29 23:53:02 +01:00
Daniele Varrazzo
291b4ce81f
Fixed text docs build on Python 3
...
Thanks to Arfrever for the patch (ticket #107 ).
2012-04-11 18:18:40 +01:00
Daniele Varrazzo
67064f8e03
All the FAQ have they own id that can be used in URLs to refer to
2012-03-09 16:55:02 +00:00
Daniele Varrazzo
5473d50a09
Added more information about the case of the missing lo_truncate
...
After some ML message and ticket #104 .
2012-03-09 16:55:02 +00:00
Marti Raudsepp
b97599166e
Update all links to PostgreSQL docs to the current version.
...
I also checked all links and anchors to make sure they're still valid.
2012-02-28 18:28:07 +02:00
Daniele Varrazzo
a165f86127
Added docs about how to create a generic array typecaster
2012-02-24 00:33:28 +00:00
Daniele Varrazzo
0c337a2029
Added support for inet array
2012-02-23 23:56:55 +00:00
Daniele Varrazzo
4e1d96082a
Typos fixed in copy methods
2012-02-23 14:41:41 +00:00
Daniele Varrazzo
78895e6943
Added doc for Error.cursor
2012-01-19 01:30:46 +00:00
Daniele Varrazzo
3094371621
Fixed doc for supported PG versions in errorcodes table
2011-12-16 12:37:38 +00:00
Daniele Varrazzo
08fa6550ab
Docs typo fixed
2011-12-16 11:09:20 +00:00
Daniele Varrazzo
c3914b8aa2
Improvements to the docs homepage after Bucko's proofreading
2011-12-15 22:13:20 +00:00
Daniele Varrazzo
9e8fc349b9
Docs homepage refreshed with new bragging and links
2011-12-15 21:42:08 +00:00
Daniele Varrazzo
2cf35b69de
'register_composite()' also works with tables
...
Skip dropped and hidden columns when inspecting the schema.
2011-12-15 20:11:17 +00:00
Daniele Varrazzo
088978e7b1
Typo fixed writeable -> writable
...
Closes ticket #79 .
2011-12-11 02:55:29 +00:00
Daniele Varrazzo
d2b67364fd
connect() supports generic keyword arguments passed to the dsn
2011-11-17 01:51:25 +00:00
Daniele Varrazzo
4254fb8566
Documentation for the isolation level constants updated
...
REPEATABLE READ and SERIALIZABLE are no more synonyms since PostgreSQL 9.1,
and in Psycopg values are different since 2.4.2.
2011-11-17 00:41:44 +00:00
Daniele Varrazzo
00b52c78b3
Docs cleanup by Josh Kupershmidt
2011-11-01 07:09:51 +00:00
Daniele Varrazzo
83d457361e
Fixed docs for the copy null parameter
2011-10-20 11:12:05 +01:00
Daniele Varrazzo
3e39b23835
Notice -> Note in the docs, and a handful of other typo fixed
2011-10-14 23:59:49 +01:00
Daniele Varrazzo
37a9eb3615
Test and document the named cursor stealing technique
2011-10-14 23:17:24 +01:00
Daniele Varrazzo
6da39e3a37
Fixed pasto in docs
2011-10-06 18:38:30 +01:00
Daniele Varrazzo
e3054ac9f3
Added new_array_type() function
...
Allows the creation of a generic array typecaster from Python.
2011-09-22 15:51:21 +01:00
Daniele Varrazzo
6c8051907c
Fixed doc blocks
...
Raise error with docutils 0.8.1. Probably docutils 0.7 was more lenient.
2011-09-22 15:50:50 +01:00
Federico Di Gregorio
880aa07a58
WITH HOLD documentation a argument parsing changes
...
Now any true value will do for the withhold parameter.
2011-08-10 19:21:12 +02:00
Daniele Varrazzo
11ff27b5af
Added documentation for putconn's close parameter
2011-08-09 11:44:30 +01:00
Daniele Varrazzo
30a046c602
Fixed adaptation doc example
...
Close ticket #63
2011-07-24 20:42:23 +01:00
Federico Di Gregorio
3ec9677978
Aligned casing of isolation levels with PostgreSQL documentation
2011-06-12 21:40:31 +02:00
Daniele Varrazzo
d76d136b4f
Introductory docs section on transaction control improved
...
Added big fat warning about idle in transaction and reference to
set_session().
2011-06-08 14:38:57 +01:00
Daniele Varrazzo
d2b28abced
Method set_transaction() renamed to set_session()
...
In fact it doesn't change "the transaction", as there has to be no
transaction when invoked. The effect instead is to execute SET SESSION
CHARACTERISTICS.
2011-06-08 14:22:11 +01:00
Daniele Varrazzo
6d907df14d
Fixed documentation for COPY methods
...
The size parameter in copy_from was undocumented (ticket #59 ).
2011-06-07 11:16:10 +01:00
Daniele Varrazzo
8f876d4b5d
Avoid a deadlock using concurrent green threads on the same connection
...
Use the async_cursor property to store an indication that something is
running (even if it is not necessarily a cursor running the query).
2011-06-05 16:22:54 +01:00
Daniele Varrazzo
530ba78881
Documentation for set_transaction() and autocommit improved
2011-06-03 01:46:56 +01:00
Daniele Varrazzo
a69facc7f0
Adding docs for the planned set_transaction/autocommit features
2011-05-31 00:05:50 +01:00
Daniele Varrazzo
da58bee70a
Added documentation for the bytea parser
2011-03-26 12:59:15 +00:00
Daniele Varrazzo
5211e1474b
Don't limit the hstore search to the public schema only
...
Looks like there is a case for installing hstore somewhere else (see
ticket #45 ). And after all the typecaster can be registered on a list of
OIDs, so let's grab them all.
2011-02-25 00:19:49 +00:00
Daniele Varrazzo
894d3f653c
Raise an exception if the libpq fails to decode bytea in hex format
2011-02-23 14:04:27 +00:00
Daniele Varrazzo
1db9c9b8ce
The cursor name can be a non-valid PostgreSQL identifier
2011-02-23 01:53:25 +00:00
Daniele Varrazzo
556b4d461e
Documentation cleanup
...
Added several links to the Python documentation using the 'intersphinx'
extension.
2011-02-19 16:16:28 +00:00
Daniele Varrazzo
d263ecfee7
Display a note as a note in the cursor.lastrowid docs
2011-02-19 00:52:26 +00:00
Daniele Varrazzo
1f7774bd4e
Cursor docs reordered
...
'cast()' moved in the retrieval functions. Methods only defined for
DBAPI compliance moved to the bottom.
2011-02-19 00:44:24 +00:00
Daniele Varrazzo
c620f18be1
Provide cursor.description as named tuple if possible
...
If namedtuple() is not available, use regular tuples.
2011-02-19 00:05:43 +00:00
Daniele Varrazzo
c76cace2ef
Improved documentation for cursor.description
...
Describe what actually happens between Psycopg and PostgreSQL, not the
basic template copied from the DBAPI.
2011-02-17 13:38:18 +00:00
Daniele Varrazzo
63ac6cdde5
Added cursor.itersize
...
The value is used to control the number of records to fetch per network
roundtrip in named cursors iteration. Used to avoid the inefficient
arraysize default of 1 without giving this value the magic meaning of
2000.
2011-02-17 12:36:02 +00:00
Daniele Varrazzo
3b10ef8998
Documentation about new support for binary objects improved
2011-02-16 02:54:30 +00:00
Daniele Varrazzo
3ae2f221b3
Adapt bytearray and memoryview to bytes if available
2011-02-15 17:30:43 +00:00
Daniele Varrazzo
522af403c6
Added FAQ entry about the PYTHON_EGG_CACHE problem
2011-02-15 12:50:37 +00:00
Daniele Varrazzo
d4eb28aed5
Dropped reference to release 2.3.3 in the docs
2011-02-15 11:00:08 +00:00
Daniele Varrazzo
1a0c494417
Document difference of string handling in Python 2/3
2011-02-10 02:16:55 +00:00
Daniele Varrazzo
713b86acdf
Added FAQ point about bytea_output in PostgreSQL 9.0
2011-02-10 02:16:55 +00:00
Daniele Varrazzo
9c81f6c186
Improved adaptation documentation
...
Documented __conform__() and prepare().
2011-02-10 02:16:24 +00:00
Federico Di Gregorio
da27142882
Merge branch 'python3' into python2
2011-02-06 16:47:05 +01:00