autodoc.git / modref.xml

autodoc.git/modref.xml:127144:    discouraged.</p>   </text><group><param name='host'/><text><p>Should either contain <expr>"hostname"</expr> or    <expr>"hostname:portname"</expr>. This allows you to specify the TCP/IP    port to connect to. If the parameter is <expr>0</expr> or <expr>""</expr>,    it will try to connect to localhost, default port.</p>   </text></group><group><param name='database'/><text><p>Specifies the database to connect to. Not specifying this is    only supported if the PostgreSQL backend has a default database    configured. If you do not want to connect to any live database,    you can use <expr>"template1"</expr>.</p>   </text></group><group><param name='options'/><text><p>Currently supports at least the following:</p> - <mapping><group><member><type><int/></type><index>"reconnect"</index></member><text><p>Set it to zero to disable automatic reconnects upon losing -  the connection to the database. Not setting it, or setting -  it to one, will cause one timed reconnect to take place. -  Setting it to -1 will cause the system to try and reconnect -  indefinitely.</p> - </text></group><group><member><type><int/></type><index>"use_ssl"</index></member><text><p>If the database supports and allows SSL connections, the session + <mapping><group><member><type><int/></type><index>"use_ssl"</index></member><text><p>If the database supports and allows SSL connections, the session    will be SSL encrypted, if not, the connection will fallback    to plain unencrypted.</p>   </text></group><group><member><type><int/></type><index>"force_ssl"</index></member><text><p>If the database supports and allows SSL connections, the session    will be SSL encrypted, if not, the connection will abort.</p>   </text></group><group><member><type><int/></type><index>"text_query"</index></member><text><p>Send queries to and retrieve results from the database using text    instead of the, generally more efficient, default native binary method.    Turning this on will allow multiple statements per query separated    by semicolons.</p>   </text></group><group><member><type><int/></type><index>"sync_parse"</index></member><text><p>Set it to zero to turn synchronous parsing off for statements.    Setting this to off can cause surprises because statements could
autodoc.git/modref.xml:127285:    Only available if PG_STATS is compile-time enabled.</p>   </text></group><group><member><type><int/></type><index>"current_prepared_statements"</index></member><text><p>Cache size of currently prepared statements.</p>   </text></group><group><member><type><int/></type><index>"current_prepared_statement_hits"</index></member><text><p>Sum of the number hits on statements in the current statement cache.</p>   </text></group><group><member><type><int/></type><index>"prepared_statement_count"</index></member><text><p>Total number of prepared statements generated.</p>   </text></group><group><member><type><int/></type><index>"portals_opened_count"</index></member><text><p>Total number of portals opened, i.e. number of statements issued    to the database.    Only available if PG_STATS is compile-time enabled.</p>   </text></group><group><member><type><int/></type><index>"bytes_received"</index></member><text><p>Total number of bytes received from the database so far.</p>   </text></group><group><member><type><int/></type><index>"messages_received"</index></member><text><p>Total number of messages received from the database (one SQL-statement    requires multiple messages to be exchanged).</p> - </text></group><group><member><type><int/></type><index>"reconnect_count"</index></member><text><p>Number of times the connection to the database has been lost.</p> +    </text></group><group><member><type><int/></type><index>"portals_in_flight"</index></member><text><p>Currently still open portals, i.e. running statements.</p>   </text></group></mapping>   </text></group><group><note/><text><p>This function is PostgreSQL-specific, and thus it is not available    through the generic SQL-interface.</p>   </text></group></doc>   <method name='getstatistics'><modifiers><final/></modifiers>   <arguments/>   <returntype><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></returntype>   </method>   </docgroup>
autodoc.git/modref.xml:127367:   </text></group><group><param name='glob'/><text><p>If specified, list only the tables with matching names.</p>   </text></group></doc>   <method name='list_tables'><modifiers><final/></modifiers>   <arguments><argument name='glob'><type><or><void/><string/></or></type></argument></arguments>   <returntype><array><valuetype><string/></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='ping' homogen-type='method'><doc><text><p>Check whether the connection is alive.</p>   </text><group><returns/><text><p>Returns one of the following:</p>   <int><group><value>0</value><text><p>Everything ok.</p> - </text></group><group><value>1</value><text><p>The connection has reconnected automatically.</p> +    </text></group><group><value>-1</value><text><p>The server has gone away, and the connection is dead.</p>   </text></group></int>   </text></group><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.is_open'>is_open()</ref></p>   </text></group></doc>   <method name='ping'><modifiers><final/></modifiers>   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='quote' homogen-type='method'><doc><group><returns/><text><p>The given string, but escapes/quotes all contained magic characters
autodoc.git/modref.xml:127426:   </text><group><note/><text><p>This function <b>can</b> raise exceptions.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.cancelquery'>cancelquery()</ref>, <ref resolved='predef::Sql.pgsql.reload'>reload()</ref></p>   </text></group><group><note/><text><p>This function is PostgreSQL-specific, and thus it is not available    through the generic SQL-interface.</p>   </text></group></doc>   <method name='resync'><modifiers><final/></modifiers>   <arguments/>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='select_db' homogen-type='method'><doc><text><p>This function allows you to connect to a database. Due to -  restrictions of the Postgres frontend-backend protocol, you always -  have to be connected to a database, so in fact this function just -  allows you to connect to a different database on the same server.</p> - </text><group><note/><text><p>This function <b>can</b> raise exceptions if something goes wrong -  (backend process not running, insufficient privileges...)</p> - </text></group><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.create'>create()</ref></p> + <docgroup homogen-name='select_db' homogen-type='method'><doc><text><p>Due to restrictions of the Postgres frontend-backend protocol, you always +  already have to be connected to a database. +  To connect to a different database you have to select the right +  database while connecting instead. This function is a no-op when +  specifying the same database, and throws an error otherwise.</p> + </text><group><seealso/><text><p><ref resolved='predef::Sql.pgsql.create'>create()</ref></p>   </text></group></doc>   <method name='select_db'><modifiers><final/></modifiers>   <arguments><argument name='dbname'><type><string/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='server_info' homogen-type='method'><doc><group><returns/><text><p>A string describing the server we are    talking to. It has the form <expr>"servername/serverversion"</expr>    (like the HTTP protocol description) and is most useful in    conjunction with the generic SQL-server module.</p>
autodoc.git/modref.xml:127467:   <arguments><argument name='charset'><type><string/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_notify_callback' homogen-type='method'><doc><text><p>With PostgreSQL you can LISTEN to NOTIFY events.    This function allows you to detect and handle such events.</p>   </text><group><param name='condition'/><text><p>Name of the notification event we're listening    to. A special case is the empty string, which matches all events,    and can be used as fallback function which is called only when the    specific condition is not handled. Another special case is -  <expr>"_reconnect"</expr> which gets called whenever the connection -  unexpectedly drops and reconnects to the database.</p> +  <expr>"_lost"</expr> which gets called whenever the connection +  to the database unexpectedly drops.</p>   </text></group><group><param name='notify_cb'/><text><p>Function to be called on receiving a notification-event of    condition <ref resolved='predef::Sql.pgsql.set_notify_callback.condition'>condition</ref>.    The callback function is invoked with    <expr>void notify_cb(pid,condition,extrainfo, .. args);</expr>    <tt>pid</tt> is the process id of the database session that originated    the event. <tt>condition</tt> contains the current condition.    <tt>extrainfo</tt> contains optional extra information specified by    the database.    The rest of the arguments to <ref resolved='predef::Sql.pgsql.set_notify_callback.notify_cb'>notify_cb</ref> are passed    verbatim from <ref resolved='predef::Sql.pgsql.set_notify_callback.args'>args</ref>.