From 37e5a89d8f77574b0960825483a498f779f5117f Mon Sep 17 00:00:00 2001 From: Dmitry Yemanov Date: Mon, 28 Jan 2019 09:48:05 +0300 Subject: [PATCH] Misc docs fixes --- CHANGELOG.md | 18 +-- doc/sql.extensions/README.context_variables2 | 129 +++++++++++-------- 2 files changed, 81 insertions(+), 66 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a0cdf44337..1fb7c334c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,11 +3,11 @@ ## New features * [CORE-5990](http://tracker.firebirdsql.org/browse/CORE-5990): Pool of external connections - Reference(s): [/doc/sql.extentions/README.external_connections_pool](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.external_connections_pool) + Reference(s): [/doc/sql.extensions/README.external_connections_pool](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.external_connections_pool) Contributor(s): Vlad Khorsun * [CORE-5970](http://tracker.firebirdsql.org/browse/CORE-5970): Built-in cryptographic functions - Reference(s): [/doc/sql.extentions/README.builtin_functions.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.builtin_functions.txt) + Reference(s): [/doc/sql.extensions/README.builtin_functions.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.builtin_functions.txt) Contributor(s): Alex Peshkoff * [CORE-5953](http://tracker.firebirdsql.org/browse/CORE-5953): Statement level read consistency in read-committed transactions @@ -25,7 +25,7 @@ Contributor(s): Adriano dos Santos Fernandes * [CORE-5620](http://tracker.firebirdsql.org/browse/CORE-5620): Add builtin functions FIRST_DAY and LAST_DAY - Reference(s): [/doc/sql.extentions/README.builtin_functions.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.builtin_functions.txt) + Reference(s): [/doc/sql.extensions/README.builtin_functions.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.builtin_functions.txt) Contributor(s): Adriano dos Santos Fernandes * [CORE-5536](http://tracker.firebirdsql.org/browse/CORE-5536): Connection compressed/encrypted status in MON$ATTACHMENTS table @@ -37,11 +37,11 @@ Contributor(s): Dmitry Yemanov * [CORE-909](http://tracker.firebirdsql.org/browse/CORE-909): Ability to retrieve current UTC/GMT timestamp - Reference(s): [/doc/sql.extentions/README.time_zone.md](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.time_zone.md) + Reference(s): [/doc/sql.extensions/README.time_zone.md](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.time_zone.md) Contributor(s): Adriano dos Santos Fernandes * [CORE-694](http://tracker.firebirdsql.org/browse/CORE-694): Support for time zones - Reference(s): [/doc/sql.extentions/README.time_zone.md](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.time_zone.md) + Reference(s): [/doc/sql.extensions/README.time_zone.md](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.time_zone.md) Contributor(s): Adriano dos Santos Fernandes ## Improvements @@ -65,7 +65,7 @@ Contributor(s): Alex Peshkoff * [CORE-5921](http://tracker.firebirdsql.org/browse/CORE-5921): Provide information about Global Commit Number, Commit Number of currently used database snapshot (if any) and Commit Numbers assigned to the committed transactions - Reference(s): [/doc/sql.extentions/README.builtin_functions.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.builtin_functions.txt) + Reference(s): [/doc/sql.extensions/README.builtin_functions.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.builtin_functions.txt) Contributor(s): Vlad Khorsun * [CORE-5887](http://tracker.firebirdsql.org/browse/CORE-5887): Allow the use of management statements in PSQL blocks @@ -106,7 +106,7 @@ Contributor(s): Alex Peshkoff * [CORE-3808](http://tracker.firebirdsql.org/browse/CORE-3808): Provide ability to return all columns using RETURNING clause - Reference(s): [/doc/sql.extentions/README.returning](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extentions/README.returning) + Reference(s): [/doc/sql.extensions/README.returning](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.returning) Contributor(s): Adriano dos Santos Fernandes ## Bugfixes @@ -272,11 +272,11 @@ ## New features * [CORE-5568](http://tracker.firebirdsql.org/browse/CORE-5568): SQL SECURITY feature - Reference(s): [/doc/sql.extentions/README.sql_security.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.sql_security.txt) + Reference(s): [/doc/sql.extensions/README.sql_security.txt](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.sql_security.txt) Contributor(s): Roman Simakov * [CORE-5525](http://tracker.firebirdsql.org/browse/CORE-5525): Create high-precision floating point datatype named DECFLOAT - Reference(s): [/doc/sql.extentions/README.data_types](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.data_types) + Reference(s): [/doc/sql.extensions/README.data_types](https://github.com/FirebirdSQL/firebird/raw/master/doc/sql.extensions/README.data_types) Contributor(s): Alex Peshkoff * [CORE-5488](http://tracker.firebirdsql.org/browse/CORE-5488): Timeouts for running SQL statements and idle connections diff --git a/doc/sql.extensions/README.context_variables2 b/doc/sql.extensions/README.context_variables2 index 065da87346..cd64211be6 100644 --- a/doc/sql.extensions/README.context_variables2 +++ b/doc/sql.extensions/README.context_variables2 @@ -51,64 +51,79 @@ Usage: SYSTEM namespace provides read-only access to the following variables. - Variable name Value + Variable name Value ------------------------------------------------------------------------------ - NETWORK_PROTOCOL | The network protocol used by client to connect. Currently - | used values: "TCPv4", "TCPv6", "WNET", "XNET" and NULL - | - WIRE_COMPRESSED | Compression status of current connection. - | If connection is compressed - returns "TRUE", if it is - | not compressed - returns "FALSE". - | If connection is embedded - returns NULL. - | - WIRE_ENCRYPTED | Encryption status of current connection. - | Value is the same as for compression status above. - | - CLIENT_ADDRESS | The wire protocol address and port number of remote client - | represented as string. Value is IP address concatenated with - | port number using the '/' separator character. Value is - | returned for TCPv4 and TCPv6 protocols only, for all other - | protocols NULL is returned - | - CLIENT_HOST | The wire protocol host name of remote client. Value is - | returned for all supported protocols - | - CLIENT_PID | Process ID of remote client application - | - CLIENT_PROCESS | Process name of remote client application - | - DB_NAME | Canonical name of current database. It is either alias - | name if connectivity via file names is not allowed or - | fully expanded database file name otherwise. - | - ISOLATION_LEVEL | Isolation level for current transaction. Returned values - | are "READ COMMITTED", "CONSISTENCY", "SNAPSHOT" - | - TRANSACTION_ID | Numeric ID for current transaction. Returned value is the - | same as of CURRENT_TRANSACTION pseudo-variable - | - LOCK_TIMEOUT | Lock timeout value specified for current transaction - | - READ_ONLY | Returns "TRUE" if current transaction is read-only and - | "FALSE" otherwise - | - SESSION_ID | Numeric ID for current session. Returned value is the - | same as of CURRENT_CONNECTION pseudo-variable - | - CURRENT_USER | Current user for the connection. Returned value is the - | same as of CURRENT_USER pseudo-variable - | - CURRENT_ROLE | Current role for the connection. Returned value is the - | same as of CURRENT_ROLE pseudo-variable - | - ENGINE_VERSION | Engine version number, e.g. "2.1.0" (since V2.1) - | - GLOBAL_CN | Most current value of global Commit Number counter - | - SNAPSHOT_CN | Value of Commit Number of currently database snapshot: either - | transaction level (for SNAPSHOT or CONSISTENCY transaction), - | or request level (for READ COMMITTED READ CONSISTENCY - | transaction). NULL, if snapshot is not exist. + NETWORK_PROTOCOL | The network protocol used by client to connect. Currently + | used values: "TCPv4", "TCPv6", "WNET", "XNET" and NULL + | + WIRE_COMPRESSED | Compression status of current connection. + | If connection is compressed - returns "TRUE", if it is + | not compressed - returns "FALSE". + | If connection is embedded - returns NULL. + | + WIRE_ENCRYPTED | Encryption status of current connection. + | Value is the same as for compression status above. + | + CLIENT_ADDRESS | The wire protocol address and port number of remote client + | represented as string. Value is IP address concatenated with + | port number using the '/' separator character. Value is + | returned for TCPv4 and TCPv6 protocols only, for all other + | protocols NULL is returned + | + CLIENT_HOST | The wire protocol host name of remote client. Value is + | returned for all supported protocols + | + CLIENT_PID | Process ID of remote client application + | + CLIENT_PROCESS | Process name of remote client application + | + DB_NAME | Canonical name of current database. It is either alias + | name if connectivity via file names is not allowed or + | fully expanded database file name otherwise. + | + ISOLATION_LEVEL | Isolation level for current transaction. Returned values + | are "READ COMMITTED", "CONSISTENCY", "SNAPSHOT" + | + TRANSACTION_ID | Numeric ID for current transaction. Returned value is the + | same as of CURRENT_TRANSACTION pseudo-variable + | + LOCK_TIMEOUT | Lock timeout value specified for current transaction + | + READ_ONLY | Returns "TRUE" if current transaction is read-only and + | "FALSE" otherwise + | + SESSION_ID | Numeric ID for current session. Returned value is the + | same as of CURRENT_CONNECTION pseudo-variable + | + CURRENT_USER | Current user for the connection. Returned value is the + | same as of CURRENT_USER pseudo-variable + | + CURRENT_ROLE | Current role for the connection. Returned value is the + | same as of CURRENT_ROLE pseudo-variable + | + ENGINE_VERSION | Engine version number, e.g. "2.1.0" (since V2.1) + | + GLOBAL_CN | Most current value of global Commit Number counter + | + SNAPSHOT_CN | Value of Commit Number of currently database snapshot: either + | transaction level (for SNAPSHOT or CONSISTENCY transaction), + | or request level (for READ COMMITTED READ CONSISTENCY + | transaction). NULL, if snapshot is not exist. + | + SESSION_IDLE_TIMEOUT | Current value of idle connection timeout + | + STATEMENT_TIMEOUT | Current value of statement execution timeout + | + REPLICATION_SEQUENCE | Current replication sequence (number of the latest segment + | written to the replication journal) + | + EXT_CONN_POOL_SIZE | Pool size (number of connections inside the pool) + | + EXT_CONN_POOL_IDLE_COUNT | Count of currently inactive connections in the pool + | + EXT_CONN_POOL_ACTIVE_COUNT | Count of active connections, associated with pool + | + EXT_CONN_POOL_LIFETIME | Idle connection lifetime, in seconds Notes: To prevent DoS attacks against Firebird Server you are not allowed to have