Compartilhar via


Provedor de tipo ODataService (F#)

Fornece tipos para acessar um serviço de abertura do protocolo de dados (OData). OData é um protocolo para a transferência de dados através da Internet. Acesso a exposição de vários provedores de dados em seus dados publicando um serviço da Web OData. O OData o provedor de tipo para tipos que gera você com base na estrutura de OData, e permite assim que você use dados da fonte de dados de OData imediatamente em seu código, sem a sobrecarga comum de criar tipos de dados.

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

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

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

Parâmetros de tipo estáticos

Parâmetro de tipo

Descrição

ServiceUri: cadeia de caracteres

A cadeia de caracteres URI para o serviço de OData.

? LocalSchemaFile: cadeia de caracteres

O caminho para um arquivo que contém o esquema. Este arquivo é gravado pelo provedor do tipo.

? ForceUpdate: bool

Requer que a conexão direta para o serviço está disponível no projeto/tempo de compilação e o arquivo de serviço local é atualizado. O valor padrão é válido. Quando ForceUpdate é falso, o provedor reage a alterações em LocalSchemaFile.

? ResolutionFolder: cadeia de caracteres

Uma pasta a ser usada para resolver em tempo de compilação caminhos de arquivos relacionados. O valor padrão é a pasta que contém o projeto ou o script.

? DataServiceCollection: bool

Gera as coleções derivadas de DataServiceCollection. o valor padrão é falso.

Comentários

Para uma explicação passo a passo que mostra como usar o provedor do tipo de ODataService, considere Instruções passo a passo: acessando um serviço OData por meio de provedores de tipos (F#).

Sobre OData (protocolo aberto de dados)

O protocolo de OData fornece acesso somente leitura ou leitura-gravação a uma fonte de dados pela Internet. Os dados subjacentes podem estar em um dos formatos, em um com que é baseado e conhecido como o átomo, e em um usando o formato de serialização de Javascript object notation (JSON). O protocolo de OData foi definido pela Microsoft e solto como um standard aberto na promessa aberta (OSP) da especificação da Microsoft.

Você não precisa saber o protocolo de OData é definido e implementado através de dados para acessar um serviço da Web OData. Em o entanto, a seguinte breve descrição pode ajudar a entender conceitual o que está acontecendo. O protocolo de OData segue as noções básicas de transferência representacional de estado (RESTO), o que significa que as solicitações de cliente são independentes de se; nenhum estado de sessão ou dados são armazenados no servidor entre solicitações de cliente. Em vez de isso, qualquer estado necessário é transferido de cliente para o servidor junto com cada solicitação de cliente. Em o caso de OData, as solicitações de cliente incluem criam, lê, atualizações e exclusões, operações CRUD (). As solicitações individuais de clientes são métodos HTTP, incluindo GET PUT, MESCLAGEM POST, e DELETE, o conteúdo de especificar os detalhes do que está sendo solicitado. O servidor responde 2 sobre as solicitações HTTP.

Os dados de OData consistem de opção que são coleções de entradas. Para um banco de dados, um avanço pode representar uma tabela e as entradas seriam os registros individuais na tabela. Um serviço da Web OData também pode conter um documento de serviço que lista os feeds disponíveis, operações de serviço que são funções disponíveis em esse serviço, e os metadados documentam que descreve todas as informações relevantes sobre o serviço. Todos os recursos disponíveis por um serviço de OData são descritos no documento de metadados.

O provedor do tipo de OData

O provedor do tipo de OData torna os dados publicados em um serviço de OData disponível para um desenvolvedor de F# como um conjunto de certos tipos de estrutura de dados. Isto é, quando você usa o provedor do tipo de OData, um tipo é disponibilizado para cada um dos feeds fornecidos pelo serviço. Por exemplo, se a opção de OData são um conjunto de tabelas de um banco de dados relacional, o provedor do tipo torna um tipo disponível para cada tabela. As colunas da tabela são propriedades do tipo. As entradas para cada RSS estão disponíveis como instâncias do tipo.

Construindo consultas

Consultas em um serviço de OData podem ser criadas usando expressões de consulta. Expressões de consulta permitem que você construa resultados de consulta usando código de F#, de uma maneira expressões de seqüência que permitem que você especifique seqüências. A palavra-chave selecione executa a mesma função que a palavra-chave de produzir. Além de isso, os operadores de consulta podem ser usados para personalizar a mesma forma como você faria em uma consulta LINQ, em outra linguagem .NET, ou em uma cadeia de caracteres de consulta SQL.

Você pode usar somente um subconjunto dos operadores de consulta em consultas de OData. Isso é devido às restrições nos tipos de consultas que o protocolo de OData suporta. Os operadores de consulta suportados incluem a projeçãoselect(), classificação (orderBy, thenBy), filtrar (where, filtragem na cadeia de caracteres e a data), e paginando (skip, take). Para obter mais informações sobre esses e outros operadores de consulta, consulte Expressões de consulta (F#). Além de isso, você pode usar as AddQueryOption operações específicas de OData e Expandir.

Tipos gerados

A tabela seguinte mostra tipos gerados por uma instanciação do formulário:

type MyService = ODataService<parameters>

Em a tabela a seguir, ServiceTypeName representa o nome do tipo de serviço, e * representa todos os membros de um namespace.

Tipo

Descrição

MyService

Total do tipo recipiente.

Contém o método de GetDataContext, que retorna uma versão simplificada de contexto de dados. O método retorna uma nova instância de MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName, que é inicializado com o valor do parâmetro estático de ServiceUri ou do argumento, se um for fornecido.

MyService.ServiceTypes

Contém os tipos completos inseridos e tipos simplificados para o banco de dados.

MyService.ServiceTypes.*

Os tipos inseridos gerados por DataSvcUtil.exe.

MyService.ServiceTypes.ServiceTypeName

O tipo de contexto de serviço, herdado de DataContext.

MyService.ServiceTypes.SimpleDataContextTypes.ServiceTypeName

Contém uma propriedade para cada propriedade do tipo completo de contexto, que retorna DataServiceQuery.

A propriedade de credenciais obtém ou define as credenciais usadas para ver o serviço de OData em tempo de execução.

A propriedade obtém o DataContext contexto completo de dados, do tipo DataContext. Este é o tipo base do tipo de ServiceTypeName gerado pelo provedor do tipo.

Plataformas

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

Informações de Versão

Versões da biblioteca principal de F#

Suportado em: 2,0, 4,0, portáteis

Consulte também

Tarefas

Instruções passo a passo: acessando um serviço OData por meio de provedores de tipos (F#)

Referência

Namespace Microsoft.FSharp.Collections (F#)

Namespace Microsoft.FSharp.Data.TypeProviders (F#)