Skip to content
Snippets Groups Projects
Commit 13d29cf3 authored by Henrik (Grubba) Grubbström's avatar Henrik (Grubba) Grubbström
Browse files

Some Autodoc markup fixes.

Rev: lib/modules/Sql.pmod/pgsql.pike:1.68
parent b1a80039
No related branches found
No related tags found
No related merge requests found
...@@ -175,26 +175,26 @@ protected string _sprintf(int type, void|mapping flags) ...@@ -175,26 +175,26 @@ protected string _sprintf(int type, void|mapping flags)
//! @param options //! @param options
//! Currently supports at least the following: //! Currently supports at least the following:
//! @mapping //! @mapping
//! @member int use_ssl //! @member int "use_ssl"
//! If the database supports and allows SSL connections, the session //! If the database supports and allows SSL connections, the session
//! will be SSL encrypted, if not, the connection will fallback //! will be SSL encrypted, if not, the connection will fallback
//! to plain unencrypted //! to plain unencrypted
//! @member int force_ssl //! @member int "force_ssl"
//! If the database supports and allows SSL connections, the session //! If the database supports and allows SSL connections, the session
//! will be SSL encrypted, if not, the connection will abort //! will be SSL encrypted, if not, the connection will abort
//! @member int cache_autoprepared_statements //! @member int "cache_autoprepared_statements"
//! If set to zero, it disables the automatic statement prepare and //! If set to zero, it disables the automatic statement prepare and
//! cache logic; caching prepared statements can be problematic //! cache logic; caching prepared statements can be problematic
//! when stored procedures and tables are redefined which leave stale //! when stored procedures and tables are redefined which leave stale
//! references in the already cached prepared statements //! references in the already cached prepared statements
//! @member string client_encoding //! @member string "client_encoding"
//! Character encoding for the client side, it defaults to using //! Character encoding for the client side, it defaults to using
//! the default encoding specified by the database, e.g. //! the default encoding specified by the database, e.g.
//! @ref{UTF8@} or @ref{SQL_ASCII@}. //! @ref{UTF8@} or @ref{SQL_ASCII@}.
//! @member string standard_conforming_strings //! @member string "standard_conforming_strings"
//! When on, backslashes in strings must not be escaped any longer, //! When on, backslashes in strings must not be escaped any longer,
//! @[quote()] automatically adjusts quoting strategy accordingly //! @[quote()] automatically adjusts quoting strategy accordingly
//! @member string escape_string_warning //! @member string "escape_string_warning"
//! When on, a warning is issued if a backslash (\) appears in an //! When on, a warning is issued if a backslash (\) appears in an
//! ordinary string literal and @[standard_conforming_strings] is off, //! ordinary string literal and @[standard_conforming_strings] is off,
//! defaults to on //! defaults to on
...@@ -351,26 +351,26 @@ string get_charset() ...@@ -351,26 +351,26 @@ string get_charset()
//! during session creation, and then processed and returned by the server. //! during session creation, and then processed and returned by the server.
//! Common values are: //! Common values are:
//! @mapping //! @mapping
//! @member string client_encoding //! @member string "client_encoding"
//! Character encoding for the client side, e.g. //! Character encoding for the client side, e.g.
//! @ref{UTF8@} or @ref{SQL_ASCII@}. //! @ref{UTF8@} or @ref{SQL_ASCII@}.
//! @member string server_encoding //! @member string "server_encoding"
//! Character encoding for the server side as determined when the //! Character encoding for the server side as determined when the
//! database was created, e.g. @ref{UTF8@} or @ref{SQL_ASCII@} //! database was created, e.g. @ref{UTF8@} or @ref{SQL_ASCII@}
//! @member string DateStyle //! @member string "DateStyle"
//! Date parsing/display, e.g. @ref{ISO, DMY@} //! Date parsing/display, e.g. @ref{ISO, DMY@}
//! @member string TimeZone //! @member string "TimeZone"
//! Default timezone used by the database, e.g. @ref{localtime@} //! Default timezone used by the database, e.g. @ref{localtime@}
//! @member string standard_conforming_strings //! @member string "standard_conforming_strings"
//! When on, backslashes in strings must not be escaped any longer //! When on, backslashes in strings must not be escaped any longer
//! @member string session_authorization //! @member string "session_authorization"
//! Displays the authorisationrole which the current session runs under //! Displays the authorisationrole which the current session runs under
//! @member string is_superuser //! @member string "is_superuser"
//! Indicates if the current authorisationrole has database-superuser //! Indicates if the current authorisationrole has database-superuser
//! privileges //! privileges
//! @member string integer_datetimes //! @member string "integer_datetimes"
//! Reports wether the database supports 64-bit-integer dates and times //! Reports wether the database supports 64-bit-integer dates and times
//! @member string server_version //! @member string "server_version"
//! Shows the server version, e.g. @ref{8.3.3@} //! Shows the server version, e.g. @ref{8.3.3@}
//! @endmapping //! @endmapping
//! //!
...@@ -391,43 +391,43 @@ mapping(string:string) getruntimeparameters() ...@@ -391,43 +391,43 @@ mapping(string:string) getruntimeparameters()
//! @returns //! @returns
//! A set of statistics for the current session: //! A set of statistics for the current session:
//! @mapping //! @mapping
//! @member int warnings_dropped //! @member int "warnings_dropped"
//! Number of warnings/notices generated by the database but not //! Number of warnings/notices generated by the database but not
//! collected by the application by using @[error()] after the statements //! collected by the application by using @[error()] after the statements
//! that generated them. //! that generated them.
//! @member int skipped_describe_count //! @member int "skipped_describe_count"
//! Number of times the driver skipped asking the database to //! Number of times the driver skipped asking the database to
//! describe the statement parameters because it was already cached. //! describe the statement parameters because it was already cached.
//! @member int used_prepared_statements //! @member int "used_prepared_statements"
//! Numer of times prepared statements were used from cache instead of //! Numer of times prepared statements were used from cache instead of
//! reparsing in the current session. //! reparsing in the current session.
//! @member int current_prepared_statements //! @member int "current_prepared_statements"
//! Cache size of currently prepared statements. //! Cache size of currently prepared statements.
//! @member int current_prepared_statement_hits //! @member int "current_prepared_statement_hits"
//! Sum of the number hits on statements in the current statement cache. //! Sum of the number hits on statements in the current statement cache.
//! @member int prepared_portal_count //! @member int "prepared_portal_count"
//! Total number of prepared portals generated. //! Total number of prepared portals generated.
//! @member int prepared_statement_count //! @member int "prepared_statement_count"
//! Total number of prepared statements generated. //! Total number of prepared statements generated.
//! @member int portals_opened_count //! @member int "portals_opened_count"
//! Total number of portals opened, i.e. number of statements issued //! Total number of portals opened, i.e. number of statements issued
//! to the database. //! to the database.
//! @member int blocked_count //! @member int "blocked_count"
//! Number of times the driver had to (briefly) wait for the database to //! Number of times the driver had to (briefly) wait for the database to
//! send additional data. //! send additional data.
//! @member int bytes_received //! @member int "bytes_received"
//! Total number of bytes received from the database so far. //! Total number of bytes received from the database so far.
//! @member int messages_received //! @member int "messages_received"
//! Total number of messages received from the database (one SQL-statement //! Total number of messages received from the database (one SQL-statement
//! requires multiple messages to be exchanged). //! requires multiple messages to be exchanged).
//! @member int bytes_sent //! @member int "bytes_sent"
//! Total number of bytes sent to the database so far. //! Total number of bytes sent to the database so far.
//! @member int packets_sent //! @member int "packets_sent"
//! Total number of packets sent to the database (one packet usually //! Total number of packets sent to the database (one packet usually
//! contains multiple messages). //! contains multiple messages).
//! @member int reconnect_count //! @member int "reconnect_count"
//! Number of times the connection to the database has been lost. //! Number of times the connection to the database has been lost.
//! @member int portals_in_flight //! @member int "portals_in_flight"
//! Currently still open portals, i.e. running statements. //! Currently still open portals, i.e. running statements.
//! @endmapping //! @endmapping
//! //!
...@@ -1352,34 +1352,34 @@ array(string) list_tables (void|string glob) ...@@ -1352,34 +1352,34 @@ array(string) list_tables (void|string glob)
//! The currently defined fields are: //! The currently defined fields are:
//! //!
//! @mapping //! @mapping
//! @member string schema //! @member string "schema"
//! Schema the table belongs to //! Schema the table belongs to
//! @member string table //! @member string "table"
//! Name of the table //! Name of the table
//! @member string kind //! @member string "kind"
//! Type of table //! Type of table
//! @member string owner //! @member string "owner"
//! Tableowner //! Tableowner
//! @member int rowcount //! @member int "rowcount"
//! Estimated rowcount of the table //! Estimated rowcount of the table
//! @member int datasize //! @member int "datasize"
//! Estimated total datasize of the table in bytes //! Estimated total datasize of the table in bytes
//! @member int indexsize //! @member int "indexsize"
//! Estimated total indexsize of the table in bytes //! Estimated total indexsize of the table in bytes
//! @member string name //! @member string "name"
//! Name of the column //! Name of the column
//! @member string type //! @member string "type"
//! A textual description of the internal (to the server) column type-name //! A textual description of the internal (to the server) column type-name
//! @member int typeoid //! @member int "typeoid"
//! The OID of the internal (to the server) column type //! The OID of the internal (to the server) column type
//! @member string length //! @member string "length"
//! Size of the columndatatype //! Size of the columndatatype
//! @member mixed default //! @member mixed "default"
//! Default value for the column //! Default value for the column
//! @member int is_shared //! @member int "is_shared"
//! @member int has_index //! @member int "has_index"
//! If the table has any indices //! If the table has any indices
//! @member int has_primarykey //! @member int "has_primarykey"
//! If the table has a primary key //! If the table has a primary key
//! @endmapping //! @endmapping
//! //!
...@@ -1580,7 +1580,7 @@ final private array(string) closestatement(mapping tp) ...@@ -1580,7 +1580,7 @@ final private array(string) closestatement(mapping tp)
//! Bindings are supported natively straight across the network. //! Bindings are supported natively straight across the network.
//! Special bindings supported are: //! Special bindings supported are:
//! @mapping //! @mapping
//! @member int :_cache //! @member int ":_cache"
//! Forces caching on or off for the query at hand. //! Forces caching on or off for the query at hand.
//! @endmapping //! @endmapping
//! //!
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment