{"id":230,"date":"2021-07-23T12:26:00","date_gmt":"2021-07-23T12:26:00","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/how-to-manage-metadata-settings\/"},"modified":"2021-07-23T12:26:00","modified_gmt":"2021-07-23T12:26:00","slug":"how-to-manage-metadata-settings","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/how-to-manage-metadata-settings\/","title":{"rendered":"How to Manage Metadata Settings"},"content":{"rendered":"<\/p>\n
\n
\n
\n

Valid for versions 76 through the latest version<\/em><\/p>\n<\/div>\n

\n

Version:<\/h4>\n

76<\/h4>\n<\/div><\/div>\n
\n

Overview<\/h2>\n

System administrators can manage whether to create metadata for backups. Every time that cPanel & WHM creates a backup, it creates metadata for that backup. You can also manually generate backup metadata with the backups_create_metadata<\/code> script. There are several settings that disable metadata creation. You may want to disable metadata creation for testing, before an upgrade, or if your server experiences performance issues.<\/p>\n

\n
Note:<\/div>\n
\n
    \n
  • The backups_create_metadata<\/code> script will generate metadata for all directories under the \/home\/username<\/code> directory, except for the \/mail<\/code> and \/.cpanel<\/code> directories.<\/li>\n
  • Backups and metadata must<\/strong> exist on the local disk before users can access the following interfaces in cPanel & WHM version 72 and later:\n
      \n
    • cPanel\u2019s File and Directory Restoration<\/em> interface (cPanel >> Home >> Files >> File and Directory Restoration<\/em>).<\/li>\n
    • WHM\u2019s File and Directory Restoration<\/em> interface (WHM >> Home >> Backups >> File and Directory Restoration<\/em>).<\/li>\n<\/ul>\n<\/li>\n<\/ul><\/div>\n<\/div>\n

      Enable metadata creation<\/h2>\n

      Every time that cPanel & WHM creates a backup, it creates metadata for that backup. The system stores that metadata as entries in a username.db<\/code> database (where username<\/code> represents the cPanel account\u2019s username). Then, the system saves the database to the .meta<\/code> directory under your configured backup directory. The metadata databases store the indexed information of their related backups. These smaller database entries provide a faster information-retrieval method than their source backup.<\/p>\n

      Metadata database tables<\/h3>\n

      The following tables describe the fields of these smaller databases, the backup_paths<\/code> table, the backups<\/code> table, the file_changes<\/code> table, the metadata<\/code> table, and the seen_files<\/code> table.<\/p>\n

      The backup_paths table<\/h4>\n

      The backup_paths<\/code> table lists the backup files\u2019 paths.<\/p>\n\n\n\n\n\n\n
      Field<\/th>\nType<\/th>\nDescription<\/th>\nPossible values<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
      backup_path<\/code><\/td>\nstring<\/em><\/td>\nThe backup files\u2019s filepath, relative to the configured backup directory.<\/td>\nA string value.<\/td>\n\/backup\/2018-04-12\/accounts<\/code><\/td>\n<\/tr>\n
      backup_id<\/code><\/td>\ninteger<\/em><\/td>\nThe backup file\u2019s identification number.<\/td>\nA positive integer. This value references the backup_id value in the backupstable.<\/td>\n1<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      The backups table<\/h4>\n

      The backups<\/code> table lists the backup files on the disk.<\/p>\n\n\n\n\n\n\n\n
      Field<\/th>\nType<\/th>\nDescription<\/th>\nPossible values<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
      backup_id<\/code><\/td>\ninteger<\/em><\/td>\nThe backup file\u2019s identification number.<\/td>\nAn automatically-incrementing positive integer.<\/td>\n1<\/code><\/td>\n<\/tr>\n
      timestamp<\/code><\/td>\ntimestamp<\/em><\/td>\nThe backup files\u2019s creation date in Universal Time Coordinated (UTC).<\/td>\nAn integer.<\/td>\n1523642274<\/code><\/td>\n<\/tr>\n
      does_exist<\/code><\/td>\nBoolean<\/em><\/td>\nWhether the backup file exists.<\/td>\n\n
        \n
      • 1<\/code> \u2014 Exists.<\/li>\n
      • 0<\/code> \u2014 Does not<\/b> exist.<\/li>\n<\/ul>\n<\/td>\n
      		1<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

      The file_changes table<\/h4>\n

      The file_changes<\/code> table lists backup file changes when any of the following actions occur:<\/p>\n

        \n
      • The first time the system backs up the file.<\/li>\n
      • The user modifies the file.<\/li>\n
      • The user removes the file.<\/li>\n<\/ul>\n\n\n\n\n\n\n\n\n\n\n
        Field<\/th>\nType<\/th>\nDescription<\/th>\nPossible values<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
        seen_files_id<\/code><\/td>\ninteger<\/em><\/td>\nThe filepath\u2019s identification number.<\/td>\nA positive integer. This value references the file_id<\/code> value in the seen_files<\/code> table.<\/td>\n1<\/code><\/td>\n<\/tr>\n
        backup_id<\/code><\/td>\ninteger<\/em><\/td>\nThe backup file\u2019s identification number.<\/td>\nA positive integer. This value references the backup_id<\/code> value in the backups<\/code> table<\/td>\n1<\/code><\/td>\n<\/tr>\n
        size<\/code><\/td>\ninteger<\/em><\/td>\nThe backup file\u2019s size, in bytes.<\/td>\n\n
          \n
        • A file size<\/code> value displays the file\u2019s size.<\/li>\n
        • A directory or a symlink displays a 0<\/code> file size.<\/li>\n<\/ul>\n<\/td>\n
        		660<\/code><\/td>\n<\/tr>\n
        mtime<\/code><\/td>\ninteger<\/em><\/td>\nThe date when the user last modified the file, in UTC format.<\/td>\nAn integer.<\/td>\n1523642274<\/code><\/td>\n<\/tr>\n
        operation<\/code><\/td>\ninteger<\/em><\/td>\nThe change type.<\/td>\n\n
          \n
        • 0<\/code> \u2014 The user created the backup file.<\/li>\n
        • 1<\/code> \u2014 The user changed the file.<\/li>\n
        • 2<\/code> \u2014 The user removed the file.<\/li>\n<\/ul>\n<\/td>\n
        		0<\/code><\/td>\n<\/tr>\n
        type<\/code><\/td>\ninteger<\/em><\/td>\nThe backup file\u2019s type.<\/td>\n\n
          \n
        • 0<\/code> \u2014 A file.<\/li>\n
        • 1<\/code> \u2014 A directory.<\/li>\n
        • 2<\/code> \u2014 A symlink<\/li>\n<\/ul>\n<\/td>\n
        		0<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        The metadata table<\/h4>\n

        This table stores metadata keys and values.<\/p>\n\n\n\n\n\n\n
        Field<\/th>\nType<\/th>\nDescription<\/th>\nPossible values<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
        key<\/code><\/td>\nstring<\/em><\/td>\nThe metadata code type.<\/td>\nschema_version<\/code> \u2014 The metadata schema\u2019s type.<\/td>\nschema_version<\/code><\/td>\n<\/tr>\n
        value<\/code><\/td>\nstring<\/em><\/td>\nThe metadata code\u2019s version number.<\/td>\nA string value.<\/td>\n3.1<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        The seen_files table<\/h4>\n

        This table stores filenames.<\/p>\n\n\n\n\n\n\n
        Field<\/th>\nType<\/th>\nDescription<\/th>\nPossible values<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
        file_id<\/code><\/td>\ninteger<\/em><\/td>\nThe file\u2019s identification number.<\/td>\nAn automatically-incrementing positive integer.<\/td>\n1<\/code><\/td>\n<\/tr>\n
        path<\/code><\/td>\nstring<\/em><\/td>\nThe file\u2019s filepath, relative to the \/home\/username<\/code> directory.<\/td>\nA string value.<\/td>\n\/public_html\/<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        The master meta file<\/h3>\n

        The .master.meta<\/code> file stores relevant data about cPanel user backups that is not stored in the metadata database tables. This information, unlike the information in the tables, doesn\u2019t change.<\/p>\n

        Every accounts directory inside the daily, weekly, and monthly backup directories contains a .master.meta<\/code> file.<\/p>\n

        The backup directory structure<\/h2>\n

        The system stores backups inside the \/backup<\/code> directory in one of three different formats: compressed, uncompressed, and incremental. Each format uses a different filename extension.<\/p>\n\n\n\n\n\n\n\n
        Backup format<\/th>\nFilename extension<\/th>\nExample<\/th>\n<\/tr>\n<\/thead>\n
        compressed<\/td>\n.tar.gz<\/code><\/td>\nusername.tar.gz<\/code><\/td>\n<\/tr>\n
        uncompressed<\/td>\n.tar<\/code><\/td>\nusername.tar<\/code><\/td>\n<\/tr>\n
        incremental<\/td>\nNone<\/td>\nusername<\/code><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

        The system distinguishes each backup by its filepath, even if the system stores the backup information under the same name. The filepath includes the backup directory where the backup resides. The following example shows the layout and structure of a \/backup<\/code> directory.<\/p>\n

        \n
        \n<\/figure>\n

        This directory includes daily, monthly, and weekly compressed backups. You can distinguish each backup type by its complete filepath. This filepath is the file\u2019s full path. The system stores the metadata for this path in the backup_paths<\/code> table, under the backup_path<\/code> field.<\/p>\n

        The system also stores metafiles in the \/backup<\/code> directory and distinguished by their filepath. The system stores metafiles inside the \/backup<\/code> directory as entries in a username.db<\/code> database (where username<\/code> represents the cPanel account\u2019s username).<\/p>\n

        Disable metadata creation<\/h2>\n

        You can manually disable metadata with WHM\u2019s Backup Configuration<\/em> interface (WHM >> Home >> Backup >> Backup Configuration<\/em>). The following table shows which settings affect the management of metadata manually and the Backup Configuration interface. These settings function independently from one another.<\/p>\n

        \n
        Note:<\/div>\n
        \n
          \n
        • When you configure any of these settings to disable metadata creation, the following actions occur:\n
            \n
          • The system disables cPanel\u2019s File and Directory Restoration<\/em> interface (cPanel >> Home >> Files >> File and Directory Restoration<\/em>) and WHM\u2019s File and Directory Restoration<\/em> interface (WHM >> Home >> Backups >> File and Directory Restoration<\/em>). The interfaces display a notification that explains why the feature is unavailable.<\/li>\n<\/ul>\n<\/li>\n
          • You can disable metadata with the WHM API 1 backup_config_set<\/code> function.<\/li>\n<\/ul><\/div>\n<\/div>\n\n\n\n\n\n\n\n\n\n
            Backup configuration file setting<\/th>\nBackup Configuration<\/em> interface setting<\/th>\nType<\/th>\nDescription<\/th>\nPossible values<\/th>\n<\/tr>\n<\/thead>\n
            DISABLE_METADATA<\/code><\/td>\nNone<\/strong>. You must manually configure this setting with the WHM API 1 backup_config_set<\/code> function.<\/td>\nstring<\/em><\/td>\nWhether the Backup system creates metadata when a backup runs.<\/td>\n\n
              \n
            • yes<\/code> \u2014 Disables metadata creation.<\/li>\n
            • no<\/code> \u2014 Enables metadata creation.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
            BACKUPACCTS<\/code><\/td>\nBackup Accounts<\/em><\/td>\nstring<\/em><\/td>\nWhether the system includes cPanel user accounts in the backup. <\/p>\n
            \n
            Note:<\/div>\n
            \n System administrators can select which cPanel user accounts they wish to include in the backup through the Backup User Selection<\/em> interface (WHM >> Home >> Backup >> Backup User Selection<\/em>).\n <\/div>\n<\/div>\n<\/td>\n
            		\n
              \n
            • yes<\/code> or selected checkbox \u2014 Include the cPanel user accounts in the backup and enable<\/b> metadata creation.<\/li>\n
            • no<\/code> or deselected checkbox \u2014 Do not<\/b> include the cPanel user accounts in the backup and disable<\/b> metadata creation.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
            BACKUPENABLE<\/code><\/td>\nBackup Status<\/em><\/td>\nstring<\/em><\/td>\nWhether the WHM System Administrator wants backups enabled.<\/td>\n\n
              \n
            • yes<\/code> or set toggle to Enable<\/i> \u2014 Enables backup and metadata creation.<\/li>\n
            • no<\/code> or set toggle to Disable<\/i> \u2014 Disables backup and metadata creation.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
            BACKUPMOUNT<\/code><\/td>\nMount Backup Drive as Needed<\/em><\/td>\nBoolean<\/em><\/td>\nWhether the system mounts the backup directory as a mount point before a backups runs, then unmounts it when the run completes.<\/td>\n\n
              \n
            • 1<\/code> or selected checkbox —Mount the backup directory and disable<\/b> metadata creation.<\/li>\n
            • 0<\/code> or deselected checkbox \u2014 Do not<\/b> mount the backup directory and enable<\/b> metadata creation.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
            KEEPLOCAL<\/code><\/td>\nRetain backups in the default backup directory<\/em><\/td>\nBoolean<\/em><\/td>\nWhether the system retains backups in the default local backup directory.<\/td>\n\n
              \n
            • 1<\/code> or selected checkbox \u2014 Retains the backup and enable<\/b> metadata creation.<\/li>\n
            • 0<\/code> or deselected checkbox — Does not<\/b> retain the backup and disable<\/b> metadata creation.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table><\/div>\n","protected":false},"excerpt":{"rendered":"

              Valid for versions 76 through the latest version Version: 76 Overview System administrators can manage whether to create metadata for backups. Every time that cPanel & WHM creates a backup, it creates metadata for that backup. You can also manually generate backup metadata with the backups_create_metadata script. There are several settings that disable metadata creation. …<\/p>\n","protected":false},"author":1,"featured_media":231,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/230"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=230"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/230\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/231"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=230"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=230"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=230"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}