Программа sqlmaint

Статья
05/30/2023

Область применения: SQL Server

Программаsqlmaint выполняет заданный набор операций обслуживания с одной или несколькими базами данных. Программа sqlmaint используется для выполнения проверок DBCC, создания резервных копий базы данных и ее журнала транзакций, обновления статистики и перестроения индексов. При всех действиях по обслуживанию базы данных формируется отчет, который можно записать в указанный текстовый файл, в HTML-файл или отправить по электронной почте. sqlmaint выполняет планы обслуживания баз данных, созданные в предыдущих версиях SQL Server. Для запуска планов обслуживания SQL Server из командной строки используйте dtexec Utility.

Внимание

Эта функция будет удалена в будущей версии SQL Server. Избегайте использования этого компонента в новых разработках и запланируйте изменение существующих приложений, в которых он применяется. Вместо этого используйте функцию плана обслуживания SQL Server. Дополнительные сведения о планах обслуживания см. в разделе Планы обслуживания.

Синтаксис

  
sqlmaint   
[-?] |  
[  
     [-S server_name[\instance_name]]  
     [-U login_ID [-P password]]  
     {  
          [-D database_name | -PlanName name | -PlanID guid ]  
          [-Rpt text_file]  
          [-To operator_name]  
          [-HtmlRpt html_file [-DelHtmlRpt <time_period>] ]  
          [-RmUnusedSpace threshold_percentfree_percent]  
          [-CkDB | -CkDBNoIdx]  
          [-CkAl | -CkAlNoIdx]  
          [-CkCat]  
          [-UpdOptiStats sample_percent]  
          [-RebldIdx free_space]  
          [-SupportComputedColumn]  
          [-WriteHistory]  
          [  
               {-BkUpDB [backup_path] | -BkUpLog [backup_path] }  
               {-BkUpMedia  
                    {DISK [  
                           [-DelBkUps <time_period>]   
                           [-CrBkSubDir ]   
                           [-UseDefDir ]   
                          ]  
                     | TAPE   
                    }  
               }  
               [-BkUpOnlyIfClean]  
               [-VrfyBackup]  
          ]  
     }  
]  
<time_period> ::=  
number[minutes | hours | days | weeks | months]

Аргументы

Параметры и их значения должны разделяться пробелами. Например, пробел должен быть между -S и аргументом server_name.

-?
Указывает, что должна быть возвращена диаграмма синтаксиса sqlmaint . При использовании этого параметра использование других параметров не допускается.

-S server_name[\ instance_name]
Указывает целевой экземпляр Microsoft SQL Server. Укажите имя_сервера, чтобы подключиться к экземпляру ядра СУБД SQL Server по умолчанию на этом сервере. Укажите имя_сервера\имя_экземпляра, чтобы подключиться к именованному экземпляру ядра СУБД на этом сервере. Если сервер не указан, sqlmaint подключается к экземпляру ядра СУБД по умолчанию на локальном компьютере.

-U имя_для_входа
Указывает используемый идентификатор входа при соединении с сервером. Если этот параметр не указан, sqlmaint пытается использовать проверку подлинности Microsoft Windows. Если аргумент login_ID содержит специальные символы, он должен быть заключен в двойные кавычки ("). В противном случае использование двойных кавычек необязательно.

Внимание

По возможности используйте аутентификацию Windows.

-P пароль
Указывает пароль для идентификатора имени входа. Используется только вместе с параметром -U . Если аргумент password содержит специальные символы, он должен быть заключен в двойные кавычки. В противном случае использование двойных кавычек необязательно.

Внимание

Маскировка пароля не производится. По возможности используйте аутентификацию Windows.

-D имя_базы_данных
Указывает имя базы данных, с которой будут производиться операции обслуживания. Если аргумент database_name содержит специальные символы, он должен быть заключен в двойные кавычки. В противном случае использование двойных кавычек необязательно.

-PlanName имя
Указывает имя плана обслуживания базы данных, определенного с помощью мастера планов обслуживания баз данных. Единственные сведения, которые программа sqlmaint использует из этого плана, — это список баз данных в плане. Любые действия по обслуживанию, которые указываются в других параметрах sqlmaint , применяются ко всем базам данных из этого списка.

-PlanID GUID
Указывает идентификатор GUID плана обслуживания базы данных, определенного с помощью мастера планов обслуживания баз данных. Единственные сведения, которые программа sqlmaint использует из этого плана, — это список баз данных в плане. Любые действия по обслуживанию, которые указываются в других параметрах sqlmaint , применяются ко всем базам данных из этого списка. Значение должно совпадать со значением аргумента plan_id в таблице msdb.dbo.sysdbmaintplans.

-Rpt текстовый_файл
Указывает полный путь и имя файла, в котором будет сформирован отчет. Отчет также выводится на экран. В отчете сведения о версии отражаются при помощи добавления даты к имени файла. Дата формируется следующим образом: в конце имени файла, но перед точкой в формате _ггггММддччмм. гггг = год, ММ = месяц, дд = день, hh = часы, мм = минуты.

При запуске программы в 10:23 1 декабря 1996 года значение аргумента text_file будет иметь следующее значение:

c:\Program Files\Microsoft SQL Server\Mssql\Backup\AdventureWorks2022_maint.rpt

Имя создаваемого файла:

c:\Program Files\Microsoft SQL Server\Mssql\Backup\AdventureWorks2022_maint_199612011023.rpt

Когда sqlmaint обращается к удаленному серверу, в качестве аргумента text_file необходимо указывать полное UNC-имя.

-To имя_оператора
Указывает оператора, которому будет отправлен сформированный отчет через службу SQL Mail.

-HtmlRpt файл_HTML
Указывает полный путь и имя файла, в котором будет сформирован HTML-отчет. Программаsqlmaint формирует имя файла, добавляя к нему строку в формате _ггггММддччмм (как и в случае с параметром -Rpt ).

Когда sqlmaint обращается к удаленному серверу, в качестве аргумента html_file необходимо указывать полное UNC-имя файла.

-DelHtmlRpt<time_period>
Указывает, что любой отчет в формате HTML в каталоге отчетов будет удален, если интервал времени с момента создания превысит значение аргумента <time_period>. -DelHtmlRpt ищет файлы, имена которых соответствуют шаблону, сформированному на основе параметра html_file. Если html_file имеет значение c:\Program Files\Microsoft SQL Server\Mssql\Backup\AdventureWorks2022_maint.htm, то -DelHtmlRpt приводит к удалению всех файлов, имена которых соответствуют шаблону C:\Program Files\Microsoft SQL Server\Mssql\Backup\AdventureWorks2022_maint*.htm и старше указанного <time_period>.

-RmUnusedSpace пороговое_значение_(процент) свободное_пространство_(процент)
Указывает, что нужно удалить неиспользуемое пространство из базы данных, указанной в параметре -D. Этот параметр полезен только для тех баз данных, в которых задан автоматический рост. АргументThreshold_percent задает размер в мегабайтах, которого должна достичь база данных, прежде чем sqlmaint попытается удалить неиспользованное пространство данных. Если база данных меньше значения threshold_percent, никакие действия не выполняются. Значениеfree_percent задает размер сохраняемого неиспользуемого пространства в базе данных, указываемого в виде процента от конечного размера базы данных. Например, если база данных размером 200 MБ содержит 100 MБ данных, то указание значения 10 в качестве аргумента free_percent приводит к тому, что конечный размер базы данных будет составлять 110 MБ. Обратите внимание, что увеличения базы данных не происходит, если ее размер меньше суммы значения free_percent и объема данных в базе. Например, если база данных размером 108 MБ содержит данные размером 100 MБ, то указание 10 в качестве значения free_percent не приведет к увеличению базы данных до 110 MБ, ее размер останется равным 108 MБ.

-CkDB | - CkDBNoIdx
Запускает выполнение инструкции DBCC CHECKDB или DBCC CHECKDB с параметром NOINDEX в базе данных, указанной в параметре -D. Дополнительные сведения см. в разделе DBCC CHECKDB.

Если при запуске sqlmaint база данных уже используется, в text_file записывается предупреждение.

-CkAl | - CkAlNoIdx
Запускает выполнение инструкции DBCC CHECKALLOC с параметром NOINDEX в базе данных, указанной в параметре -D. Дополнительные сведения см. в разделе DBCC CHECKALLOC (Transact-SQL).

-CkCat
Запускает выполнение инструкции DBCC CHECKCATALOG (Transact-SQL) в базе данных, указанной в параметре -D. Дополнительные сведения см. в разделе Инуструкция DBCC CHECKCATALOG (Transact-SQL).

-UpdOptiStats пример_значения (процент)
Задает применение следующей инструкции к каждой таблице базы данных:

UPDATE STATISTICS table WITH SAMPLE sample_percent PERCENT;

Если в таблицах есть вычисляемые столбцы, при использовании параметра -UpdOptiStats необходимо также задавать аргумент -SupportedComputedColumn.

Дополнительные сведения см. в статье Инструкция UPDATE STATISTICS (Transact-SQL).

-RebldIdx свободное_пространство
Задает перестройку индексов в таблицах базы данных-получателя с использованием процентного значения free_space , которое составляет 100 % в сумме с коэффициентом заполнения. Например, если процент free_space равен 30, то используемый коэффициент заполнения равен 70. Если заданное значение процентов free_space равно 100, то повторное создание индексов происходит с использованием начального коэффициента заполнения.

Если индексы построены на вычисляемых столбцах, при использовании параметра -RebldIdx необходимо также задавать аргумент -SupportComputedColumn.

-RebldIdx
Обязательно указывается, если программа sqlmaint должна выполнить команды обслуживания DBCC для вычисляемых столбцов.

-WriteHistory
Задает создание записи журнала в msdb.dbo.sysdbmaintplan_history для каждой операции обслуживания, выполненной программой sqlmaint. Если указано значение -PlanName или -PlanID , то в записях журнала в sysdbmaintplan_history присутствует идентификатор указанного плана. Если указано значение -D , то в записи журнала в sysdbmaintplan_history в качестве значения идентификатора плана содержатся нули.

-BkUpDB [ backup_path] | -BkUpLog [ backup_path ]
Задает действие резервного копирования. -BkUpDb выполняет резервное копирование всей базы данных. -BkUpLog создает резервную копию только журнала транзакций.

backup_path указывает каталог для резервной копии. Аргументbackup_path не нужно указывать, если указан параметр -UseDefDir . Если указать аргумент и параметр, параметр -UseDefDir переопределит аргумент. Резервную копию можно поместить в каталог или адрес ленты (например, \\.\TAPE0). Имя файла резервной копии базы данных создается автоматически следующим образом:

dbname_db_yyyyMMddhhmm.BAK

где

dbname — имя базы данных, резервная копия которой создается.
ггггММддччмм — время операции резервного копирования, где гггг = год, ММ = месяц, дд = день, hh = часы, а мм = минуты.

Имя файла резервной копии журнала транзакций автоматически создается в аналогичном формате:

dbname_log_yyyymmddhhmm.BAK

При использовании параметра -BkUpDB необходимо также указать носитель данных (указывается с помощью параметра -BkUpMedia ).

-BkUpMedia
Задает тип носителя для резервной копии, DISK (диск) или TAPE (лента).

DISK;
Указывает, что носителем данных резервных копий является диск.

-DelBkUps<time_period>
Указывает для резервных копий диска, что любой файл резервной копии в соответствующем каталоге будет удален, если интервал времени с момента создания превысит значение аргумента <time_period>.

-CrBkSubDir
При резервном копировании дисков, если указан параметр-UseDefDir, создает вложенный каталог в каталоге [ backup_path ] или в каталоге резервных копий по умолчанию. Имя вложенного каталога создается на основе имени базы данных, указанной в параметре -D. Чтобы быстро перенести все резервные копии различных баз данных в отдельные вложенные каталоги, не изменяя параметр-CrBkSubDir , задайте параметр -CrBkSubDir .

-UseDefDir
Для резервного копирования на диск задает создание файла резервной копии в каталоге резервных копий по умолчанию. ПараметрUseDefDir переопределяет значение backup_path , если они указаны одновременно. При установке Microsoft SQL Server с параметрами по умолчанию каталогом резервных копий является C:\Program Files\Microsoft SQL Server\MSSQL10_50.MSSQLSERVER\MSSQL\Backup.

TAPE;
Указывает, что носителем данных резервных копий является ленточный накопитель.

-BkUpOnlyIfClean
Указывает, что операция резервного копирования производится только в том случае, если заданные проверки -Ck не обнаружили ошибок в данных. Действия по обслуживанию запускаются в порядке, в котором они указаны в командной строке. Если вы хотите указать параметр -BkUpOnlyIfClean, укажите перед параметром -BkUpDB-BkUpLog параметр-CkDB ,-CkDBNoIdx ,-CkAl , -CkAlNoIdx ,/-CkTxtAl или -CkCat. Иначе резервное копирование будет выполняться независимо от наличия ошибок.

-VrfyBackup
Задает выполнение RESTORE VERIFYONLY на резервной копии по завершении ее создания.

number[minutes| hours| day| weeks| months]
Задает интервал времени, используемый для определения, является ли отчет или файл резервной копии достаточно старым для его удаления. number — целое число, за которым (без пробела) следует единица измерения времени. Допустимые варианты:

12недель
3месяца
15дней

Если указано только number , то используемой по умолчанию частью даты будут недель.

Замечания

Программа sqlmaint выполняет операции обслуживания с одной или несколькими базами данных. Если указан параметр -D , операции, заданные в остальных параметрах, выполняются только с указанной базой данных. Если указан параметр -PlanName или -PlanID , sqlmaint получает из указанного плана обслуживания только сведения о списке баз данных. Все операции, указанные в остальных параметрах sqlmaint , применяются ко всем базам данных, которые указаны в полученном из плана списке. Программа sqlmaint не выполняет операции обслуживания, определенные в самом плане.

В случае успешного выполнения sqlmaint возвращает 0, а в случае ошибки — 1. Сообщение об ошибке выводится:

в случае неудачи любой из операций обслуживания;
если проверка -CkDB, -CkDBNoIdx, -CkAl, -CkAlNoIdx, -CkTxtAlили -CkCat обнаруживает ошибки в данных;
в случае общего сбоя.

Разрешения

Программу sqlmaint может выполнить любой пользователь Windows, у которого есть разрешения на чтение и выполнение файла sqlmaint.exe(по умолчанию находится в папке x:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER1\MSSQL\Binn ). Кроме того, учетные данные SQL Server, указанные в параметре -login_ID, должны иметь разрешения , необходимые для выполнения указанного действия. Если соединение с SQL Server использует проверку подлинности Windows, учетные данные SQL Server, сопоставленные с прошедшим проверку пользователем Windows, должны иметь разрешения , достаточные для выполнения указанного действия.

Например, для параметра -BkUpDB требуется разрешение на выполнение инструкции BACKUP, а использование аргумента -UpdOptiStats предполагает наличие разрешения на выполнение инструкции UPDATE STATISTICS. Дополнительные сведения см. в подразделах «Разрешения» соответствующих разделов электронной документации.

Примеры

А. Выполнение проверок DBCC в базе данных

sqlmaint -S MyServer -D AdventureWorks2022 -CkDB -CkAl -CkCat -Rpt C:\MyReports\AdvWks_chk.rpt

B. Обновление статистики, используя в качестве образца 15 % данных из всех баз данных, содержащихся в плане. Также сжимает все базы данных, размер которых достиг 110 MБ, чтобы свободное пространство в них составляло только 10%

sqlmaint -S MyServer -PlanName MyUserDBPlan -UpdOptiStats 15 -RmUnusedSpace 110 10

C. Создание резервных копий всех баз данных, содержащихся в плане, в отдельных вложенных каталогах в каталоге по умолчанию (x:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Backup). Кроме того, удаляет резервные копии, созданные ранее чем две недели назад

sqlmaint -S MyServer -PlanName MyUserDBPlan -BkUpDB -BkUpMedia DISK -UseDefDir -CrBkSubDir -DelBkUps 2weeks

D. Создание резервной копии базы данных в каталоге по умолчанию (x:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Backup)

sqlmaint -S MyServer -BkUpDB -BkUpMedia DISK -UseDefDir

См. также

BACKUP (Transact-SQL)
UPDATE STATISTICS (Transact-SQL)

Поделиться через

Программа sqlmaint

Синтаксис

Аргументы

Замечания

Разрешения

Примеры

А. Выполнение проверок DBCC в базе данных

D. Создание резервной копии базы данных в каталоге по умолчанию (x:\Program Files\Microsoft SQL Server\MSSQL13.MSSQLSERVER\MSSQL\Backup)

См. также

Обратная связь

Дополнительные ресурсы