ODataService, fournisseur de type (F#)
Fournit les types pour accéder à un service ouvert de protocole OData (open data). Est un protocole OData pour le transfert de données sur Internet. De nombreux fournisseurs de données exposent un accès à leurs données en publiant un service Web OData. Le type de fournisseur OData génère des types pour vous sur la structure de la source d'OData, et vous permet ainsi à des données d'utilisation de toute source de données d'OData immédiatement dans votre code, sans la charge mémoire habituelle de créer des types de données.
Namespace/Module Path: Microsoft.FSharp.Data.TypeProviders
Assembly: FSharp.Data.TypeProviders (dans FSharp.Data.TypeProviders.dll)
type ODataService<ServiceUri : string,
?LocalSchemaFile : string,
?ForceUpdate : bool,
?ResolutionFolder : string,
?DataServiceCollection : bool>
Paramètres statiques
Paramètre de type |
Description |
|---|---|
ServiceUri : chaîne |
La chaîne d'URI pour le service d'OData. |
? LocalSchemaFile : chaîne |
Le chemin d'accès à un fichier qui contient le schéma. Ce fichier est écrit par le type de fournisseur. |
? ForceUpdate : bool |
Requiert que la connexion directe au service est disponible au design ou au moment de la compilation et le fichier de service local est actualisé. La valeur par défaut est true. Lorsque ForceUpdate a la valeur false, le fournisseur réagit aux modifications dans LocalSchemaFile. |
? ResolutionFolder : chaîne |
Un dossier à utiliser pour résoudre les chemins d'accès relatifs au moment de la compilation. La valeur par défaut est le répertoire qui contient le projet ou le script. |
? DataServiceCollection : bool |
Génère des collections dérivées d' DataServiceCollection. La valeur par défaut est false. |
Notes
Pour une procédure pas - à - pas qui montre comment utiliser le type fournisseur d'ODataService, consultez Procédure pas à pas : accès à un service OData à l'aide des fournisseurs de type (F#).
À propos de OData (ouvrez le fournisseur de données)
Le protocole OData de fournit l'accès en lecture seule ou en lecture/écriture à une source de données sur Internet. Les données sous-jacentes peuvent être dans l'un des deux formats, un qui sont XML et appelé Atom, et un qui utilise le format de sérialisation de object notation JSON (JavaScript). Le protocole OData d'a été défini par Microsoft et libéré comme un standard ouvert dans la promesse ouverte (OSP) de spécification de Microsoft.
Vous n'avez pas besoin de savoir le protocole OData d'est défini et implémenté pour accéder aux données toutefois un service Web OData d'. Toutefois, une brève description qui suit peut vous aider à comprendre conceptuellement que vous passe-t-il. Le protocole OData de suit les principes de la migration figurative d'état REST (), ce qui signifie que les demandes du client sont indépendants de l'autre ; aucun état de session ou donnée n'est stocké sur le serveur entre les demandes du client. À la place, tout l'état requis est transféré du client au serveur avec chaque requête du client. Dans le cas de OData, les requêtes du client incluent les création, lecture, mise à jour, et opérations de suppression. Les requêtes individuelles les clients sont les méthodes de, qui incluent HTTP GET, METTENT, LE PUBLIENT, FUSIONNENT, et SUPPRIMENT, le contenu dont spécifiez les détails de ce qui est demandé. Le serveur répond à ces demandes sur HTTP.
Les données d'OData se composent des puissances qui sont des collections d'entrée. Pour une base de données, une puissance peut représenter une table et les entrées seraient les enregistrements individuels dans ce tableau. Un service Web à OData peut également contenir un document de service qui répertorie les puissances disponibles, les opérations de service qui sont des fonctions disponibles sur ce service, et un document de métadonnées qui décrivent toutes les informations pertinentes sur le service. Toutes les ressources rendues disponibles par un service d'OData sont décrites dans le document de métadonnées.
Le type de fournisseur OData
Le type de fournisseur OData effectue des données publiées à un service d'OData disponible à un développeur F# en tant qu'ensemble de types déterminés de la structure des données. Autrement dit, lorsque vous utilisez le type de fournisseur OData, un type est rendu disponible pour chacune des puissances fournies par ce service. Par exemple, si les puissances de OData sont un ensemble de tables d'une base de données relationnelle, le type de fournisseur rend un type disponibles pour chaque table. Les colonnes de cette table sont des propriétés du type. Les entrées pour chaque puissance sont disponibles comme instances du type.
Construire des requêtes
Les requêtes dans un service d'OData peuvent être créées à l'aide de expressions de requête. Les expressions de requête permettent aux résultats de la requête d'élément à l'aide de code F#, de la façon dont les expressions de séquence vous permettent de spécifier des séquences. Le mot clé sélectionnez lit le même rôle que le mot clé yield. En outre, les opérateurs de requête peuvent être utilisés pour personnaliser une requête de la même manière que vous le feriez dans LINQ, dans un autre langage.NET, ou dans une chaîne de requête SQL.
Vous pouvez utiliser uniquement un sous-ensemble des opérateurs de requête sur des requêtes d'OData. Cela est dû à des limitations dans les types de requêtes qui prend en charge des protocoles de OData. Les opérateurs de requête pris en charge incluent la projection (select), le classement (orderBy, thenBy), de filtrage (where, de filtrage à la chaîne et la date), et la pagination (skip, take). Pour plus d'informations sur ces opérateurs de requête et d'autres, consultez Expressions de requête (F#). En outre, vous pouvez utiliser les opérations AddQueryOption spécifiques d'OData et Développer.
Types générés
Le tableau suivant répertorie les types générés par une instanciation du formulaire :
type MyService = ODataService<parameters>
Dans le tableau suivant, ServiceTypeName représente le nom du type de service, et * représente tous les membres d'un espace de noms.
Type |
Description |
|---|---|
MyService |
Le type d'agrégat de conteneur. Contient la méthode de GetDataContext, qui retourne une vue simplifiée du contexte de données. La méthode retourne une nouvelle instance de MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName, qui est initialisé avec la valeur du paramètre statique d' ServiceUri ou de l'argument, si un est fourni. |
MyService.ServiceTypes |
Contient les types complets inline et les types simplifiés pour la base de données. |
MyService.ServiceTypes.* |
Les types incorporés générés par DataSvcUtil.exe. |
MyService.ServiceTypes.ServiceTypeName |
Le type de contexte de service, hérité d' DataContext. |
MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName |
Contient une propriété pour chaque propriété du type complet de contexte, qui retourne DataServiceQuery. La propriété des informations d'identification obtient ou définit les informations d'identification utilisées pour interroger le service d'OData au moment de l'exécution. La propriété du DataContext obtient le contexte complet de données, du type DataContext. Il s'agit du type de base du type de ServiceTypeName généré par le type de fournisseur. |
Plateformes
Windows 8, windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2
Informations de version
Versions de bibliothèque principale F#
Prise en charge dans : 2,0, 4,0, portables
Voir aussi
Tâches
Procédure pas à pas : accès à un service OData à l'aide des fournisseurs de type (F#)