OPENROWSET (Transact-SQL)

Article
05/19/2015

Inclut toutes les informations de connexion exigées pour accéder à des données distantes à partir d'une source de données OLE DB. Cette méthode est une autre façon d'accéder à des tables dans un serveur lié et constitue une méthode efficace pour vous connecter et accéder à des données distantes en utilisant OLE DB. Pour faire des références plus fréquentes à des sources de données OLE DB, utilisez plutôt des serveurs liés. Pour plus d'informations, consultez Serveurs liés (Moteur de base de données). La fonction OPENROWSET peut être référencée dans la clause FROM d'une requête comme s'il s'agissait du nom d'une table. La fonction OPENROWSET peut également être référencée comme table cible d'une instruction INSERT, UPDATE ou DELETE, en fonction des capacités du fournisseur OLE DB. Bien que la requête puisse retourner plusieurs jeux de résultats, OPENROWSET ne retourne que le premier.

OPENROWSET prend également en charge les opérations de chargement en masse par l'intermédiaire d'un fournisseur BULK intégré qui permet de lire les données d'un fichier et de les retourner comme un ensemble de lignes.

Icône Lien de rubrique Conventions de la syntaxe Transact-SQL

Syntaxe

OPENROWSET 
( { 'provider_name' , { 'datasource' ; 'user_id' ; 'password' 
   | 'provider_string' } 
   , {   [ catalog. ] [ schema. ] object 
       | 'query' 
     } 
   | BULK 'data_file' , 
       { FORMATFILE = 'format_file_path' [ <bulk_options> ]
       | SINGLE_BLOB | SINGLE_CLOB | SINGLE_NCLOB }
} ) 

<bulk_options> ::=
   [ , CODEPAGE = { 'ACP' | 'OEM' | 'RAW' | 'code_page' } ] 
   [ , ERRORFILE = 'file_name' ]
   [ , FIRSTROW = first_row ] 
   [ , LASTROW = last_row ] 
   [ , MAXERRORS = maximum_errors ] 
   [ , ROWS_PER_BATCH = rows_per_batch ]
   [ , ORDER ( { column [ ASC | DESC ] } [ ,...n ] ) [ UNIQUE ]

Arguments

'provider_name'
Chaîne de caractères représentant le nom convivial (ou PROGID) du fournisseur OLE DB tel que spécifié dans le Registre. provider_name n'a aucune valeur par défaut.
'datasource'
Constante de chaîne correspondant à une source de données OLE DB spécifique. datasource est la propriété DBPROP_INIT_DATASOURCE à transmettre à l'interface IDBProperties du fournisseur pour initialiser ce dernier. En général, cette chaîne comporte le nom du fichier de base de données, le nom d'un serveur de base de données ou un nom que comprend le fournisseur pour retrouver la ou les bases de données.
'user_id'
Constante de chaîne représentant le nom d'utilisateur passé au fournisseur OLE DB spécifié. user_id spécifie le contexte de sécurité de la connexion et est transmis en tant que propriété DBPROP_AUTH_USERID pour initialiser le fournisseur. user_id ne peut pas être un nom de connexion Microsoft Windows.
'password'
Constante de chaîne représentant le mot de passe utilisateur à transmettre au fournisseur OLE DB. password est transmis en tant que propriété DBPROP_AUTH_PASSWORD au moment de l'initialisation du fournisseur. password ne peut pas être un mot de passe Microsoft Windows.
'provider_string'
Chaîne de connexion spécifique au fournisseur qui est passée en tant que propriété DBPROP_INIT_PROVIDERSTRING pour initialiser le fournisseur OLE DB. En général, provider_string encapsule toutes les informations de connexion nécessaires à l'initialisation du fournisseur. Pour obtenir la liste des mots clés reconnus par le fournisseur SQL Server Native Client OLE DB, consultez Propriétés d'initialisation et d'autorisation.
catalog
Nom du catalogue ou de la base de données où réside l'objet spécifié.
schema
Nom du propriétaire du schéma ou de l'objet pour l'objet spécifié.
object
Nom d'objet qui identifie de façon unique l'objet à manipuler.
'query'
Constante de chaîne envoyée au fournisseur en vue de son exécution. L'instance locale SQL Server ne traite pas cette requête, mais traite les résultats de la requête retournés par le fournisseur (requête directe). Les requêtes directes sont utiles lorsque les fournisseurs mettent leurs données tabulaires à disposition non pas par l'intermédiaire de noms de tables, mais uniquement au moyen d'un langage de commande. Les requêtes directes sont prises en charge sur le serveur distant à condition que le fournisseur de requêtes prenne en charge l'objet OLE DB Command et ses interfaces obligatoires. Pour plus d'informations, consultez Guide de référence SQL Server Native Client (OLE DB).
BULK
Utilise le fournisseur d'ensembles de lignes BULK pour que OPENROWSET lise les données dans un fichier. Dans SQL Server, OPENROWSET peut lire un fichier de données sans charger les données dans une table cible. Cela permet d'utiliser OPENROWSET avec une instruction SELECT simple.

Les arguments de l'option BULK permettent un contrôle significatif sur le début et la fin de la lecture des données, sur le traitement des erreurs et sur l'interprétation des données. Vous pouvez par exemple spécifier que le fichier de données soit lu comme un ensemble d'une seule ligne et d'une seule colonne du type varbinary, varchar ou nvarchar. Le comportement par défaut est indiqué dans les descriptions des arguments ci-dessous.

Pour plus d'informations sur l'utilisation de l'option BULK, consultez la section « Remarques » plus loin dans cette rubrique. Pour plus d'informations sur les autorisations requises par l'option BULK, consultez la section « Autorisations » plus loin dans cette rubrique.

[!REMARQUE]

Lorsqu'elle est utilisée pour importer des données avec le mode de récupération complète, la fonction OPENROWSET (BULK ...) n'optimise pas la journalisation.

Pour plus d'informations sur la préparation des données pour l'importation en bloc, consultez Préparer des données en vue d'une exportation ou d'une importation en bloc (SQL Server).
'data_file'
Chemin d'accès complet au fichier dont les données doivent être copiées dans la table cible.
FORMATFILE ='format_file_path'
Spécifie le chemin d'accès complet au fichier de format. SQL Server prend en charge deux types de fichiers de format : XML et non XML.

Un fichier de format est requis pour définir les types des colonnes dans le jeu de résultats, excepté lorsque SINGLE_CLOB, SINGLE_BLOB ou SINGLE_NCLOB est spécifié ; dans ce cas, le fichier de format n'est pas requis.

Pour plus d'informations sur les fichiers de format, consultez Utiliser un fichier de format pour importer des données en bloc (SQL Server).
< bulk_options >
Spécifie un ou plusieurs arguments pour l'option BULK.

CODEPAGE = { 'ACP'| 'OEM'| 'RAW'| 'code_page' }
Indique la page de codes des données dans le fichier. L'utilisation de CODEPAGE n'est justifiée que si les données contiennent des colonnes du type char, varchar ou text dont les valeurs des caractères sont supérieures à 127 ou inférieures à 32.

[!REMARQUE]

Nous vous recommandons de spécifier un nom de classement pour chaque colonne dans un fichier de format.

Valeur CODEPAGE	Description
ACP	Convertit les colonnes dont les données sont de type char, varchar ou text de la page de codes ANSI/Microsoft Windows (ISO 1252) vers la page de codes de SQL Server.
OEM (valeur par défaut)	Convertit les colonnes dont les données sont du type char, varchar ou text de la page de codes du système OEM en page de codes SQL Server.
RAW	Aucune conversion n'a lieu d'une page de codes à une autre. Il s'agit de l'option la plus rapide.
code_page	Indique la page de codes source sur laquelle est basé l'encodage des données caractères du fichier de données, par exemple 850. Important SQL Server ne prend pas en charge la page de codes 65001 (encodage UTF-8).

ERRORFILE ='file_name'
Fichier utilisé pour collecter les lignes comportant des erreurs de mise en forme et impossibles à convertir en un ensemble de lignes OLE DB. Ces lignes sont copiées « en l'état » du fichier de données vers ce fichier d'erreur.

Le fichier d'erreur est créé au début de l'exécution de la commande. Une erreur est signalée si le fichier existe déjà. De plus, un fichier de contrôle portant l'extension .ERROR.txt est créé. Il fait référence à chacune des lignes du fichier d'erreur et propose un diagnostic. Lorsque les erreurs sont corrigées, les données peuvent être chargées.
FIRSTROW =first_row
Numéro de la première ligne à charger. La valeur par défaut est 1. Cela indique la première ligne du fichier de données spécifié. Les numéros des lignes sont déterminés en comptant les indicateurs de fin de ligne. FIRSTROW commence à 1.
LASTROW =last_row
Numéro de la dernière ligne à charger. La valeur par défaut est 0. Cela indique la dernière ligne du fichier de données spécifié.
MAXERRORS =maximum_errors
Spécifie le nombre maximal d'erreurs de syntaxe ou de lignes non conformes (défini dans le fichier de format) qui peuvent se produire avant que OPENROWSET lève une exception. Tant que la valeur de MAXERRORS n'est pas atteinte, OPENROWSET ignore les lignes incorrectes, ne les charge pas, et les compte comme des erreurs.

La valeur par défaut de maximum_errors est 10.

[!REMARQUE]

MAX_ERRORS ne s'applique pas aux contraintes CHECK ou à la conversion dans les types de données money et bigint.
ROWS_PER_BATCH =rows_per_batch
Spécifie le nombre approximatif de lignes de données que compte le fichier de données. Cette valeur doit être du même ordre que le nombre réel de lignes.

OPENROWSET importe toujours un fichier de données en un seul lot. Cependant, si vous spécifiez rows_per_batch avec la valeur >0, le processeur de requêtes se base sur la valeur de rows_per_batch pour allouer les ressources dans le plan de requête.

Par défaut, ROWS_PER_BATCH est inconnu. Si vous spécifiez ROWS_PER_BATCH = 0, le résultat est le même que si vous omettez ROWS_PER_BATCH.
ORDER ( { column [ ASC | DESC ] } [ ,... n ] [ UNIQUE ] )
Indicateur facultatif qui spécifie la manière dont sont triées les données dans le fichier de données. Par défaut, le processus de chargement en masse considère que le fichier de données n'est pas trié. Il est possible que les performances soient améliorées si l'optimiseur de requête peut exploiter l'ordre spécifié pour générer un plan de requête plus efficace. Voici quelques exemples de situations dans lesquelles il peut être intéressant de spécifier un tri :
- Insertion de lignes dans une table qui a un index cluster, où les données d'un ensemble de lignes sont triées sur la clé d'index cluster.
- Jointure de l'ensemble de lignes avec une autre table, où les colonnes de tri et de jointure correspondent.
- Agrégation des données de l'ensemble de lignes en fonction des colonnes de tri.
- Utilisation de l'ensemble de lignes en tant que table source dans la clause FROM d'une requête, où les colonnes de tri et de jointure correspondent.
UNIQUE spécifie que le fichier de données n'a pas d'entrées en double.

Si les lignes réelles du fichier de données ne sont pas triées d'après l'ordre spécifié ou si l'indicateur UNIQUE est spécifié et si des clés en double sont présentes, une erreur est retournée.

Les alias de colonnes sont requis lorsque ORDER est utilisé. La liste d'alias de colonnes doit référencer la table dérivée à laquelle accède la clause BULK. Les noms de colonnes qui sont spécifiés dans la clause ORDER font référence à cette liste d'alias de colonnes. Il n'est pas possible de spécifier des colonnes de type Large Value (varchar(max), nvarchar(max), varbinary(max) et xml), ou de types d'objets volumineux (LOB) (text, ntext et image).
SINGLE_BLOB
Retourne le contenu de data_file sous forme d'un ensemble d'une seule ligne et d'une seule colonne du type varbinary(max).

Important

Nous vous recommandons d'importer des données XML seulement au moyen de l'option SINGLE_BLOB, au lieu de SINGLE_CLOB et SINGLE_NCLOB, parce que seule l'option SINGLE_BLOB prend en charge toutes les conversions d'encodage de Windows.
SINGLE_CLOB
La lecture de data_file au format ASCII retourne le contenu sous la forme d'un ensemble d'une seule ligne et d'une seule colonne du type varchar(max) en utilisant le classement de la base de données active.
SINGLE_NCLOB
La lecture de data_file au format UNICODE retourne le contenu sous la forme d'un ensemble d'une seule ligne et d'une seule colonne du type nvarchar(max) en utilisant le classement de la base de données active.

Notes

OPENROWSET ne peut être utilisé pour accéder à des données distantes à partir de sources de données OLE DB que si l'option de Registre DisallowAdhocAccess est explicitement définie avec la valeur 0 pour le fournisseur spécifié et que l'option de configuration avancée Ad Hoc Distributed Queries est activée. Lorsque ces options ne sont pas définies, le comportement par défaut n'autorise pas l'accès d'égal à égal.

Lors de l'accès à des sources de données OLE DB distantes, l'identité des connexions approuvées n'est pas automatiquement déléguée du serveur auquel le client est connecté au serveur qui est interrogé. Il est nécessaire de configurer la délégation de l'authentification.

Les noms de catalogues et de schémas sont requis si le fournisseur OLE DB prend en charge plusieurs catalogues et schémas dans la source de données spécifiée. Les valeurs de catalog et schema peuvent être omises si le fournisseur OLE DB ne les prend pas en charge. Si le fournisseur prend en charge uniquement les noms de schémas, il est nécessaire de spécifier un nom en deux parties, sous la forme schema**.object doit être spécifié. Si le fournisseur prend en charge uniquement les noms de catalogues, il est nécessaire de spécifier un nom en trois parties, sous la forme catalog.schema.**object doit être spécifié. Il est nécessaire de spécifier des noms en trois parties pour les requêtes directes qui utilisent le fournisseur SQL Server Native Client OLE DB. Pour plus d'informations, consultez Conventions de la syntaxe Transact-SQL (Transact-SQL).

OPENROWSET n'accepte pas de variables pour ses arguments.

Tout appel à OPENDATASOURCE, OPENQUERY ou OPENROWSET dans la clause FROM est évalué séparément et indépendamment de tout appel à ces fonctions utilisé comme cible de la mise à jour, même si des arguments identiques sont fournis aux deux appels. En particulier, les conditions de filtre ou de jointure appliquées sur le résultat de l'un de ces appels n'ont aucun effet sur les résultats de l'autre.

Utilisation de OPENROWSET avec l'option BULK

Les améliorations Transact-SQL suivantes prennent en charge la fonction OPENROWSET(BULK…) :

Une clause FROM utilisée avec SELECT peut appeler OPENROWSET(BULK…) plutôt qu'un nom de table, tout en conservant la totalité des fonctionnalités de SELECT.

OPENROWSET utilisée avec l'option BULK nécessite un nom de corrélation, également baptisé variable de plage ou alias, dans la clause FROM. Vous pouvez définir des alias de colonnes. Si une liste d'alias de colonnes n'est pas spécifiée, le fichier de format doit comporter les noms des colonnes. La spécification des alias de colonnes remplace les noms de colonnes dans le fichier de format, par exemple :

FROM OPENROWSET(BULK...) AS table_alias

FROM OPENROWSET(BULK...) AS table_alias(column_alias,... n)
Une instruction SELECT…FROM OPENROWSET(BULK...) interroge directement les données d'un fichier, sans les importer dans une table. Les instructions SELECT…FROM OPENROWSET(BULK…) peuvent également énumérer les alias de colonnes en bloc en utilisant un fichier de format pour spécifier les noms de colonnes ainsi que les types de données.
Utiliser OPENROWSET(BULK...) en tant que table source dans une instruction INSERT ou MERGE importe en bloc les données du fichier de données dans une table SQL Server. Pour plus d'informations, consultez Importer des données en bloc à l'aide de BULK INSERT ou OPENROWSET(BULK...) (SQL Server).
Lorsque l'option OPENROWSET BULK est utilisée avec une instruction INSERT, la clause BULK prend en charge les indicateurs de table. En plus des indicateurs de table normaux, tels que TABLOCK, la clause BULK peut accepter les indicateurs de table spécialisés suivants : IGNORE_CONSTRAINTS (ignore uniquement les contraintes CHECK et FOREIGN KEY), IGNORE_TRIGGERS, KEEPDEFAULTS et KEEPIDENTITY. Pour plus d'informations, consultez Indicateurs de table (Transact-SQL).

Pour plus d'informations sur l'utilisation des instructions INSERT...SELECT * FROM OPENROWSET(BULK...), consultez Importation et exportation en bloc de données (SQL Server). Pour obtenir des informations sur les opérations d'insertion de lignes qui sont exécutées par importation en bloc et enregistrées dans le journal des transactions, consultez Conditions requises pour une journalisation minimale dans l'importation en bloc.

[!REMARQUE]

Lorsque vous utilisez OPENROWSET, il est important que vous compreniez la manière dont SQL Server gère l'emprunt d'identité. Pour plus d'informations sur les questions de sécurité, consultez Importer des données en bloc à l'aide de BULK INSERT ou OPENROWSET(BULK...) (SQL Server).

L'importation en bloc de données SQLCHAR, SQLNCHAR ou SQLBINARY

OPENROWSET(BULK...) suppose que, si elle n'est pas spécifiée, la longueur maximale des données SQLCHAR, SQLNCHAR ou SQLBINARY ne dépasse pas 8 000 octets. Si les données importées figurent dans un champ de données LOB qui contient des objets varchar(max), nvarchar(max) ou varbinary(max) qui dépasse 8 000 octets, vous devez utiliser un fichier de format XML qui définit la longueur maximale pour le champ de données. Pour spécifier la longueur maximale, modifiez le fichier de format et déclarez l'attribut MAX_LENGTH.

[!REMARQUE]

Un fichier de format généré automatiquement ne spécifie pas la longueur ou la longueur maximale d'un champ LOB. Toutefois, vous pouvez modifier un fichier de format et spécifier manuellement la longueur ou la longueur maximale.

Importation et exportation en bloc de documents SQLXML

Pour exporter ou importer en bloc des données SQLXML, utilisez l'un des types de données ci-dessous dans votre fichier de format.

Type de données	Effet
SQLCHAR ou SQLVARYCHAR	Les données sont envoyées dans la page de codes du client ou dans la page de codes impliquée par le classement.
SQLNCHAR ou SQLNVARCHAR	Les données sont envoyées au format Unicode.
SQLBINARY ou SQLVARYBIN	Les données sont envoyées sans conversion.

Autorisations

Les autorisations OPENROWSET sont conditionnées par les autorisations associées au nom d'utilisateur passé au fournisseur OLE DB. L'utilisation de l'option BULK requiert l'autorisation ADMINISTER BULK OPERATIONS.

Exemples

A.Utilisation de OPENROWSET avec SELECT et le fournisseur SQL Server Native Client OLE DB

L'exemple suivant utilise le fournisseur SQL Server Native Client OLE DB pour accéder à la table HumanResources.Department de la base de données AdventureWorks2012 sur le serveur distant Seattle1. (L'utilisation de SQLNCLI et SQL Server vous redirigera vers la version la plus récente du fournisseur SQL Server Native Client OLE DB.) Une instruction SELECT définit l'ensemble de lignes retourné. La chaîne de caractères du fournisseur contient les mots clés Server et Trusted_Connection. Ces mots clés sont reconnus par le fournisseur SQL Server Native Client OLE DB.

SELECT a.*
FROM OPENROWSET('SQLNCLI', 'Server=Seattle1;Trusted_Connection=yes;',
     'SELECT GroupName, Name, DepartmentID
      FROM AdventureWorks2012.HumanResources.Department
      ORDER BY GroupName, Name') AS a;

B.Utilisation du fournisseur Microsoft OLE DB pour Jet

L'exemple suivant accède à la table Customers de la base de données Microsoft Access Northwind via le fournisseur Microsoft OLE DB pour Jet.

[!REMARQUE]

L'exécution de ce code exemple suppose que Microsoft Access est installé. Pour exécuter cet exemple, vous devez installer la base de données Northwind.

SELECT CustomerID, CompanyName
   FROM OPENROWSET('Microsoft.Jet.OLEDB.4.0',
      'C:\Program Files\Microsoft Office\OFFICE11\SAMPLES\Northwind.mdb';
      'admin';'',Customers);
GO

C.Utilisation de OPENROWSET avec une autre table dans une jointure interne INNER JOIN

Le code exemple suivant sélectionne toutes les données de la table Customers dans la base de données Northwind installée sur l'instance locale de SQL Server et dans la table Orders de la base de données Northwind Access stockée sur le même ordinateur.

[!REMARQUE]

L'exécution de ce code exemple suppose que Microsoft Access est installé. Pour exécuter cet exemple, vous devez installer la base de données Northwind.

USE Northwind  ;
GO
SELECT c.*, o.*
FROM Northwind.dbo.Customers AS c 
   INNER JOIN OPENROWSET('Microsoft.Jet.OLEDB.4.0', 
   'C:\Program Files\Microsoft Office\OFFICE11\SAMPLES\Northwind.mdb';'admin';'', Orders)    
   AS o 
   ON c.CustomerID = o.CustomerID ;
GO

D.Utilisation de OPENROWSET pour insérer en bloc un fichier de données dans une colonne de type varbinary(max)

Le code exemple suivant crée une petite table aux fins de démonstration et insère dans une colonne varbinary(max) les données du fichier Text1.txt situé dans le répertoire racine C:.

USE AdventureWorks2012;
GO
CREATE TABLE myTable(FileName nvarchar(60), 
  FileType nvarchar(60), Document varbinary(max));
GO

INSERT INTO myTable(FileName, FileType, Document) 
   SELECT 'Text1.txt' AS FileName, 
      '.txt' AS FileType, 
      * FROM OPENROWSET(BULK N'C:\Text1.txt', SINGLE_BLOB) AS Document;
GO

E.Utilisation du fournisseur OPENROWSET BULK avec un fichier de format pour récupérer des lignes dans un fichier texte

Le code exemple suivant utilise un fichier de format pour extraire des lignes d'un fichier texte dont les données sont délimitées par des tabulations, values.txt, qui contient les données suivantes :

1     Data Item 1
2     Data Item 2
3     Data Item 3

Le fichier de format, values.fmt, décrit les colonnes du fichier values.txt :

9.0
2
1  SQLCHAR  0  10 "\t"        1  ID                SQL_Latin1_General_Cp437_BIN
2  SQLCHAR  0  40 "\r\n"      2  Description        SQL_Latin1_General_Cp437_BIN

Voici la requête qui récupère ces données :

SELECT a.* FROM OPENROWSET( BULK 'c:\test\values.txt', 
   FORMATFILE = 'c:\test\values.fmt') AS a;

Autres exemples

Pour obtenir plus d'exemples qui illustrent l'utilisation des instructions INSERT...SELECT * FROM OPENROWSET(BULK...), consultez les rubriques suivantes :