Version 4 #6

2024-08-17T18:44:18Z

danieljsummers commented

2024-08-17 18:44:18 +00:00

Changes in this version:

BREAKING CHANGE: All *byField/*ByField functions are now *byFields/*ByFields, and take a FieldMatch case before the list of fields. The Compat namespace in both libraries will assist in this transition. In support of this change, the Field parameter name is optional; the library will generate parameter names for it if they are not specified.
BREAKING CHANGE: The Query namespaces have had some significant work, particularly from the full-query perspective. Most have been broken up into the base query and modifiers by* that will combine the base query with the WHERE clause needed to satisfy the criteria.
FEATURE / BREAKING CHANGE: PostgreSQL document fields will now be cast to numeric if the parameter value passed to the query is numeric. This drove the Query breaking changes, as the fields need to have their intended value for the library to generate the appropriate SQL. Additionally, if code assumes the library can be given something like 8 and transform it to "8", this is no longer the case.
FEATURE: All Find queries (except byId/ById) now have a version with the Ordered suffix. These take a list of fields by which the query should be ordered. A new Field method called Named can assist with creating these fields. Prefixing the field name with n: will cast the field to numeric in PostgreSQL (and will be ignored by SQLite); adding " DESC" to the field name will sort it descending (Z-A, high to low) instead of ascending (A-Z, low to high).
FEATURE: The library can now generate IDs for documents. It can generate a "max-plus-1" for numeric IDs, GUID strings, or random hexadecimal strings of a configurable length.
BREAKING CHANGE (PostgreSQL only): fieldNameParam/Parameters.FieldName are now plural. The function still only generates one parameter, but the name is now the same between PostgreSQL and SQLite. The goal of this library is to abstract the differences away as much as practical, and this furthers that end. There are functions with these names in the Compat namespace.
FEATURE: In the F# v3 library, lists of parameters were expected to be F#'s List type, and the C# version took either List<T> or IEnumerable<T>. In this version, these all expect seq/IEnumerable<T>. F#'s List satisfies the seq constraints, so this should not be a breaking change.
FEATURE: Fields now may have qualifiers; this allows tables to be aliased when joining multiple tables (as all have the same data column). F# users can use with to specify this at creation, and both F# and C# can use the WithQualifier method to create a field with the qualifier specified. Parameter names for fields may be specified in a similar way, substituting ParameterName for Qualifier.

Changes in this version: - **BREAKING CHANGE**: All `*byField`/`*ByField` functions are now `*byFields`/`*ByFields`, and take a `FieldMatch` case before the list of fields. The `Compat` namespace in both libraries will assist in this transition. In support of this change, the `Field` parameter name is optional; the library will generate parameter names for it if they are not specified. - **BREAKING CHANGE**: The `Query` namespaces have had some significant work, particularly from the full-query perspective. Most have been broken up into the base query and modifiers `by*` that will combine the base query with the `WHERE` clause needed to satisfy the criteria. - **FEATURE / BREAKING CHANGE**: PostgreSQL document fields will now be cast to numeric if the parameter value passed to the query is numeric. This drove the `Query` breaking changes, as the fields need to have their intended value for the library to generate the appropriate SQL. Additionally, if code assumes the library can be given something like `8` and transform it to `"8"`, this is no longer the case. - **FEATURE**: All `Find` queries (except `byId`/`ById`) now have a version with the `Ordered` suffix. These take a list of fields by which the query should be ordered. A new `Field` method called `Named` can assist with creating these fields. Prefixing the field name with `n:` will cast the field to numeric in PostgreSQL (and will be ignored by SQLite); adding " DESC" to the field name will sort it descending (Z-A, high to low) instead of ascending (A-Z, low to high). - **FEATURE**: The library can now generate IDs for documents. It can generate a "max-plus-1" for numeric IDs, GUID strings, or random hexadecimal strings of a configurable length. - **BREAKING CHANGE** (PostgreSQL only): `fieldNameParam`/`Parameters.FieldName` are now plural. The function still only generates one parameter, but the name is now the same between PostgreSQL and SQLite. The goal of this library is to abstract the differences away as much as practical, and this furthers that end. There are functions with these names in the `Compat` namespace. - **FEATURE**: In the F# v3 library, lists of parameters were expected to be F#'s `List` type, and the C# version took either `List<T>` or `IEnumerable<T>`. In this version, these all expect `seq`/`IEnumerable<T>`. F#'s `List` satisfies the `seq` constraints, so this should not be a breaking change. - **FEATURE**: `Field`s now may have qualifiers; this allows tables to be aliased when joining multiple tables (as all have the same `data` column). F# users can use `with` to specify this at creation, and both F# and C# can use the `WithQualifier` method to create a field with the qualifier specified. Parameter names for fields may be specified in a similar way, substituting `ParameterName` for `Qualifier`.

danieljsummers added 26 commits 2024-08-17 18:44:19 +00:00

WIP on field enhancements 433302d995

WIP on PG Query.whereByFIelds e96c449324

Add whereByFields code / tests e2232e91bb

- Add wrapper class for unnamed field parameters
- Support table qualifiers by field
- Support dot access to document fields/sub-fields

Remove internal calls to deprecated funcs d131eda56e

Add byFields to PostgreSQL impl 8a15bdce2e

- Swap howMatched and fields throughout
- Existing tests pass; still need new ones for byFields

Prefer seq over list for parameters 202fca272e

- This greatly reduces the duplicated functions needed
between F# and C#; F# lists satisfy the sequence reqs

Add byFields to SQLite implementation d8f64417e5

- Add fieldNameParams/FieldNames to Postgres
(syncs names between both implementations)

Add Postgres Query byFields tests 85750e19f2

WIP on supporting numeric fields b1c3991e11

WIP on pulling code up to Common 35755df99a

Pull count, exists, update to common 98bc83ac17

Complete common migration, WIP on tests 74e5b77edb

WIP on Postgres type derivation e0fb793ec9

Add tests for PG parameter types d9d37f110d

- Alter whereById to expect a parameter

Ignore IDE settings 77a6aaa583

Add ToString for FieldMatch; add tests 0c308c5f33

Merge branch 'wip-1' of https://git.bitbadger.solutions/bit-badger/BitBadger.Documents into wip-1 d382699a17

Remove byField functions 96f5e1515d

First cut of field order by function edd4d006da

Add *Ordered functions bac3bd2ef0

- WIP on PostgreSQL numeric ordering

Fix numeric field rendering in order by e07844570a

WIP on ordered tests, test reorg 8e33299e22

Finish ordered tests for PostgreSQL fba8ec7bc5

- Rename tests, remove tested obsolete byField funcs

Reorg SQLite tests d993f71788

Add ordered* tests for SQLite e2948ea6a1

- Ignore "n:" prefix for SQLite fields
- Remove byFIeld functions

Add compat namespace functions 88f11a854f

- Update package release notes

danieljsummers self-assigned this 2024-08-17 18:44:28 +00:00

danieljsummers added 1 commit 2024-08-18 21:23:16 +00:00

Add AutoId DU / tests b357b5a01f

danieljsummers added 1 commit 2024-08-19 01:58:03 +00:00

Implement auto IDs for both dbs f41fa1245a

- Move SQLite WithConn doc into Document module

danieljsummers added 1 commit 2024-08-19 23:17:59 +00:00

Add rc1 to version dc60c25ac6

danieljsummers added 1 commit 2024-08-19 23:23:28 +00:00

Remove old packages before building new 3ef7b25426

danieljsummers merged commit 2c24e2e912 into main

2024-08-19 23:30:39 +00:00

danieljsummers deleted branch version-four

2024-08-19 23:30:39 +00:00

danieljsummers referenced this issue from a commit

2024-08-19 23:30:40 +00:00

Version 4 rc1 (#6)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: bit-badger/BitBadger.Documents#6