Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tforkmann/Fumble
Thin F# API for Sqlite for easy data access to sqlite database with functional seasoning on top
https://github.com/tforkmann/Fumble
Last synced: 4 months ago
JSON representation
Thin F# API for Sqlite for easy data access to sqlite database with functional seasoning on top
- Host: GitHub
- URL: https://github.com/tforkmann/Fumble
- Owner: tforkmann
- License: mit
- Created: 2020-06-09T07:45:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T16:49:30.000Z (6 months ago)
- Last Synced: 2024-02-26T04:57:53.242Z (4 months ago)
- Language: CSS
- Homepage: https://tforkmann.github.io/Fumble/
- Size: 5.52 MB
- Stars: 92
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-fsharp - Fumble ★ 30 ⧗ 0 - Thin F# API for Sqlite for easy data access to sqlite database with functional seasoning on top [MIT] (General purpose libraries / Performance analysis)
README
# Fumble
Functional wrapper around plain old `Sqlite` to simplify data access when talking to SQLite databases.
## Available Packages:
| Library | Version |
| ------------- | ------------- |
| Fumble | [](hhttps://www.nuget.org/packages/Fumble/) |
## Install
```bash
# nuget client
dotnet add package Fumble
# or using paket
.paket/paket.exe add Fumble --project path/to/project.fsproj
```
## Query a table
```fs
open Fumble
// get the connection from the environment
let connectionString() = Env.getVar "app_db"
type User = { Id: int; Username: string }
let getUsers() : Result =
connectionString()
|> Sql.connect
|> Sql.query "SELECT * FROM dbo.[Users]"
|> Sql.execute (fun read ->
{
Id = read.int "user_id"
Username = read.string "username"
})
```
## Handle null values from table columns:
```fs
open Fumble
// get the connection from the environment
let connectionString() = Env.getVar "app_db"
type User = { Id: int; Username: string; LastModified : Option }
let getUsers() : Result =
connectionString()
|> Sql.connect
|> Sql.query "SELECT * FROM dbo.[users]"
|> Sql.execute(fun read ->
{
Id = read.int "user_id"
Username = read.string "username"
// Notice here using `orNone` reader variants
LastModified = read.dateTimeOrNone "last_modified"
})
```
## Providing default values for null columns:
```fs
open Fumble
// get the connection from the environment
let connectionString() = Env.getVar "app_db"
type User = { Id: int; Username: string; Biography : string }
let getUsers() : Result =
connectionString()
|> Sql.connect
|> Sql.query "select * from dbo.[users]"
|> Sql.execute (fun read ->
{
Id = read.int "user_id";
Username = read.string "username"
Biography = defaultArg (read.stringOrNone "bio") ""
})
```
## Execute a parameterized query
```fs
open Fumble
// get the connection from the environment
let connectionString() = Env.getVar "app_db"
// get product names by category
let productsByCategory (category: string) : Result =
connectionString()
|> Sql.connect
|> Sql.query "SELECT name FROM dbo.[Products] where category = @category"
|> Sql.parameters [ "@category", Sql.string category ]
|> Sql.execute (fun read -> read.string "name")
```
### Executing a stored procedure with parameters
```fs
open Fumble
// get the connection from the environment
let connectionString() = Env.getVar "app_db"
// check whether a user exists or not
let userExists (username: string) : Async> =
async {
return!
connectionString()
|> Sql.connect
|> Sql.storedProcedure "user_exists"
|> Sql.parameters [ "@username", Sql.string username ]
|> Sql.execute (fun read -> read.bool 0)
|> function
| Ok [ result ] -> Ok result
| Error error -> Error error
| unexpected -> failwithf "Expected result %A" unexpected
}
```
### Executing a stored procedure with table-valued parameters
```fs
open Fumble
open System.Data
// get the connection from the environment
let connectionString() = Env.getVar "app_db"
let executeMyStoredProcedure () : Async =
// create a table-valued parameter
let customSqlTypeName = "MyCustomSqlTypeName"
let dataTable = new DataTable()
dataTable.Columns.Add "FirstName" |> ignore
dataTable.Columns.Add "LastName" |> ignore
// add rows to the table parameter
dataTable.Rows.Add("John", "Doe") |> ignore
dataTable.Rows.Add("Jane", "Doe") |> ignore
dataTable.Rows.Add("Fred", "Doe") |> ignore
connectionString()
|> Sql.connect
|> Sql.storedProcedure "my_stored_proc"
|> Sql.parameters
[ "@foo", Sql.int 1
"@people", Sql.table (customSqlTypeName, dataTable) ]
|> Sql.executeNonQueryAsync
```
## Running Tests locally
You only need a working local Sqlite. The tests will create databases when required and dispose of them at the end of the each test