Author: cito
Date: Sun Jan 10 06:43:51 2016
New Revision: 707
Log:
Add version information for new/changed features to docs
Modified:
branches/4.x/docs/conf.py
branches/4.x/docs/contents/pg/connection.rst
branches/4.x/docs/contents/pg/db_wrapper.rst
branches/4.x/docs/contents/pg/module.rst
branches/4.x/docs/contents/pg/query.rst
branches/4.x/docs/contents/pgdb/cursor.rst
branches/4.x/docs/copyright.rst
Modified: branches/4.x/docs/conf.py
==============================================================================
--- branches/4.x/docs/conf.py Sat Jan 9 17:53:44 2016 (r706)
+++ branches/4.x/docs/conf.py Sun Jan 10 06:43:51 2016 (r707)
@@ -50,7 +50,7 @@
# General information about the project.
project = u'PyGreSQL'
author = u'The PyGreSQL Team'
-copyright = u'2015, ' + author
+copyright = u'2016, ' + author
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Modified: branches/4.x/docs/contents/pg/connection.rst
==============================================================================
--- branches/4.x/docs/contents/pg/connection.rst Sat Jan 9 17:53:44
2016 (r706)
+++ branches/4.x/docs/contents/pg/connection.rst Sun Jan 10 06:43:51
2016 (r707)
@@ -143,6 +143,9 @@
that has been sent with the notification. Remember to do a listen query
first, otherwise :meth:`pgobject.getnotify` will always return ``None``.
+.. versionchanged:: 4.1
+ Support for payload strings was added in version 4.1.
+
inserttable -- insert a list into a table
-----------------------------------------
@@ -184,6 +187,8 @@
been set with :meth:`pgobject.set_notice_receiver`, or ``None`` if no
custom notice receiver has ever been set on the connection.
+.. versionadded:: 4.1
+
.. method:: pgobject.set_notice_receiver(proc)
Set a custom notice receiver
@@ -224,6 +229,8 @@
an optional suggestion what to do about the problem
+.. versionadded:: 4.1
+
putline -- write a line to the server socket [DA]
-------------------------------------------------
@@ -349,10 +356,14 @@
the frontend/backend protocol being used (int)
+.. versionadded:: 4.0
+
.. attribute:: pgobject.server_version
the backend version (int, e.g. 80305 for 8.3.5)
+.. versionadded:: 4.0
+
.. attribute:: pgobject.status
the status of the connection (int: 1 = OK, 0 = bad)
Modified: branches/4.x/docs/contents/pg/db_wrapper.rst
==============================================================================
--- branches/4.x/docs/contents/pg/db_wrapper.rst Sat Jan 9 17:53:44
2016 (r706)
+++ branches/4.x/docs/contents/pg/db_wrapper.rst Sun Jan 10 06:43:51
2016 (r707)
@@ -271,20 +271,42 @@
The return value is the number of deleted rows (i.e. 0 if the row did not
exist and 1 if the row was deleted).
-escape_string -- escape a string for use within SQL
----------------------------------------------------
+escape_literal -- escape a literal string for use within SQL
+------------------------------------------------------------
-.. method:: DB.escape_string(string)
+.. method:: DB.escape_literal(string)
- Escape a string for use within SQL
+ Escape a string for use within SQL as a literal constant
:param str string: the string that is to be escaped
:returns: the escaped string
:rtype: str
-Similar to the module function with the same name, but the
-behavior of this method is adjusted depending on the connection properties
-(such as character encoding).
+This method escapes a string for use within an SQL command. This is useful
+when inserting data values as literal constants in SQL commands. Certain
+characters (such as quotes and backslashes) must be escaped to prevent them
+from being interpreted specially by the SQL parser.
+
+.. versionadded:: 4.1
+
+escape_identifier -- escape an identifier string for use within SQL
+-------------------------------------------------------------------
+
+.. method:: DB.escape_identifier(string)
+
+ Escape a string for use within SQL as an identifier
+
+ :param str string: the string that is to be escaped
+ :returns: the escaped string
+ :rtype: str
+
+This method escapes a string for use as an SQL identifier, such as a table,
+column, or function name. This is useful when a user-supplied identifier
+might contain special characters that would otherwise not be interpreted
+as part of the identifier by the SQL parser, or when the identifier might
+contain upper case characters whose case should be preserved.
+
+.. versionadded:: 4.1
escape_bytea -- escape binary data for use within SQL
-----------------------------------------------------
@@ -313,3 +335,22 @@
:rtype: str
See the module function with the same name.
+
+use_regtypes -- determine use of regular type names
+---------------------------------------------------
+
+.. method:: DB.use_regtypes([regtypes])
+
+ Determine whether regular type names shall be used
+
+ :param bool regtypes: if passed, set whether regular type names shall be
used
+ :returns: whether regular type names are used
+
+The :meth:`DB.get_attnames` method can return either simplified "classic"
+type names (the default) or more specific "regular" type names. Which kind
+of type names is used can be changed by calling :meth:`DB.get_regtypes`.
+If you pass a boolean, it sets whether regular type names shall be used.
+The method can also be used to check through its return value whether
+currently regular type names are used.
+
+.. versionadded:: 4.1
Modified: branches/4.x/docs/contents/pg/module.rst
==============================================================================
--- branches/4.x/docs/contents/pg/module.rst Sat Jan 9 17:53:44 2016
(r706)
+++ branches/4.x/docs/contents/pg/module.rst Sun Jan 10 06:43:51 2016
(r707)
@@ -383,6 +383,8 @@
value of ``None`` means monetary values are not interpreted as decimal
numbers, but returned as strings including the formatting and currency.
+.. versionadded:: 4.1.1
+
.. function:: set_decimal_point(string)
Specify which decimal mark is used for interpreting monetary values
@@ -400,6 +402,8 @@
cause PyGreSQL to return monetary values as strings including their
formatting and currency.
+.. versionadded:: 4.1.1
+
get/set_bool -- whether boolean values are returned as bool objects
-------------------------------------------------------------------
@@ -416,6 +420,8 @@
conversion to bool objects is not activated, but you can enable
this with the ``set_bool()`` method.
+.. versionadded:: 4.2
+
.. function:: set_bool(on)
Set whether boolean values are returned as bool objects
@@ -428,6 +434,8 @@
By default, conversion to bool objects is not activated, but you can
enable this by calling ``set_bool(True)``.
+.. versionadded:: 4.2
+
get/set_namedresult -- conversion to named tuples
-------------------------------------------------
Modified: branches/4.x/docs/contents/pg/query.rst
==============================================================================
--- branches/4.x/docs/contents/pg/query.rst Sat Jan 9 17:53:44 2016
(r706)
+++ branches/4.x/docs/contents/pg/query.rst Sun Jan 10 06:43:51 2016
(r707)
@@ -56,6 +56,8 @@
This method returns the list of the values returned by the query
with each row returned as a named tuple with proper field names.
+.. versionadded:: 4.1
+
listfields -- list fields names of previous query result
--------------------------------------------------------
Modified: branches/4.x/docs/contents/pgdb/cursor.rst
==============================================================================
--- branches/4.x/docs/contents/pgdb/cursor.rst Sat Jan 9 17:53:44 2016
(r706)
+++ branches/4.x/docs/contents/pgdb/cursor.rst Sun Jan 10 06:43:51 2016
(r707)
@@ -196,6 +196,8 @@
cur = DictCursor(con)
+.. versionadded:: 4.0
+
arraysize - the number of rows to fetch at a time
-------------------------------------------------
Modified: branches/4.x/docs/copyright.rst
==============================================================================
--- branches/4.x/docs/copyright.rst Sat Jan 9 17:53:44 2016 (r706)
+++ branches/4.x/docs/copyright.rst Sun Jan 10 06:43:51 2016 (r707)
@@ -10,7 +10,7 @@
Further modifications copyright (c) 1997-2008 by D'Arcy J.M. Cain
([email protected])
-Further modifications copyright (c) 2009-2015 by the PyGreSQL team.
+Further modifications copyright (c) 2009-2016 by the PyGreSQL team.
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose, without fee, and without a written agreement
_______________________________________________
PyGreSQL mailing list
[email protected]
https://mail.vex.net/mailman/listinfo.cgi/pygresql
