Élément d'en-tête sqloptions:initialDatabase

Cette fonctionnalité sera supprimée dans une prochaine version de Microsoft SQL Server. Évitez d'utiliser cette fonctionnalité dans de nouveaux travaux de développement et prévoyez de modifier les applications qui utilisent actuellement cette fonctionnalité.

L'en-tête SOAP sqloptions:initialDatabase permet au client de spécifier la base de données à laquelle il doit se connecter en premier lieu, par exemple :

<SOAP-ENV:Header
  xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
  xmlns:sqloptions="https://schemas.microsoft.com/sqlserver/2004/SOAP/Options">
    <sqloptions:initialDatabase           SOAP-ENV:mustUnderstand="1"          value="databaseName"           optional="true" | "false"          filename="databaseFileName" />
    
</SOAP-ENV:Header>

L'option sqloptions:initialDatabase apparaît sous forme d'en-tête SOAP. L'en-tête est composé d'un élément, appelé sqloptions:initialDatabase. L'élément possède un attribut obligatoire, value. Il s'agit d'une valeur de chaîne. L'attribut value spécifie le nom de la base de données initiale à laquelle le client doit se connecter. La chaîne est interprétée comme la commande Transact-SQL USE. L'élément possède deux attributs facultatifs : optional, qui est une valeur booléenne (la valeur par défaut est false), et filename, qui est une valeur de chaîne (la valeur par défaut est null)). L'attribut optional indique si la connexion à la base de données doit échouer. Login : false signifie que l'ouverture de session doit échouer ; true signifie que l'ouverture de session peut avoir lieu. La valeur filename précise le nom de fichier de la base de données à attacher lors de l'ouverture de session. L'utilisateur peut ainsi se connecter à une base de données qui était auparavant détachée en attachant cette base de données.

Une seule instance de l'option sqloptions:initialDatabase peut apparaître dans une demande. L'option ne peut pas apparaître dans une réponse. Plusieurs instances de l'option entraînent une erreur.

S'il existe une base de données par défaut configurée pour le point de terminaison qui a reçu la demande, une erreur est générée. Pour des raisons de sécurité, le client ne peut pas spécifier l'en-tête sqloptions:initialDatabase sur les points de terminaison disposant d'une base de données par défaut.

Si des sessions SOAP sont utilisées, cette option doit apparaître dans la même demande que l'attribut sqloptions:sqlsession initiate. Si cette option apparaît dans une demande avec un en-tête sqloptions:sqlSession qui ne contient pas lui aussi l'attribut initiate, une erreur est générée.

L'exemple suivant présente un fragment de schéma pour l'option sqloptions:initialDatabase :

<xs:element name="initialDatabase" form="qualified">
    <xs:annotation>
        <xs:documentation>
            Set initial database on login.
        </xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:attribute use="required" name="value" type="xs:string" form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    The name of the initial database to attach to.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute
          name="optional"
          default="false"
          type="xs:boolean"
          form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    Whether the initial database is optional or not.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="filename" type="xs:string" form="unqualified">
            <xs:annotation>
                <xs:documentation>
                    The filename of the database to attach.
                </xs:documentation>
            </xs:annotation>
        </xs:attribute>
    </xs:complexType>
</xs:element>