.. raw:: latex

  \appcount

.. _settings:

Application settings
========================

General
-------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: General settings
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Check for updates at startup
     - If enabled, the application will report new versions.
   * - Load unstable versions
     - Enable/disable the ability to update to an unstable version of the application.
   * - Prompt to save open documents
     - Ask to save changes before closing the document. If off, changes are not saved.
   * - Parse procedure and function variables
     - Display procedure and function variables when viewing detailed information about an object
   * - Recent file to store
     - Number of files displayed in the menu item ``Edit`` :math:`\to` ``Recent Files``
   * - Recent hosts to store
     - Number of last entered hosts displayed in the drop-down list for selection.
   * - Line separator
     - The character to be used as a delimiter
   * - Default file encoding
     - Default file encoding

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Logging
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Display system console
     - Display/hide system console
   * - Login application operation
     - Log application events to the system log
   * - Log system out to console
     - Output ``System.out`` stream to console
   * - Log system errors to console
     - Output ``System.err`` stream to console
   * - Maximum rolling log backups
     - Number of log files saved. 
       When the log (``system.log``) reaches a size greater than 1MB, the recording continues to a new file (system.log.1), etc. 
       When the number of files equals the number specified in this parameter, the files will be overwritten. 
       If 0 is specified, the number of files is unlimited.
   * - Output event log level
     - Level of output to the output status log and the output console:
        
        1. ``FATAL`` - captures very serious errors that are likely to cause the application to stop being used;
        2. ``ERROR`` - captures serious errors that need to be checked but will not terminate the application;
        3. ``WARN`` - captures potentially dangerous situations;
        4. ``INFO`` - informs about events of application operation at a high level;
        5. ``DEBUG`` - informs about events at a lower level for debugging the application (for developers);
        6. ``TRACE`` - detailed logging for very low-level debugging;
        7. ``ALL`` - all of the above levels.
        
        Levels are ordered and each next level incorporates previous levels.
   * - Path to logs directory
     - Specifies absolute or relative path to the ``logs`` directory containing log files. 
       For example, if the relative path ``logs`` is specified, log files will be created at the path ``/<path_to_app>/logs``. 
       

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Internet proxy settings
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Use proxy server for internet connections
     - Use/do not use a proxy server for internet connections
   * - Proxy host
     - Name or IP of proxy server
   * - Proxy port 
     - Proxy server port number
   * - Proxy user 
     - User name for authorisation on proxy server (if required)
   * - Proxy password 
     - User password for authorisation on the proxy server (if required)

Display settings
------------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: General
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Display splash screen at startup
     - Show/skip splash screen at startup
   * - Maximum window on startup
     - Open application window full screen at startup
   * - Status bar
     - Show/hide status bar
   * - Connections
     - Show/hide connection information window

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Appearance
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Look and feel
     - Application design
   * - Interface language
     - Application Language
   * - Use anti-aliased fonts
     - Display the font smoothly by blurring corners

Shortcuts
-------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{23}|>{\arraybackslash}\X{6}{23}|>{\arraybackslash}\X{11}{23}|
.. list-table:: Shortcuts
   :class: longtable
   :header-rows: 1

   * - Command
     - Shortcuts
     - Description
   * - Upper case
     - Ctrl + Shift + U
     - Converts the selected text to uppercase
   * - Execute SQL script
     - F9
     - Executes SQL-script in the query editor
   * - Execute in the profiler
     - Shift + F5
     - Executes in the profiler the SQL script in the query editor
   * - Execute single query
     - F5
     - Execute with a single query the SQL script in the query editor
   * - Data generator
     - 
     - Open test data generator tool
   * - Documentation 
     - F1
     - Open application documentation
   * - Drivers
     - 
     - Open the drivers window
   * - Duplicate text up
     - Ctrl + Alt + Up 
     - Duplicate the line the cursor is pointing at in the query editor to the line above it
   * - Duplicate text down
     - Ctrl + Alt + Down
     - Duplicate the line the cursor is pointing to on the line below in the query editor
   * - Comment text
     - Ctrl + Slash
     - Comment out the current line in the query editor
   * - Replace
     - Ctrl + R
     - Find and replace the specified text
   * - Commit transaction
     - Ctrl + Shift + C
     - Commit transaction
   * - Extract database metadata into SQL script
     - 
     - Open export metadata tool
   * - Change separator orientation
     - Ctrl + Alt + Q
     - Change the application window layout
   * - Find previous
     - Shift + F3
     - Search specified text
   * -  Find next
     - F3
     - Search specified text
   * - SQL command history
     - Ctrl + Shift + H
     - Open the history of executed queries 
   * - User Manager
     - 
     - Open User Manager
   * - Grant Manager
     - 
     - Open Grant Manager
   * - Preferences
     - 
     - Open application settings
   * - Lower case
     - Ctrl + Shift + L
     - Makes the selected text lower case
   * - About
     - 
     - Open programme information
   * - System console window
     - 
     - Open the system console
   * - Rollback all changes
     - Ctrl + Shift + R
     - Rollback transaction
   * - Open file
     - Ctrl + O
     - Add selected file text to the query editor
   * - Go to 
     - Ctrl + G
     - Go to the specified line in the query editor
   * - Print
     - Ctrl + P
     - Open the print window
   * - Print plan
     - Ctrl + Shift + P
     - Show the plan of the query that is in the query editor
   * - Show/hide editor output 
     - Ctrl + E
     - Show/hide the output pane in the query editor
   * - Previous statement
     - Ctrl + Shift + Down
     - Insert a previously executed SQL script into the query editor
   * - Check for updates
     - 
     - Check that the version of the application you are using is up to date
   * - Profiler
     - 
     - Open Profiler 
   * - ER-diagram editor
     - 
     - Open ER-diagram editor 
   * - Query Editor
     - 
     - Open the query editor
   * - Move up
     - Alt + Up
     - Move selected text one line higher
   * - Move down
     - Alt + Down
     - Move the highlighted text to the line below
   * - Next statement
     - Ctrl + Shift + Up
     - Insert the following saved SQL script into the query editor
   * - Create database
     - 
     - Open the window of database creation
   * - New Connection
     - Ctrl + Shift + N
     - Open the Create Connection window
   * - Heap memory status
     - 
     - Open a window with current information about the memory status
   * - Save
     - Ctrl + S
     - Save
   * - Save As
     - Ctrl + Shift + S
     - Save as
   * - Compare database metadata
     - 
     - Open the database comparison tool
   * - Database Statistics
     - 
     - Open the statistics tool
   * - Trace Manager
     - 
     - Open Trace Manager
   * - SQL format
     - Ctrl + Shift + F
     - Format the selected text fragment

SQL templates
---------------

Templates simplify the writing script.
After pressing the space bar, the specified abbreviation will be converted into full text, for example:
``SF`` :math:`\to` ``SELECT * FROM``.

You can add your own templates using the corresponding button.

Connection
-------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: General
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Startup connection
     - Automatically connect on startup
   * - Server connection timeout (sec)
     - Time during which the application will try to connect to the database. 
       If the connection is not established before it expires, an error will occur.
   * - Timeout shutdown diagnostics (ms)
     - When an error occurs from the server, RDBExpert checks if the connection is active. 
       The parameter defines the time during which the application will wait for a response from the server. 
       If the timeout is reached, the connection will be disconnected.
   * - Connection username at opening .fdb
     - User name, from which the connection will be made when opening .fdb
   * - Connection password at opening .fdb
     - Password, with which connection will be executed when opening .fdb
   * - Connection charset at opening .fdb
     - Charset with which the connection will be executed when opening .fdb
   * - Allowed authentication plugins by default
     - List of plugins that will be used by the driver for authentication

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Tree connection
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Node height
     - Distance between nodes in pixels
   * - Connect on double-click
     - Connect to database after double-clicking on it in connection tree.
   * - Expand database objects tree on connect
     - When this option is enabled, the object tree will automatically expand when connecting to the database.
   * - Sort alphabetically
     - Sort nodes in the connection tree alphabetically
   * - Show folders for tables
     - Form folders for table information in the connection tree
   * - Show system objects
     - Show/hide system objects in the connection tree
   * - Show connection properties panel
     - Show/hide connection parameters panel
   * - Show full DB statistics
     - Display full database statistics in the connection parameters panel
   * - Search in columns
     - Search not only in the connection tree objects, but also in the column names.

Editor
-------------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: General
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Auto-complete only hotkeys 
     - Suggest autocompletion only when ``Ctrl+Space`` is pressed
   * - Auto-complete keywords on
     - Suggest autocompletion of keywords in the query editor
   * - Auto-complete database objects on
     - Suggest autocompletion of database objects in the query editor
   * - Default editor auto-commit
     - Automatically commit changes after query execution
   * - Recycle resultset tabs
     - Close the previous result set when executing a query
   * - Remove comments for execution
     - Remove SQL comments in queries at runtime and send the query without them to the server
   * - Print all SQL to output panel
     - Add the full text of the query to the output pane
   * - Print extended query plan
     - Add a detailed query outline to the output pane
   * - Open a new editor for new open connection
     - Switch to a new tab of the query editor when a connection is established
   * - Use multiple connections
     - Add the ability to specify multiple connections in which to execute the query
   * - Undo count
     - Number of returns to previous states. The return command is activated by pressing ``Ctrl+Z`` (``Windows``).
   * - History count
     - The number of queries that can be stored in the history. When the specified number is reached, old queries will be deleted from the history

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Display
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Tools panel 
     - Display the query editor toolbar
   * - Transaction Parameters
     - Display transaction parameters
   * - Status bar
     - Show/hide status bar
   * - Line numbers
     - Display line numbers in the query editor
   * - Wrap line
     - Automatically move a line if it does not fit in the query editor.
   * - Current line highlight
     - Highlight in colour the line on which the cursor is located

Result set table
---------------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Result set table
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Column resizable
     - Enable/disable the ability to change the size of columns in the result set
   * - Column reordering
     - Enable/disable the ability to drag and drop columns, swapping them in places
   * - Row number header
     - Show/hide row numbers in the resulting table
   * - Column Width (pixels)
     - Column width in the resulting table
   * - Row Height (pixels)
     - Row height in the resulting table
   * - Save column widths between queries
     - Maintain the same column width in the resulting table
   * - Use thousands separators for numeric values
     - If enabled, the thousands of the numeric values will be separated by a space.
   * - Date pattern format
     - Date template for ``DATE`` data type. The table below describes the template parameters in detail
   * - Time pattern format
     - Time template for the ``TIME`` data type. The table below details the template parameters
   * - Timestamp pattern format 
     - Timestamp template for the ``TIMESTAMP`` data type. The table below details the parameters of the template
   * - Time with time zone pattern format
     - Time template for the ``TIME WITH TIME ZONE`` data type. The table below details the template parameters
   * - Timestamp with time zone pattern format
     - Timestamp time template for the ``TIMESTAMP WITH TIME ZONE`` data type. The table below details the parameters of the template
   * - Null value cell text
     - Text to be added for ``NULL`` values
   * - Transpose when single row result
     - Transpose a result consisting of a single row
   * - Align numeric values
     - Arrangement of numeric values in a cell
   * - Align text values
     - Alignment of text values in a cell
   * - Align boolean values
     - Aligning boolean values in the cell
   * - Align null values
     - Aligning null values in a cell
   * - Align other values
     - Alignment of other types of values in the cell
   * - Use form for adding/deleting records
     - Open a window when adding data to the table
   * - Use other colour for null when adding/deleting records
     - Highlight a cell with a null value with a colour
   * - Show dialog when records limit reached
     - Display a warning that the number of records in the result table has reached the maximum number of records that can be returned.
   * - Maximum records returned
     - Maximum number of records to be returned in the resulting table
   * - Fetch size
     - Number of records to be retrieved when opening the dataset table


Code formatting
---------------------

The general parameters define the rules for formatting keywords.

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Editor
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Convert tabs to spaces
     - Convert tabs to spaces
   * - Tab size
     - Number of spaces to replace the tabulation with during conversion
   * - Default query separator
     - The symbol used to separate queries. The default is ``;``

Datetime templates
~~~~~~~~~~~~~~~~~~~~~~~~

.. tabularcolumns:: |>{\arraybackslash}\X{2}{17}|>{\arraybackslash}\X{7}{17}|>{\arraybackslash}\X{2}{17}|>{\arraybackslash}\X{6}{17}|
.. list-table:: Datetime templates
   :class: longtable
   :header-rows: 1

   * - Symbol
     - Description
     - Presentation
     - Examples
   * - G
     - era	
     - text	
     - AD; Anno Domini; A
   * - u	
     - year	
     - year	
     - 2004; 04
   * - y	
     - year-of-era	
     - year	
     - 2004; 04
   * - D	
     - day-of-year
     - number	
     - 189
   * - M/L	
     - month-of-year	
     - number/text	
     - 7; 07; Jul; July; J
   * - d	
     - day-of-month	
     - number	
     - 10
   * - Q/q	
     - quarter-of-year	
     - number/text	
     - 3; 03; Q3; 3rd quarter
   * - Y	
     - week-based-year	
     - year	
     - 1996; 96
   * - w	
     - week-of-week-based-year	
     - number	
     - 27
   * - W
     - week-of-month
     - number
     - 4
   * - E
     - day-of-week
     - text	
     - Tue; Tuesday; T
   * - e/c
     - localized day-of-week	
     - number/text	
     - 2; 02; Tue; Tuesday; T
   * - F
     - day-of-week-in-month
     - number
     - 3
   * - a	
     - am-pm-of-day
     - text	
     - PM
   * - B
     - period-of-day
     - text	
     - in the morning
   * - h
     - clock-hour-of-am-pm (1-12)	
     - number	
     - 12
   * - K	
     - hour-of-am-pm (0-11)	
     - number	
     - 0
   * - k
     - clock-hour-of-day (1-24)	
     - number	
     - 24
   * - H
     - hour-of-day (0-23)
     - number
     - 0
   * - m
     - minute-of-hour
     - number
     - 30
   * - s
     - second-of-minute
     - number
     - 55
   * - S	
     - fraction-of-second	
     - fraction	
     - 978
   * - A
     - milli-of-day
     - number
     - 1234
   * - n
     - nano-of-second
     - number
     - 987654321
   * - N
     - nano-of-day
     - number
     - 1234000000
   * - O	
     - localized zone-offset	
     - offset-O	
     - GMT+8; GMT+08:00; UTC-08:00
   * - X	
     - zone-offset 'Z' for zero	
     - offset-X	
     - Z; -08; -0830; -08:30; -083015; -08:30:15
   * - x	
     - zone-offset	
     - offset-x	
     - +0000; -08; -0830; -08:30; -083015; -08:30:15
   * - p	
     - pad next	
     - pad modifier	
     - 1
   * - '
     - escape for text
     - delimiter
     - 	
   * - ''
     - single quote	
     - literal	
     - '

Tool bar
---------------------------

.. tabularcolumns:: |>{\arraybackslash}\X{6}{17}|>{\arraybackslash}\X{11}{17}|
.. list-table:: Visibility
   :class: longtable
   :header-rows: 1

   * - Parameter
     - Description
   * - Database tool bar
     - Display/hide the database toolbar
   * - Application tool bar
     - Display/hide application toolbar
   * - System tool bar
     - Display/hide the system toolbar

The ``Database Tools``, ``Application Tools``, ``System Tools``, and ``Editor Tools`` tabs contain settings for defining the tool set of the respective panels.

Fonts
-----------

Font settings for the query editor, connection tree, and system console fonts.

Colours
-----------

Settings for the colours that are used in the application.