lucaong / cubdb / 69

99%

push

travis-ci

[breaking change] improve the select/3 API for key ranges (#5)

The previous API had a few shortcomings:

  - There were corner cases for `nil` min_key/max_key, or
  min_key/max_key literally being tuples like `{123, :included}`

  - It was not possible in these corner cases to detect error conditions

  - Mispelling `:included` or `:excluded` would silently fail or lead to
  unexpected results

  - The API was a bit cumbersome in general

The new API is much clearer and removes the shortcomings:

```elixir
# Exclusive ranges:
## Before:
{:ok, result} = CubDB.select(db,
  min_key: :foo,
  max_key: {:bar, :excluded}
)
## Now:
{:ok, result} = CubDB.select(db,
  min_key: :foo,
  max_key: :bar,
  max_key_inclusive: false
)

# Open-ended ranges:
## Before:
{:ok, result} = CubDB.select(db,
  min_key: :foo,
  max_key: nil
)
## Now:
{:ok, result} = CubDB.select(db,
  min_key: :foo
)

# Setting min/max key to `nil`:
## Before:
{:ok, result} = CubDB.select(db,
  min_key: {nil, :included},
  max_key: :bar
)
## Now:
{:ok, result} = CubDB.select(db,
  min_key: nil,
  max_key: :bar
)
```

14 of 14 new or added lines in 2 files covered. (100.0%)

475 of 478 relevant lines covered (99.37%)

8995.0 hits per line