autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:126219:   </docgroup>   <docgroup homogen-name='big_typed_query' homogen-type='method'><doc><text><p>Sends an SQL query synchronously to the underlying SQL-server and    returns the results in typed mode.</p>   <p> For the arguments, please see the <ref resolved='predef::Sql.Sql.query'>query()</ref> function.</p>   <p> The result is returned as an <ref resolved='predef::Sql.sql_result'>Sql.sql_result</ref> object in typed    mode. This allows for having some more info about the result as    well as processing the result in a streaming fashion, although the    result itself wasn't obtained streamingly from the server. Returns    <expr>0</expr> if the query didn't return any result (e.g. <tt>INSERT</tt>    or similar).</p> - </text><group><note/><text><p>Typed mode is not supported by all sql databases. If not -  supported, an error is thrown.</p> + </text><group><note/><text><p>Typed mode support varies per database and per datatype. +  SQL datatypes which the current database cannot return as a native Pike +  type, will be returned as (untyped) strings.</p>   </text></group><group><note/><text><p>Despite the name, this function is not only useful for "big"    queries. It typically has less overhead than <ref resolved='predef::Sql.Sql.typed_query'>typed_query</ref> also    for ones that return only a few rows.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Sql.Sql.query'>query</ref>, <ref resolved='predef::Sql.Sql.typed_query'>typed_query</ref>, <ref resolved='predef::Sql.Sql.big_query'>big_query</ref>, <ref resolved='predef::Sql.Sql.streaming_query'>streaming_query</ref></p>   </text></group></doc>   <method name='big_typed_query'>   <arguments><argument name='q'><type><or><object resolved='predef::Sql.Sql.big_typed_query'/><string/></or></type></argument><argument name='extraargs'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><or><int/><object resolved='predef::Sql.Sql.big_typed_query'/></or></returntype>   </method>   </docgroup>
autodoc.git/autodoc.xml:126644:    returns the results in typed mode.</p>   <p> For the arguments, please see the <ref resolved='predef::Sql.Sql.query'>query()</ref> function.</p>   </text><group><returns/><text><p>Returns one of the following on success:</p>   <mixed><group><type><array><valuetype><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></valuetype></array></type><text><p>The result as an array of mappings indexed on the name of    the columns. The values have the appropriate native pike    types where they fit the SQL data types - see the class doc    for details on typed mode.</p>   </text></group><group><type><zero/></type><text><p>The value <expr>0</expr> (zero) if the query didn't return any    result (eg <tt>INSERT</tt> or similar).</p>   </text></group></mixed> - </text></group><group><note/><text><p>Typed mode is not supported by all sql databases. If not -  supported, an error is thrown.</p> + </text></group><group><note/><text><p>Typed mode support varies per database and per datatype. +  SQL datatypes which the current database cannot return as a native Pike +  type, will be returned as (untyped) strings.</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Sql.Sql.query'>query</ref>, <ref resolved='predef::Sql.Sql.big_typed_query'>big_typed_query</ref></p>   </text></group></doc>   <method name='typed_query'>   <arguments><argument name='q'><type><or><object resolved='predef::Sql.Sql.typed_query'/><string/></or></type></argument><argument name='extraargs'><type><varargs><mixed/></varargs></type></argument></arguments>   <returntype><array><valuetype><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></valuetype></array></returntype>   </method>   </docgroup>   </class>   <class name='msql'>   <doc><text><p>Implements the glue needed to access the Msql-module from the generic