Comment écrire du SQL lisible dans VB.NET

Question

Lors de l'écriture de SQL dans VB.NET, on finit souvent par quelque chose de complètement illisible en raison du manque de chaînes multilignes de VB.

Par exemple:

Dim sql As String = "SELECT t1.Name, t1.Description, t1.Address, t1.PhoneNumber, t2.RegistrationID, t2.Date, t2.Description, t2.RegistrationStatus FROM Users t1 JOIN Registrations t2 ON t1.UserID = t2.UserID WHERE t2.RegistrationID = @RegistrationID" 

Vous pouvez briser la chaîne en utilisant des caractères de continuation de ligne, mais les guillemets supplémentaires et des caractères de continuation de ligne font de ce plus difficile à lire. En outre, il rend le transfert de la requête entre le code et le SSMS difficile.

Existe-t-il une solution qui rend SQL lisible dans VB et permet également de transférer facilement des requêtes (via copier/coller) entre le code VB et SSMS (ou tout autre éditeur SQL/IDE)?

Answer 1

La meilleure solution que j'ai trouvée est d'utiliser la fonctionnalité XML literals de VB (disponible depuis VS 2008).
Les attributs littéraux XML permettent des chaînes multilignes.

Dim sql As String = 
    <sql text=" 
     SELECT t1.Name, 
       t1.Description, 
       t1.Address, 
       t1.PhoneNumber, 
       t2.RegistrationID, 
       t2.Date, 
       t2.Description, 
       t2.RegistrationStatus 
     FROM Users t1 
       JOIN Registrations t2 ON t1.UserID = t2.UserID 
     WHERE t2.RegistrationID = @RegistrationID 
    " />.Attribute("text").Value 

L'une mise en garde est qu'il faut coder plus-que et moins que les comparaisons comme des entités XML: < devient < et > devient >.

Answer 2

Je permute l'activation et la désactivation du mot.

Edit>Advanced>Word wrap

je l'ai trouvé intéressant d'ajouter comme un bouton à la barre d'outils Visual Studio.

Answer 3

Est-il possible pour vous de mettre à niveau vers Visual Studio 2015?
Vous pouvez utiliser les nouvelles littéraux de chaîne multi-ligne dans Visual Basic 14:

Dim sql As String = " 
    SELECT t1.Name, 
      t1.Description, 
      t1.Address, 
      t1.PhoneNumber, 
      t2.RegistrationID, 
      t2.Date, 
      t2.Description, 
      t2.RegistrationStatus 
    FROM Users t1 
      JOIN Registrations t2 ON t1.UserID = t2.UserID 
    WHERE t2.RegistrationID = @RegistrationID 
" 

Il n'y a pas de limitations déjà connues de XML multi-liners (problèmes <, &, ...). La seule chose dont vous avez besoin pour vous échapper à l'intérieur de la chaîne est " (remplacez-la par "").

Et nouvelle fonctionnalité vous permet de faire vos chaînes lisibles comme jamais avant d'interpolation de chaîne :

Dim tableName As String = "Registrations" 
Dim currentOrderByColumn As String = "t2.Date" 

Dim sql = $"SELECT t1.Name, t1.Description FROM {tableName} ORDER BY {currentOrderByColumn}" 

Dim sql2 = $" 
    SELECT t1.Name, t1.Description 
    FROM {tableName} 
    ORDER BY {currentOrderByColumn} 
" 

expressions à l'intérieur des chaînes interpolées soutenir également entièrement renommage, donc renommer tableName-mainTableName effectuerons également renommer à l'intérieur du chaîne.

caractères supplémentaires que vous devez prendre en charge dans ce type de chaîne sont { et } - vous devez les remplacer par {{ ou }} respectivement. Mais dans T-SQL they have only one specific purpose.

Plus d'informations: 1, 2

---

Avis: Si vous souhaitez conserver temporairement l'aide solution XML désapprouvée, alors NE PAS utiliser le formulaire
<tag attribute="text" />.Attribute("attribute").Value
parce qu'il supprime nouveau caractères de ligne ce qui conduit à étranges SQL single-liners comme
SELECT t1.Name, t1.Description, t2.Date FROM Users t1.

Au lieu de cela, utilisez le formulaire
<tag>text</tag>.Value
qui préserve les fins de ligne donc ce que vous voyez (dans l'éditeur de code) est ce que vous obtenez (à l'entrée du processeur de commande SQL). La lisibilité SQL est l'objectif principal de cette Q/A et ce détail en fait partie.

(Mais rappelez-vous cette amélioration de la forme de SQL en XML est obsolète, trop = cela fonctionne, mais abandonner le plus tôt possible.)