Documentação do sistema de controle de versão para SQL

Aplica-se a:SQL ServerBase de Dados SQL do AzureAzure Synapse Analytics

Este artigo explica o nosso sistema de controlo de versões da documentação SQL. O sistema de versionamento conhece os produtos e suas versões. O sistema permite-lhe escolher o produto e a versão em que está interessado. Em seguida, o sistema exibe a documentação apropriada.

Aplica-se a produtos

A maioria dos artigos do SQL Server tem as palavras Aplica-se a sob seu título. Na mesma linha, segue-se uma lista prática de produtos SQL com indicadores de se o artigo é relevante para o produto. Por exemplo, o produto SQL Server pode ser indicado como relevante, enquanto o Banco de Dados SQL do Azure pode ser indicado como irrelevante para o artigo.

A linha Aplica-se a não reconhece versões de produtos. Procuramos evitar discrepâncias entre a linha Aplica-se a e a componente de produtos das configurações do nosso sistema de controlo de versões.

Histórico de conjuntos de arquivos separados

Para o SQL Server 2014 e versões anteriores, cada versão tem sua própria cópia separada completa dos arquivos de documentação. Por exemplo, a documentação do SQL Server 2014 começou como uma cópia da documentação do SQL Server 2012. A cópia de 2014 foi então editada durante o ciclo de desenvolvimento do produto.

Esta abordagem antiga significava que, se uma falha fosse descoberta na documentação de 2014, a falha também poderia existir em 2012 e 2008. Isso dificultou a correção de falhas e a manutenção geral.

Várias versões nos mesmos arquivos

Por esse motivo e outros, os arquivos de documentação do SQL Server 2016 também são para 2017, 2019 e, provavelmente, para <vNext>. Essa consolidação é tornada prática porque agora atribuímos apelidos de controle de versão aos nossos arquivos de documentação do SQL Server. Os identificadores de controlo de versões são atribuídos ou explicitamente incorporados com o grau de granularidade que fizer sentido para cada ficheiro de documentação.

Controle de versão na interface do usuário

Quando você visualiza qualquer artigo de documentação SQL usando nosso Docs site, o moniker de controle de versão escolhido atualmente é visível acima do sumário (TOC). O controle é uma lista suspensa.

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

Se quiser ver a documentação de uma versão diferente do SQL Server, selecione a seta de expansão localizada no final do moniker da versão atual. Em seguida, selecione para escolher qualquer combinação de produto e versão que desejar. Quando você seleciona uma versão diferente, a documentação exibida muda repentinamente para mostrar as diferenças para a versão recém-escolhida. Pode haver ou não alterações, e ambos os casos são comuns.

media_versioning-control-20-expanded.png

Parâmetro HTTPS view=

Cada artigo cujo endereço Web começa com https://learn.microsoft.com/sql/ tem um parâmetro nomeado ?view= anexado ao seu endereço. Esse valor de parâmetro é o código de moniker de versionamento.

O código do identificador no endereço https corresponde sempre ao nome do identificador apresentado no controlo de versões.

Produtos, não edições

Edições

Na década de 1990 e nos anos 2000, o Microsoft SQL Server tinha apenas um produto. Havia várias edições de cada versão do SQL Server, como as edições Developer e Enterprise do SQL Server 2008. As edições representavam conjuntos de recursos ligeiramente diferentes, mas o produto principal era o mesmo. As novas versões do SQL Server ainda podem ter várias edições.

Products

Com a ascensão mais recente da computação em nuvem e do Microsoft Azure, a Microsoft lançou seu produto Banco de Dados SQL do Azure. Embora haja muito código compartilhado pelo produto local tradicional do SQL Server e pelo produto Banco de Dados SQL do Azure, esses produtos são dois produtos verdadeiramente separados.

No SQL, os identificadores de versionamento distinguem entre produtos, mas não entre edições.

Produtos SQL na nuvem do Azure

Para artigos, endereços da Web inteiros começam com https://learn.microsoft.com/sql/, quase todos se aplicam a pelo menos uma versão do produto chamado SQL Server. Um grande subconjunto desses artigos também se aplica a um ou mais de nossos produtos de serviço SQL hospedados em nossa nuvem do Azure. Um desses produtos de nuvem SQL é chamado Banco de Dados SQL do Azure.

Naturalmente, o produto Banco de Dados SQL do Azure tem apenas uma versão. Quase todos os artigos que se aplicam ao Banco de Dados SQL do Azure, mas não ao SQL Server, têm endereços Web começando com https://learn.microsoft.com/azure/sql-database/.

Cenários de filtragem de versão

O sistema de controle de versão funciona filtrando todo o conteúdo da documentação que não se aplica ao moniker ativo no momento. Sempre que escolher um identificador de versão diferente, o conjunto de conteúdos ocultos muda. A filtragem oculta o conteúdo nos seguintes níveis:

  • Seções ou frases dentro de um artigo.
  • Entradas de artigos no índice (TOC).

Seguem-se cenários que explicam os efeitos da escolha de um apelido diferente.

Cenário 1: Dentro do artigo atual

O cenário a seguir se concentra em seções dentro do seu artigo atual:

  1. O moniker de controle de versão atual é SQL Server 2017.
  2. Você está lendo uma seção que descreve um recurso que foi adicionado pela primeira vez à versão 2017 do SQL Server.
  3. Alterar o moniker para SQL Server 2016.
  4. Você percebe que a seção que você estava lendo se foi.
  5. Você altera novamente o moniker, desta vez para SQL Server 2019.
  6. Você percebe que a seção de 2017 que você estava lendo está de volta à exibição.

No cenário anterior, a secção sobre a nova funcionalidade de 2017 está provavelmente assinalada com um intervalo de identificadores que inclui o seguinte código de identificador:

  • >=sql-server-2017

Quando o apelido SQL Server 2019 foi escolhido, o sistema de versionamento percebeu que 2019 é maior ou igual a 2017 e exibiu a seção.

Cenário 2: Selecione um link para um artigo oculto

O cenário incomum a seguir explica o que acontece se você selecionar um link para um artigo que está atualmente oculto do sumário (TOC). Em resumo, o link funciona:

  1. O moniker de controle de versão atual é SQL Server 2017.
  2. No artigo Aatual , selecione um link para um artigo B que se aplica somente ao SQL Server 2016.
    • Antes da seleção, no índice, a entrada do artigo B está oculta.
  3. Após a seleção, o artigo B é exibido.
    • A apresentação do artigo B força o controlo de versões a mudar para a designação SQL Server 2016.
    • Porque o apelido original SQL Server 2017 teve que ser abandonado. Esse abandono faz com que uma mensagem informativa seja exibida perto da parte superior da página da Web. A mensagem explica que o apelido atual teve que ser trocado para acomodar o novo artigo B.

Cenário 3: Navegar até um endereço https

O seguinte artigo foi adicionado novo para o SQL Server 2017. O artigo descreve os recursos que foram adicionados ao SQL Server na versão 2017. A maioria ou todos esses novos recursos também fazem parte da versão 2019. Aqui estão os atributos do artigo.

Attribute Valor
Title O que há de novo no SQL Server 2017
Gama de apelidos =">= sql-server-2017"
https Endereço https://learn.microsoft.com/sql/sql-server/what-s-new-in-sql-server-2017

Dado o endereço base https , a tabela a seguir explica o que acontece quando o ?view= parâmetro é anexado pelo usuário e com vários valores.

Valor de ?view= Comportamento da navegação de endereços https
(Sem parâmetro) O sistema de controlo de versões tentaria utilizar o valor predefinido do identificador. Normalmente, definimos isso para a versão mais recente não visualizada do SQL Server.

Um padrão do SQL Server 2017 ou 2019 satisfaria o atributo >= sql-server-2017.

O sistema acrescentaria o parâmetro ao https endereço, talvez como ?view=sql-server-2017.
O controle de lista suspensa de controle de versão seria então definido como o nome do apelido correspondente.
sql-server-2016 O sistema de versionamento perceberia que o intervalo de apelidos do artigo não inclui a versão 2016.

O sistema escolheria então um dos apelidos que satisfizesse o intervalo.

Então, como no caso da versão 2016, o parâmetro ?view= seria anexado e o nome do controle corresponderia ao valor do parâmetro.
sql-server-2017 O sistema de controle de versão entende que o valor do parâmetro está incluído no intervalo de apelidos do artigo.

O controle de versão seria definido para corresponder ao valor do parâmetro.
sql-server-2019 O mesmo que para o caso do valor sql-server-2017, exceto o parâmetro e o controle estão definidos para 2019.

All SQL - Não ocultar nada, designação especial

Há um nome especial de produto de All SQL, e a sua única versão é Não ocultar nada. O objetivo deste apelido é para testes internos de certas mudanças. Se usado por um cliente, este apelido é mais suscetível de induzir em erro do que de informar.

Alguns artigos têm informações referentes a várias versões do SQL Server. Cada apelido regular oculta seções versionadas que, de outra forma, poderiam exibir informações imprecisas, confusas ou contraditórias para a versão do apelido. O moniker All SQL especial exibiria todas as seções de versão e pode não ser óbvio que informações imprecisas estão sendo exibidas.

Mensagem: A página solicitada não está disponível para <moniker>

O cenário a seguir leva à exibição de uma mensagem informativa na parte superior da Docs página da Web:

  1. Atualmente, o moniker de controle de versão é SQL Server 2017.
  2. Você está lendo um artigo relevante para o SQL Server 2017.
    • O artigo não é relevante para o produto Banco de Dados SQL do Azure.
  3. Você tenta alterar o moniker para o Banco de Dados SQL do Azure - current.
  4. Você vê que sua tentativa foi rejeitada e uma mensagem é exibida.

No final desse cenário, você verá a seguinte mensagem informativa exibida perto da parte superior da página da Web do Documentos:

A página solicitada não está disponível para o Banco de Dados SQL do Azure - atual. Você foi redirecionado para a versão mais recente do produto para a qual esta página está disponível.

A versão mais recente pode excluir versões que ainda não foram totalmente lançadas e estão no status de visualização .

media_versioning-control-30-viewfallbackfrom.png

Versões anteriores do SQL Server

O sistema de controle de versão é totalmente implementado para o SQL Server versão 2016 em diante.