Changeset 707


Ignore:
Timestamp:
Jan 10, 2016, 6:43:51 AM (4 years ago)
Author:
cito
Message:

Add version information for new/changed features to docs

Location:
branches/4.x/docs
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • branches/4.x/docs/conf.py

    r695 r707  
    5151project = u'PyGreSQL'
    5252author = u'The PyGreSQL Team'
    53 copyright = u'2015, ' + author
     53copyright = u'2016, ' + author
    5454
    5555# The version info for the project you're documenting, acts as replacement for
  • branches/4.x/docs/contents/pg/connection.rst

    r695 r707  
    144144first, otherwise :meth:`pgobject.getnotify` will always return ``None``.
    145145
     146.. versionchanged:: 4.1
     147    Support for payload strings was added in version 4.1.
     148
    146149inserttable -- insert a list into a table
    147150-----------------------------------------
     
    184187been set with :meth:`pgobject.set_notice_receiver`, or ``None`` if no
    185188custom notice receiver has ever been set on the connection.
     189
     190.. versionadded:: 4.1
    186191
    187192.. method:: pgobject.set_notice_receiver(proc)
     
    225230        an optional suggestion what to do about the problem
    226231
     232.. versionadded:: 4.1
     233
    227234putline -- write a line to the server socket [DA]
    228235-------------------------------------------------
     
    350357   the frontend/backend protocol being used (int)
    351358
     359.. versionadded:: 4.0
     360
    352361.. attribute:: pgobject.server_version
    353362
    354363   the backend version (int, e.g. 80305 for 8.3.5)
    355364
     365.. versionadded:: 4.0
     366
    356367.. attribute:: pgobject.status
    357368
  • branches/4.x/docs/contents/pg/db_wrapper.rst

    r695 r707  
    272272exist and 1 if the row was deleted).
    273273
    274 escape_string -- escape a string for use within SQL
    275 ---------------------------------------------------
    276 
    277 .. method:: DB.escape_string(string)
    278 
    279     Escape a string for use within SQL
     274escape_literal -- escape a literal string for use within SQL
     275------------------------------------------------------------
     276
     277.. method:: DB.escape_literal(string)
     278
     279    Escape a string for use within SQL as a literal constant
    280280
    281281    :param str string: the string that is to be escaped
     
    283283    :rtype: str
    284284
    285 Similar to the module function with the same name, but the
    286 behavior of this method is adjusted depending on the connection properties
    287 (such as character encoding).
     285This method escapes a string for use within an SQL command. This is useful
     286when inserting data values as literal constants in SQL commands. Certain
     287characters (such as quotes and backslashes) must be escaped to prevent them
     288from being interpreted specially by the SQL parser.
     289
     290.. versionadded:: 4.1
     291
     292escape_identifier -- escape an identifier string for use within SQL
     293-------------------------------------------------------------------
     294
     295.. method:: DB.escape_identifier(string)
     296
     297    Escape a string for use within SQL as an identifier
     298
     299    :param str string: the string that is to be escaped
     300    :returns: the escaped string
     301    :rtype: str
     302
     303This method escapes a string for use as an SQL identifier, such as a table,
     304column, or function name. This is useful when a user-supplied identifier
     305might contain special characters that would otherwise not be interpreted
     306as part of the identifier by the SQL parser, or when the identifier might
     307contain upper case characters whose case should be preserved.
     308
     309.. versionadded:: 4.1
    288310
    289311escape_bytea -- escape binary data for use within SQL
     
    314336
    315337See the module function with the same name.
     338
     339use_regtypes -- determine use of regular type names
     340---------------------------------------------------
     341
     342.. method:: DB.use_regtypes([regtypes])
     343
     344    Determine whether regular type names shall be used
     345
     346    :param bool regtypes: if passed, set whether regular type names shall be used
     347    :returns: whether regular type names are used
     348
     349The :meth:`DB.get_attnames` method can return either simplified "classic"
     350type names (the default) or more specific "regular" type names. Which kind
     351of type names is used can be changed by calling :meth:`DB.get_regtypes`.
     352If you pass a boolean, it sets whether regular type names shall be used.
     353The method can also be used to check through its return value whether
     354currently regular type names are used.
     355
     356.. versionadded:: 4.1
  • branches/4.x/docs/contents/pg/module.rst

    r695 r707  
    384384numbers, but returned as strings including the formatting and currency.
    385385
     386.. versionadded:: 4.1.1
     387
    386388.. function:: set_decimal_point(string)
    387389
     
    401403formatting and currency.
    402404
     405.. versionadded:: 4.1.1
     406
    403407get/set_bool -- whether boolean values are returned as bool objects
    404408-------------------------------------------------------------------
     
    417421this with the ``set_bool()`` method.
    418422
     423.. versionadded:: 4.2
     424
    419425.. function:: set_bool(on)
    420426
     
    428434By default, conversion to bool objects is not activated, but you can
    429435enable this by calling ``set_bool(True)``.
     436
     437.. versionadded:: 4.2
    430438
    431439get/set_namedresult -- conversion to named tuples
  • branches/4.x/docs/contents/pg/query.rst

    r695 r707  
    5656This method returns the list of the values returned by the query
    5757with each row returned as a named tuple with proper field names.
     58
     59.. versionadded:: 4.1
    5860
    5961listfields -- list fields names of previous query result
  • branches/4.x/docs/contents/pgdb/cursor.rst

    r696 r707  
    197197    cur = DictCursor(con)
    198198
     199.. versionadded:: 4.0
     200
    199201arraysize - the number of rows to fetch at a time
    200202-------------------------------------------------
  • branches/4.x/docs/copyright.rst

    r695 r707  
    1111(darcy@PyGreSQL.org)
    1212
    13 Further modifications copyright (c) 2009-2015 by the PyGreSQL team.
     13Further modifications copyright (c) 2009-2016 by the PyGreSQL team.
    1414
    1515Permission to use, copy, modify, and distribute this software and its
Note: See TracChangeset for help on using the changeset viewer.