ODataService 型プロバイダー (F#)

[アーティクル]
02/21/2013

型を Open Data Protocol (OData) サービスへのアクセスを提供します。OData は、インターネット上のデータのコピーのプロトコルです。多くのデータプロバイダーが、OData Web サービスを公開してデータへのアクセスを提供しています。OData は OData ソースの構造に、プロバイダーが、型を生成する型に基づいており、データ型の作成の通常のオーバーヘッドを付けずに OData のコードで、データソースのデータを、すぐに使用できるようにします。

Namespace/Module Path: Microsoft.FSharp.Data.TypeProviders

Assembly: FSharp.Data.TypeProviders (FSharp.Data.TypeProviders.dll)

type ODataService<ServiceUri : string,
                  ?LocalSchemaFile : string,
                  ?ForceUpdate : bool,
                  ?ResolutionFolder : string,
                  ?DataServiceCollection : bool>

静的な型パラメーター

型パラメーター	説明
ServiceUri: [文字列]	OData サービスの URI 文字列。
か。LocalSchemaFile: [文字列]	スキーマを含むファイルへのパス。このファイルは、型のプロバイダーによって記述されます。
か。ForceUpdate: [bool]	サービスへの直接接続をデザインおよびコンパイル時に使用でき、ローカルサービスファイルを更新する必要があります。既定値は true です。ForceUpdate が false の場合、プロバイダーは LocalSchemaFileの変更に合わせてします。
か。ResolutionFolder: [文字列]	コンパイル時に相対ファイルパスの解決に使用されるフォルダー。既定値は、プロジェクトまたはスクリプトを格納するフォルダーです。
か。DataServiceCollection: [bool]	DataServiceCollection<T>から派生したコレクションを生成します。既定値は false です。

解説

ODataService の型のプロバイダーを使用する方法についてチュートリアル : 型プロバイダーを使用した OData サービスへのアクセス (F#)を示すチュートリアルについて。

について Open Data Protocol (OData)

OData プロトコルは、インターネット上のデータソースへの読み取り/書き込みまたは読み取り専用アクセスを提供します。基になるデータは、2 とおりの形式の 1 つが、および XML ベースとして認識される、および JavaScript Object Notation (JSON) のシリアル化形式を使用する 1 1 になる場合があります。OData プロトコルを Microsoft によって定義され、ように Microsoft のオープン仕様の約束 (OSP) の下のが標準解放されます。

データがアクセスするに OData プロトコル OData Web サービスがどのように定義および実行されるかを理解する必要はありません。ただし、次の簡単な説明が発生しているが、概念上の理解に役立つことがあります。OData プロトコルは、クライアント要求が互いに依存しないことを意味する示す的な状態のコピー (SEO) の原則に従います; セッション状態またはデータは、クライアント要求間でサーバーに格納されます。代わりに、必要なすべての状態は各クライアント要求とともにクライアントからサーバーに転送されます。OData の場合、クライアント要求は作成、読み取り、更新、および削除 (CRUD 操作) が含まれます。クライアントから個別の要求は、から派生する、配置後、要求されていることがコンテンツが詳細を指定する、マージ、および削除含む HTTP メソッドです。サーバーは HTTP 経由でこれらの要求に応答します。

OData のデータはフィードからエントリのコレクションである構成されます。データベースの場合、フィードは、テーブルを表すか、エントリは、テーブル内の個別のレコードです。OData Web サービスは、使用できるフィード、サービスに関するすべての関連情報を説明するそのサービスで使用できる関数のメタデータについて説明しますサービス操作を示すサービスのドキュメントを含めることがあります。OData するサービスを使用できるようにメタデータのドキュメントでリソースはすべて説明します。

OData の型のプロバイダー

OData の型のプロバイダーは、データの構造体から決定される一連の型として F# の開発者に OData サービスを使用できるように発行されるデータを作成します。つまり、OData の型のプロバイダーを使用する場合は、型がそのサービスが提供するフィードのそれぞれに対して使用できるようになります。たとえば、OData のフィードは、一連のリレーショナルデータベースのテーブルである場合は、型のプロバイダーは、テーブルの型を使用できるようにします。そのテーブルの列は、型のプロパティです。各フィードのエントリは、型のインスタンスとして使用できます。

クエリの作成

OData サービスのクエリは、クエリ式ので作成することもできます。クエリ式では、多数の F# コードを使用してクエリの結果を構築できるようにするシーケンス式がシーケンスを指定できるようにする。SELECT キーワードは yield のキーワードと同じ役割を果たします。また、LINQ で他の .NET 言語、または SQL クエリ文字列の場合と同様に、クエリ演算子をクエリをカスタマイズするために使用されることがあります。

OData のクエリのクエリ演算子のサブセットのみ使用できます。これは、OData プロトコルをサポートするクエリの種類の制限があります。サポートされているクエリ演算子は、投影select ()、(orderBy、thenBy命令)、(where、文字列、日付までにフィルター処理されます) フィルター処理、およびページングをskip、take含まれている ()。これらのクエリ演算子などに関する詳細については、クエリ式 (F#)を参照してください。また、OData の特定の操作 AddQueryOption および [展開]を使用できます。

生成された型

次の表は、フォームのインスタンス化によって生成された型です:

type MyService = ODataService<parameters>

次の表では、ServiceTypeName は、サービスの型の名前を表し、* 名前空間のメンバーを表します。

型	説明
MyService	全体的なコンテナー型。データコンテキストの簡易ビューを返す GetDataContext のメソッドが含まれています。メソッドは MyService.ServiceTypes.SimpleDataContextTypes の新しいインスタンスを返します。1 つが指定されてServiceTypeName、ServiceUri の静的なパラメーターまたは引数の値で初期化します。
MyService.ServiceTypes	データベースの埋め込み完全な型および単純型が含まれています。
MyService.ServiceTypes.*	DataSvcUtil.exe によって生成される埋め込み型。
MyService.ServiceTypes.ServiceTypeName	DataContextから継承されたサービスコンテキストの型。
MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName	DataServiceQuery<TElement>を返す完全なコンテキストの型の各プロパティのプロパティを 1 つ含まれています。資格情報のプロパティが資格情報をランタイムに OData サービスを照会するために使用される取得または設定します。 DataContext のプロパティは型 DataContextの完全なデータコンテキストを取得します。これは、型のプロバイダーによって生成される ServiceTypeName の型の基本型です。

プラットフォーム

Windows 8、Windows 8、Windows 7、Windows Server 2012 で Windows Server 2008 R2

バージョン情報

F# コアライブラリのバージョン

サポート: ポータブル 2.0、4.0

参照

処理手順

チュートリアル : 型プロバイダーを使用した OData サービスへのアクセス (F#)

次の方法で共有