Details

    Description

      MariaDB Documentation has search already.
      MariaDB Documentation has a way to get an offline version see https://mariadb.com/kb/en/meta/mirroring-the-knowledge-base/.

      But MariaDB Documentation is missing downloadable /PDF, EPUB/ versions, there are some wrong or misleading descriptions.

      Example for wrong CREATE TRIGGER at https://mariadb.com/kb/en/sql-99-complete-really/24-sql-triggers/create-trigger-statement/
      STATEMENT should be excluded in

      FOR EACH {ROW | STATEMENT} 
      

      in the information bellow :

      CREATE TRIGGER <Trigger name>
      {BEFORE | AFTER} <trigger event> ON <Table name>
      [ REFERENCING <old or new values alias list> ]
      <triggered action>
       
         <trigger event> ::=
         INSERT |
         DELETE |
         UPDATE [ OF <trigger Column list> ]
       
            <trigger Column list> ::= <Column name> [ {,<Column name>} ... ]
       
         <old or new values alias list> ::=
         <old or new values alias>...
       
            <old or new values alias> ::=
            OLD [ ROW ] [ AS ] old values <Correlation name> |
            NEW [ ROW ] [ AS ] new values <Correlation name> |
            OLD TABLE [ AS ] <old values Table alias> |
            NEW TABLE [ AS ] <new values Table alias>
       
               <old values Table alias> ::= <identifier>
       
               <new values Table alias> ::= <identifier>
       
         <triggered action> ::=
         [ FOR EACH {ROW | STATEMENT} ] [ WHEN (search condition) ]
            <triggered SQL statement>
       
            <triggered SQL statement> ::=
            SQL statement |
            BEGIN ATOMIC {SQL statement;}... END
      

      Next:
      https://mariadb.com/kb/en/mariadb/documentation/storage-engines/xtradb-and-innodb/xtradbinnodb-server-system-variables/#innodb_flush_method
      innodb_flush_method is missing the ALL_O_DIRECT
      As per the documentation , it is only in XtraDB, not InnoDB.
      XtraDB is now the default storage engine of MariaDB, so it should be added.

      innodb_flush_method
       
      Description: XtraDB/InnoDB flushing method. Windows always uses async_unbuffered and this variable then has no effect. On Unix, by default fsync() is used to flush data and logs. Adjusting this variable can give performance improvements, but behavior differs widely on different filesystems, and changing from the default has caused problems in some situations, so test and benchmark carefully before adjusting.
      O_DSYNC - O_DSYNC is used to open and flush logs, and fsync() to flush the data files.
      O_DIRECT - O_DIRECT or directio(), is used to open data files, and fsync() to flush data and logs.
      fdatasync - an old default value that follows the default behavior of using fsync(), but replaced with the unset default to avoid confusion between fdatasync() and fysnc().
      O_DIRECT_NO_FSYNC - introduced in MariaDB 10.0 / MySQL 5.6.7. Uses O_DIRECT during flushing I/O, but skips fsync() afterwards. Not suitable for XFS filesystems.
      Commandline: --innodb-flush-method=name
      Scope: Global
      Dynamic: No
      Data Type: enumeration
      Default Value: Not set.
      Valid Values: fdatasync, O_DSYNC, O_DIRECT, O_DIRECT_NO_FSYNC (MariaDB 10.0)
      

      There are some other issues to be added, but it might be better to separate them in subtasks ?

      Attachments

        Issue Links

          Activity

            greenman Ian Gilfillan added a comment -

            1) missing search. I'm not sure what you mean by this unless you missed the search icon (the magnifying glass). The search bar used to be visible before the redesign, now the icon must be clicked, but the search functionality still exists.

            2) Documentation not available in a downloadable format. Agree, this feature has been requested before and would be useful, but I don't think is in the pipeline at the moment.

            3) Triggers: FOR EACH ... STATEMENT. This is text from the SQL-99 book and I believe is correct. MariaDB does not support this, but the text states that it refers to the SQL standard, and not specifically MariaDB.

            4) Missing ALL_O_DIRECT. Thanks, I will add this.

            Feel free to report other mistakes and omissions, preferably as separate tasks unless they're directly related.

            greenman Ian Gilfillan added a comment - 1) missing search. I'm not sure what you mean by this unless you missed the search icon (the magnifying glass). The search bar used to be visible before the redesign, now the icon must be clicked, but the search functionality still exists. 2) Documentation not available in a downloadable format. Agree, this feature has been requested before and would be useful, but I don't think is in the pipeline at the moment. 3) Triggers: FOR EACH ... STATEMENT. This is text from the SQL-99 book and I believe is correct. MariaDB does not support this, but the text states that it refers to the SQL standard, and not specifically MariaDB. 4) Missing ALL_O_DIRECT. Thanks, I will add this. Feel free to report other mistakes and omissions, preferably as separate tasks unless they're directly related.
            ivan.stoykov@skysql.com Stoykov (Inactive) added a comment - http://search.mariadb.com/search.cgi
            greenman Ian Gilfillan added a comment -

            Unassigning from me, as the only outstanding issue is the downloadable version

            greenman Ian Gilfillan added a comment - Unassigning from me, as the only outstanding issue is the downloadable version
            greenman Ian Gilfillan added a comment -

            See also https://mariadb.com/kb/en/meta/mirroring-the-knowledge-base/ which describes a way to get an offline version.

            greenman Ian Gilfillan added a comment - See also https://mariadb.com/kb/en/meta/mirroring-the-knowledge-base/ which describes a way to get an offline version.
            bryan Bryan Alsdorf added a comment -

            Downloadable version is on my TODO but no ETA at this point unfortunately. Will update when I have a better idea.

            bryan Bryan Alsdorf added a comment - Downloadable version is on my TODO but no ETA at this point unfortunately. Will update when I have a better idea.
            bryan Bryan Alsdorf added a comment -

            We are in the process of overhauling documentation and will address this then.

            bryan Bryan Alsdorf added a comment - We are in the process of overhauling documentation and will address this then.
            nunop Nuno added a comment -

            MySQL allows us to download an HTML version of the knowledge base:

            https://dev.mysql.com/doc/ -> HTML Download (Zip) - 10.6Mb

            PHP allows the same: https://www.php.net/download-docs.php

            I understand MariaDB has a static copy of the KB, https://mariadb.com/kb/en/meta/mirroring-the-mariadb-knowledge-base/
            But, it doesn't seem to be an efficient way of downloading it.

            Could we have all that static mirror downloadable in a zip file?

            Thank you!

            nunop Nuno added a comment - MySQL allows us to download an HTML version of the knowledge base: https://dev.mysql.com/doc/ -> HTML Download (Zip) - 10.6Mb PHP allows the same: https://www.php.net/download-docs.php I understand MariaDB has a static copy of the KB, https://mariadb.com/kb/en/meta/mirroring-the-mariadb-knowledge-base/ But, it doesn't seem to be an efficient way of downloading it. Could we have all that static mirror downloadable in a zip file? Thank you!

            People

              bryan Bryan Alsdorf
              ivan.stoykov@skysql.com Stoykov (Inactive)
              Votes:
              2 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Git Integration

                  Error rendering 'com.xiplink.jira.git.jira_git_plugin:git-issue-webpanel'. Please contact your Jira administrators.