ODataService (Proveedor de tipo de F#)

Artículo
02/19/2013

Proporciona tipos para tener acceso a un servicio abierto de protocolo data protocol (OData).OData es un protocolo de transferencia de datos a través de internet.Muchos proveedores de datos exponen el acceso a sus datos mediante la publicación de un servicio Web de OData.El tipo de OData que el proveedor genera los tipos automáticamente basándose en la estructura del origen de OData, y por tanto permite utilizar datos de cualquier origen de datos de OData inmediatamente en el código, sin la sobrecarga habitual de crear tipos de datos.

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

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

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

Parámetros de tipo estático

Parámetro de tipo	Descripción
ServiceUri: cadena	La cadena URI para el servicio de OData.
¿? LocalSchemaFile: cadena	La ruta de acceso a un archivo que contiene el esquema.Este archivo es escrito por el proveedor de tipo.
¿? ForceUpdate: bool	Requiere que la conexión directa al servicio esté disponible en el diseño y el tiempo de compilación y el archivo de servicio local está actualizado.El valor predeterminado es true.Cuando ForceUpdate es false, el proveedor responde a los cambios en LocalSchemaFile.
¿? ResolutionFolder: cadena	Una carpeta que se utilizará para resolver rutas de acceso relativas en tiempo de compilación.El valor predeterminado es la carpeta que contiene el proyecto o el script.
¿? DataServiceCollection: bool	Representa las colecciones derivadas de DataServiceCollection<T>.El valor predeterminado es false.

Comentarios

Para un tutorial que las escrituras cómo utilizar el proveedor del tipo de ODataService, vea Tutorial: Obtener acceso a un servicio OData mediante proveedores de tipo (F#).

Sobre OData (protocolo abierto de datos)

El protocolo de OData proporciona readonly o acceso de lectura y escritura a un origen de datos a través de internet.Los datos subyacentes pueden estar en uno de dos formatos, uno que XML- se base y se conoce como Atom, y otro que utilice el formato de serialización de notación de objetos JavaScript (JSON).El protocolo de OData definido por Microsoft y liberado como estándar abierto en common Promise (OSP) de Abrir de Microsoft.

No necesita saber el protocolo de OData se define y se implementa para tener acceso a datos mediante un servicio web de OData.Sin embargo, la descripción breve siguiente puede ayudarle a entender conceptual qué significa.El protocolo de OData sigue los principios de transferencia de estado de Representational (REST), lo que significa que las solicitudes de cliente son independientes entre sí; no se almacena un estado o datos de sesión en el servidor entre las solicitudes de cliente.En su lugar, donde todo el estado necesaria de cliente al servidor junto con cada solicitud de cliente.En el caso de OData, la inclusión de las solicitudes de cliente crear, leer, actualizar, y elimina las operaciones (CRUD).Las solicitudes individuales de clientes son métodos HTTP, que incluyen GET, PUT, POST, INNER, y DELETE, el contenido cuyo especifica los detalles se solicita de qué.El servidor responde a las solicitudes sobre HTTP.

Los datos de OData consta de las fuentes que son colecciones de entradas.Para una base de datos, una fuente podría representar una tabla y las entradas serían los registros individuales de esa tabla.Un servicio web de OData también puede contener un documento de servicio que enumera las fuentes disponibles, las operaciones de servicio que son funciones disponibles en ese servicio, y un documento de metadatos que describa toda la información relevante sobre el servicio.Describen todos los recursos creados disponible por un servicio de OData en el documento de metadatos.

El proveedor de tipo de OData

El proveedor de tipo de OData coloca los datos publicados a un servicio de OData a disposición de un desarrollador de F# como un conjunto de tipos concretos de la estructura de los datos.Es decir, cuando se utiliza el OData escriba el proveedor, un tipo está disponible para cada una de las fuentes proporcionadas por ese servicio.Por ejemplo, si las fuentes de OData son un conjunto de tablas de una base de datos relacional, el proveedor de tipo hace un tipo disponibles para cada tabla.Las columnas de esa tabla son propiedades del tipo.Las entradas para cada fuente están disponibles como instancias del tipo.

Construir consultas

Las consultas en un servicio de OData se pueden crear mediante expresiones de consulta.Las expresiones de consulta permiten construya resultados de la consulta mediante el código de F#, mucho la manera en que las expresiones de secuencia permiten especificar secuencias.La palabra clave seleccione reproduce el mismo rol que la palabra clave yield.Además, los operadores de consulta se pueden utilizar para personalizar una consulta de la misma forma que en LINQ, en otro lenguaje.NET, o en una cadena de consulta SQL.

Puede utilizar sólo un subconjunto de los operadores de consulta en consultas de OData.Esto es debido a las limitaciones en los tipos de consultas que el protocolo de OData admite.Los operadores de consulta admitidos incluyen la proyección (select), ordenar (orderBy, thenBy), filtrando (where, filtrar por la cadena y la fecha), y paginar (skip, take).Para obtener más información sobre estos operadores y otros de consulta, vea Expresiones de consulta (F#).Además, puede utilizar las operaciones AddQueryOption específicas de OData y Expandir.

Tipos generados

La tabla siguiente se muestran los tipos generados por una instancia del formulario:

type MyService = ODataService<parameters>

En la tabla siguiente, ServiceTypeName representa el nombre del tipo de servicio, y * representa todos los miembros de un espacio de nombres.

Tipo	Descripción
MyService	El tipo de contenedor total. Contiene el método de GetDataContext, que devuelve una vista simplificada de contexto de datos.El método devuelve una nueva instancia de MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName, que se inicializa con el valor del parámetro estático de ServiceUri o de argumento, si se proporciona uno.
MyService.ServiceTypes	Contiene los tipos completos incrustados y los tipos simplificados de la base de datos.
MyService.ServiceTypes.*	Los tipos incrustados generados por DataSvcUtil.exe.
MyService.ServiceTypes.ServiceTypeName	El tipo de contexto del servicio, heredado de DataContext.
MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName	Contiene una propiedad para cada propiedad del tipo completo de contexto, que devuelve DataServiceQuery<TElement>. La propiedad credentials obtiene o establece las credenciales utilizadas para consultar el servicio de OData en el runtime. La propiedad DataContext obtiene el contexto completo de los datos, de DataContextescrito.Éste es el tipo base del tipo de ServiceTypeName generado por el proveedor de tipo.

Plataformas

Windows 8, Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Información de versiones

Versiones de la biblioteca básica de F#

Se admite en: 2.0, 4.0, portables

Vea también

Tareas

Tutorial: Obtener acceso a un servicio OData mediante proveedores de tipo (F#)

Referencia

Microsoft.FSharp.Collections (Espacio de nombres de F#)

Microsoft.FSharp.Data.TypeProviders (Espacio de nombres de F#)

Compartir a través de