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


Система управления версиями в документации по SQL

Область применения: SQL Server База данных SQL Azure Azure Synapse Analytics AnalyticsPlatform System (PDW)

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

Применимо к продуктам

В большинстве статей об SQL Server под заголовком есть строка, начинающаяся со слов Область применения. После них перечислены продукты SQL и указано, относится ли к ним статья. Например, статья может относиться к SQL Server, но не относиться к базе данных SQL Azure.

Область применения к строке не знает о версиях продуктов. Мы стремимся избегать расхождений между содержимым строки Область применения и продуктами в конфигурациях системы управления версиями.

История отдельных наборов файлов

Для SQL Server 2014 и более ранних версий существует отдельная полная копия файлов документации для каждой версии. Например, разработка документации по SQL Server 2014 начиналась с копии документации по SQL Server 2012. Затем в процессе развития продукта копия для версии 2014 редактировалась.

При таком подходе, если в документации по версии 2014 обнаруживалась и устранялась ошибка, она могла сохраняться в документации по версиям 2012 и 2008. Это усложняло устранение ошибок и обслуживание в целом.

Один набор файлов для нескольких версий

По этой и другим причинам система была изменена так, что файлы документации по SQL Server 2016 также предназначены для версий 2017, 2019, а также, возможно, для <будущей версии> (vNext). Такое объединение стало возможным благодаря моникерам версий, которые назначаются файлам документации по SQL Server. Они назначаются или внедряются явным образом с любой степенью детализации, которая целесообразна для каждого конкретного файла документации.

Управление версиями в пользовательском интерфейсе

При просмотре любой статьи документации по SQL на веб-сайте Docs текущий выбранный моникер версии отображается над оглавлением. Элемент управления — это раскрывающийся список.

media_versioning-control-10-sql-server-2017.png

Если вы хотите просмотреть документацию для другой версии SQL Server, щелкните стрелку расширения, расположенную в конце моникера текущей версии. Затем выберите любую комбинацию продуктов и версий, которую вы хотите. При выборе другой версии отображаемая документация внезапно изменяется, чтобы отобразить различия для новой выбранной версии. Изменения могут иметься или отсутствовать. Оба варианта вполне обычны.

media_versioning-control-20-expanded.png

Параметр HTTPS view=

К каждому веб-адресу статьи, начинающемуся с https://learn.microsoft.com/sql/, добавляется параметр ?view=. Его значение — это код моникера версии.

Код моникера в адресе https всегда соответствует имени моникера, отображаемому в элементу выбора версии.

Продукты и выпуски

Выпуски

В 1990-е и 2000-е годы Microsoft SQL Server был единственным продуктом SQL. Каждая версия SQL Server имела различные выпуски, например Developer и Enterprise для версии SQL Server 2008. Выпуски имели немного разные наборы возможностей, но базовый продукт был один и тот же. Новые выпуски SQL Server могут по-прежнему иметь различные выпуски.

Продукты

С развитием облачных вычислений и платформы Microsoft Azure корпорация Майкрософт выпустила новый продукт "База данных SQL Azure". Хотя существует большой объем кода, совместно используемый традиционным локальным продуктом SQL Server и продуктом Базы данных SQL Azure, эти продукты являются двумя действительно отдельными продуктами.

В документации по SQL с помощью моникеров версий различаются продукты, но не их выпуски.

Облачные продукты SQL Azure

Почти все статьи, веб-адрес которых начинается с https://learn.microsoft.com/sql/, относятся по крайней мере к одной версии продукта SQL Server. Значительная часть этих статей также относится к одному или нескольким продуктам SQL, размещенным в облаке Azure. Один из таких облачных продуктов SQL называется "База данных SQL Azure".

Разумеется, база данных SQL Azure имеет только одну версию. Почти все статьи, относящиеся к базе данных SQL Azure, но не к SQL Server, имеют веб-адрес, начинающийся с https://learn.microsoft.com/azure/sql-database/.

Сценарии фильтрации версий

Система управления версиями работает, отфильтровав все содержимое документации, которое не применяется к активному моникеру в настоящее время. Каждый раз при выборе другого моникера версии набор скрытого содержимого меняется. При фильтрации содержимое скрывается на следующих уровнях:

  • разделы или предложения в статье;
  • заголовки статей в оглавлении.

Ниже описывается, что происходит при выборе другого моникера.

Сценарий 1. В рамках текущей статьи

Ниже описывается, что происходит с разделами текущей статьи.

  1. Текущий моникер версии — SQL Server 2017.
  2. Вы читаете раздел, описывающий функцию, которая была впервые добавлена в SQL Server версии 2017.
  3. Вы меняете моникер на SQL Server 2016.
  4. Раздел, который вы читали, пропадает.
  5. Вы снова меняете моникер, на этот раз на SQL Server 2019.
  6. Раздел для версии 2017, который вы читали, снова появляется на экране.

В описанном выше сценарии раздел о новой функции в версии 2017, скорее всего, помечен диапазоном моникеров, включающим в себя следующий код моникера:

  • >=sql-server-2017

При выборе моникера SQL Server 2019 раздел отобразился, так как версия 2019 отвечает условию "больше или равно 2017".

Сценарий 2. Выбор ссылки на скрытую статью

Следующий необычный сценарий объясняет, что происходит, если выбрать ссылку на статью, которая в настоящее время скрыта от оглавление (TOC). Если говорить коротко, ссылка работает.

  1. Текущий моникер версии — SQL Server 2017.
  2. В текущей статье Aвы выбираете ссылку на статью B , которая применяется только к SQL Server 2016.
    • Перед выделением оглавление содержит ее запись для статьи B скрытой.
  3. После выбора появится статья B .
    • Отображение статьи B приводит к тому, что система управления версиями переключается на моникер SQL Server 2016.
    • Из-за этого исходный моникер SQL Server 2017 отменяется. По этой причине вверху веб-страницы выводится информационное сообщение. В сообщении поясняется, что текущий моникер пришлось сменить из-за перехода к статье B.

Сценарий 3. Переход к адресу https

Указанная ниже статья была добавлена для версии SQL Server 2017. В ней описываются возможности, появившиеся в SQL Server 2017. Большинство этих новых возможностей также имеются в версии 2019. Ниже приведены атрибуты статьи.

Атрибут Значение
Заголовок Новые возможности SQL Server 2017
диапазон моникеров =">= sql-server-2017"
адрес https https://learn.microsoft.com/sql/sql-server/what-s-new-in-sql-server-2017

В таблице ниже объясняется, что происходит при добавлении пользователем параметра https с различными значениями к базовому адресу ?view=.

Значение параметра ?view= Что происходит при переходе по адресу https
(Нет параметра) Система управления версиями пытается использовать значение моникера по умолчанию. Обычно это последняя не предварительная версия SQL Server.

Атрибуту >= sql-server-2017 по умолчанию будет соответствовать версия SQL Server 2017 или 2019.

Система добавит параметр к адресу https, например ?view=sql-server-2017.
Затем в раскрывающемся списке управления версиями будет задано имя моникера соответствия.
sql-server-2016 Система управления версиями будет понимать, что диапазон моникера статьи не включает версию 2016.

Система выберет один из моникеров, входящих в диапазон.

Затем, так же как в случае с версией 2016, будет добавлен параметр ?view= и в элементе управления будет выбран пункт, соответствующий значению параметра.
sql-server-2017 Система управления версиями определяет, что значение параметра входит в диапазон моникеров статьи.

В элементе управления версиями выбирается пункт, соответствующий значению параметра.
sql-server-2019 То же, что и в случае со значением sql-server-2017, но параметр и элемент управления устанавливаются в значение 2019.

Все SQL — скрыть ничего, специального моникера

Существует один специальный моникер название продукта All SQL, и его единственная версия не скрывает ничего. Он предназначен для внутреннего тестирования определенных изменений. При использовании клиентом этот моникер, скорее всего, будет вводить в заблуждение.

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

Сообщение: запрошенная страница недоступна для <моникера>

В описанной ниже ситуации в верхней части веб-страницы Docs появляется информационное сообщение.

  1. Текущий моникер версии — SQL Server 2017.
  2. Вы читаете статью, которая относится к SQL Server 2017.
    • Эта статья не относится к базе данных SQL Azure.
  3. Вы пытаетесь изменить моникер на Azure SQL Database — current (База данных SQL Azure — текущая).
  4. Попытка отклоняется, и выводится сообщение.

В итоге в верхней части веб-страницы документации отображается следующее информационное сообщение:

Запрошенная страница недоступна для базы данных SQL Azure . Текущая. Вы перенаправлены на последнюю версию продукта, для которой доступна эта страница.

Последняя версия может исключить версии, которые еще не полностью выпущены и находятся в состоянии предварительной версии.

media_versioning-control-30-viewfallbackfrom.png

Предыдущие версии SQL Server

Система управления версиями полностью реализована для SQL Server 2016 и последующих версий.