AzureDocumentDbTypeProvider

This library allows easy access to DocumentDb databases and collections through an F# Type Provider.

Installation

The AzureDocumentDbTypeProvider library can be installed from NuGet:

PM> Install-Package AzureDocumentDbTypeprovider

Example

We initialise the type provider using the account Uri and account key for an Azure DocumentDb account as follows:

1: 
2: 
3: 
4:

#r "AzureDocumentDbTypeProvider.dll"
open FSharp.Azure.DocumentDbTypeProvider

type Tp = DocumentDbTypeProvider<"https://mydbaccount.documents.azure.com:443/","TheAccountKeyFromTheAzurePortal==">

We now have intellisense to explore the databases in our DocumentDb account like so

We can get a handle on the SDK db object with:

1:	`let catalogueDb = Tp.Databases.Catalogue.ReadDatabase`

and access our collections with:

1:	`let partsCollection = Tp.Databases.Catalogue.Collections.Parts`

The library comes with comprehensible documentation. It can include tutorials automatically generated from *.fsx files in the content folder. The API reference is automatically generated from Markdown comments in the library implementation.

API Reference contains automatically generated documentation for all types, modules and functions in the library. This includes additional brief samples on using most of the functions.

RoadMap

This project is currently still pre-release. Planned features will generally be added to the issues page.

Contributing and copyright

The project is hosted on GitHub where you can report issues, fork the project and submit pull requests. If you're adding a new public API, please also consider adding samples that can be turned into a documentation. You might also want to read the library design notes to understand how it works.

The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes. For more information see the License file in the GitHub repository.

Multiple items
namespace FSharp

--------------------
namespace Microsoft.FSharp

namespace FSharp.Azure

namespace FSharp.Azure.DocumentDbTypeProvider

type Tp = DocumentDbTypeProvider<...>

Full name: Index.Tp

type DocumentDbTypeProvider

Full name: FSharp.Azure.DocumentDbTypeProvider.DocumentDbTypeProvider

The entry type to connect to Azure DocumentDb

val catalogueDb : obj

Full name: Index.catalogueDb

property DocumentDbTypeProvider<...>.Databases: DocumentDbTypeProvider<...>.Domain.DatabaseListing

val partsCollection : obj

Full name: Index.partsCollection

namespace Microsoft.FSharp.Collections