Uploaded image for project: 'Jira Data Center'
  1. Jira Data Center
  2. JRASERVER-74500

[Documentation] Improve clarity on the "Tuning database connection" page

    XMLWordPrintable

Details

    Description

      Problem Definition

      • The validation query section mentions a document surviving connection closures that contains more information about other database-recommended values that are missing from the main document.
      Validation Query validation-query The SQL query that will be used to validate connections from this pool. If specified, this query MUST be an SQL SELECT statement that returns at least one row. See Surviving connection closures for more information. select 1
      (for MySQL)
      (otherwise, not specified in dbconfig.xml)
      • The validation query timeout "Recommendations / Notes" column text describes the parameter, but in the end, it is only applicable for MySQL which can cause some confusion.
      Validation Query Timeout validation-query-timeout The length of time (in seconds) that the system should wait for a validation query to succeed before it considers the database connection broken. The length of time should be quite short as the validation query should be designed to do a minimum amount of work.
      If you specify a Validation Query above, then you should specify a value for the Validation Query Timeout too. If not, a value of "-1" is assumed, which results in the system waiting indefinitely until a validation query succeeds against a broken database connection, which it never will.
      This should only be done for MySQL. Using a Validation Query Timeout on any database other than MySQL will cause significant problems with the Jira instance.
      3
      (for MySQL)
      (otherwise, not specified in dbconfig.xml)
      • The minimum size and idle are merged where the same doesn't happen to the maximum counterpart, and that causes confuse to the customer regarding what to set for those two values.

      Suggested Solution

      • You can add the recommended values directly in the suggestion column to avoid clicking on the link to find the recommended value.
      Database type Validation query
      MySQL select 1
      Microsoft SQL Server select 1
      Oracle select 1 from dual
      PostgreSQL select version();
      • Explain that the recommended value is applicable for MySQL only, right at the beginning of the text, e.g.:
      Validation Query Timeout validation-query-timeout The length of time (in seconds) that the system should wait for a validation query to succeed before it considers the database connection broken. This should only be done for MySQL. Using a Validation Query Timeout on any database other than MySQL will cause significant problems with the Jira instance.

      The length of time should be quite short as the validation query should be designed to do a minimum amount of work.
      If you specify a Validation Query above, then you should specify a value for the Validation Query Timeout too. If not, a value of "-1" is assumed, which results in the system waiting indefinitely until a validation query succeeds against a broken database connection, which it never will.|3
      (for MySQL)
      (otherwise, not specified in dbconfig.xml)|

      • The minimum size and idle should be separated into distinct rows to clarify what should or should not be defined in the configuration.

      Workaround

      None

      Attachments

        Activity

          People

            500376cac1e1 Daria Shatsylo
            1edd59bb2c95 Mateus
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: