Uploaded image for project: 'MariaDB Server'
  1. MariaDB Server
  2. MDEV-26370

Documentation on some mariabackup options is missing details

    XMLWordPrintable

Details

    Description

      Our KB does not provide enough details (like range of values or default value) for some options of mariabackup. Consider --use-memory:

      https://mariadb.com/kb/en/mariabackup-options/#-use-memory

      It says nothing about acceptable range of values and default value. One can find out it's 100M by default in the code:

      https://github.com/MariaDB/server/blob/ddcb242b3cd2e95bcf4c950bffaafc0775db45ee/extra/mariabackup/xtrabackup.cc#L1013

      or just test:

      openxs@ao756:~/dbs/maria10.1$ bin/mariabackup --no-defaults --prepare --binlog-info=ON --target-dir=/tmp/101 --socket=/tmp/mariadb2.sock -uroot
      bin/mariabackup based on MariaDB server 10.1.49-MariaDB Linux (x86_64)
      mariabackup: cd to /tmp/101/
      mariabackup: This target seems to be not prepared yet.
      mariabackup: xtrabackup_logfile detected: size=2097152, start_lsn=(1616733)
      mariabackup: using the following InnoDB configuration for recovery:
      mariabackup:   innodb_data_home_dir = ./
      mariabackup:   innodb_data_file_path = ibdata1:10M:autoextend
      mariabackup:   innodb_log_group_home_dir = ./
      mariabackup:   innodb_log_files_in_group = 1
      mariabackup:   innodb_log_file_size = 2097152
      mariabackup: using the following InnoDB configuration for recovery:
      mariabackup:   innodb_data_home_dir = ./
      mariabackup:   innodb_data_file_path = ibdata1:10M:autoextend
      mariabackup:   innodb_log_group_home_dir = ./
      mariabackup:   innodb_log_files_in_group = 1
      mariabackup:   innodb_log_file_size = 2097152
      mariabackup: Starting InnoDB instance for recovery.
      mariabackup: Using 104857600 bytes for buffer pool (set by --use-memory parameter)
      ...
      

      but this should be clearly and explicitly documented. As a side note, Enterprise Documentation also says nothing useful about this option.

      Attachments

        Activity

          People

            greenman Ian Gilfillan
            valerii Valerii Kravchuk
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:

              Git Integration

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