Update README with NuGet info
This commit is contained in:
parent
2e749e1a27
commit
7f98891ebd
24
README.md
24
README.md
@ -8,8 +8,7 @@ license on this project's dependencies. Please see [the heading on the C# driver
|
||||
|
||||
## Using
|
||||
|
||||
It is still early days on this project; however, AppVeyor CI provides a [NuGet feed][nuget] that builds packages for
|
||||
each commit.
|
||||
Install the [NuGet](https://www.nuget.org/packages/RethinkDb.Driver.FSharp/) package `RethinkDb.Driver.FSharp`. You will need to specify pre-release, as the package has an alpha designation at this time.
|
||||
|
||||
## Goals
|
||||
|
||||
@ -26,7 +25,7 @@ let fetchPost (postId : string) =
|
||||
|> withRetryDefault
|
||||
```
|
||||
|
||||
- An F# domain-specific language (DSL) using a `rethink` computation expression:
|
||||
- An F# domain-specific language (DSL) using a `rethink` computation expression (CE):
|
||||
|
||||
```fsharp
|
||||
/// string -> (IConnection -> Task<Post>)
|
||||
@ -44,16 +43,29 @@ let fetchPost (postId : string) =
|
||||
```fsharp
|
||||
/// type: DataConfig
|
||||
let config = DataConfig.fromJsonFile "data-config.json"
|
||||
// OR
|
||||
let config = DataConfig.fromConfiguration (config.GetSection "RethinkDB")
|
||||
|
||||
/// type: IConnection
|
||||
let conn = config.Connect ()
|
||||
|
||||
/// type: Post (utilizing either example above)
|
||||
let post = fetchPost "the-post-id" conn |> Async.RunSynchronously
|
||||
// (within a task CE)
|
||||
let! post = fetchPost "the-post-id" conn
|
||||
```
|
||||
|
||||
- Robust queries
|
||||
|
||||
The RethinkDB connection is generally stored as a singleton. Over time, this connection can lose its connection to the server. Both the CE and functions have `withRetryDefault`, which will retry a failed command up to 3 times (4 counting the initial try), waiting 200ms, 500ms, and 1 second between the respective attempts. There are other options as well; `withRetryOnce` will retry one time immediately. `withRetry` takes a list of `float`s, which will be interpreted as seconds to delay between each retry; it will retry until it has exhausted the delays.
|
||||
|
||||
The examples above both use the default retry logic.
|
||||
|
||||
- Only rename functions/methods where required
|
||||
|
||||
Within the CE, there are a few differing names, mostly notably at the start (selecting databases and tables); this is to allow for a more natural language flow. Its names may change in the 0.8.x series; it is the most alpha part of the project at this point.
|
||||
|
||||
The functions do have to change a bit, since they do not support overloading; an example for `filter` is below.
|
||||
|
||||
```fsharp
|
||||
// Function names cannot be polymorphic the way object-oriented methods can, so filter's three overloads become
|
||||
filter (r.HashMap ("age", 30))
|
||||
@ -62,9 +74,9 @@ filterFunc (fun row -> row.["age"].Eq(30))
|
||||
// and
|
||||
filterJS "function (row) { return 30 == row['age'] }"
|
||||
```
|
||||
---
|
||||
|
||||
The composable pipeline and the JSON configuration are the early goals, as the computation expression will utilize the
|
||||
same composition as those functions.
|
||||
If you are using the project, feel free to file issues about your pain points; there is no substitute for real-world feedback!
|
||||
|
||||
[license]: https://github.com/bchavez/RethinkDb.Driver#open-source-and-commercial-licensing
|
||||
[nuget]: https://ci.appveyor.com/nuget/danieljsummers-rethinkdb-driver-fsharp
|
Loading…
Reference in New Issue
Block a user