Sondor.Queries 1.0.2

Sondor Queries

The Sondor Queries package provides various types that come with many extensions, helpers and integrations for a simple and smooth experience with implementing complex queried logic.

Contents

1. Getting started
2. Supported languages
3. Error codes
4. Testing
5. Query Attributes
6. Query Types

Getting started

To get started with the Sondor.Queries package, follow these steps:

1. First, install the Sondor.Queries NuGet package.
2. Next, register using builder.Services.AddSondorQueries().
3. Finally, you'll have access to the various Query Types.

Support languages

Error codes

Testing

Testing is important in software as it ensures quality and minimises the risk of bugs reaching production. To simplify the developer experience when working with Sondor.Queries we've created the SondorQueriesAssert class which provides helpers to simplify the process of testing logic using the Sondor.Queries package.

AssertSort

The AssertSort helps test the Sort type. We provide a helper function, enabling one line to assert that the received Sort matches the expected Sort.

SondorQueriesAssert.AssertSort(sort, expected);

AssertSorts

The AssertSorts helps test a collection of Sort errors. To ensure consistency when comparing the two arrays of Sort's provided. The assert defaults to normalizing the order by ordering the sorts by Property and then by Ascending. This can be overridden by explicitly providing false to normalizeOrder when using.

SondorQueriesAssert.AssertSorts(sorts, expected, normalizeOrder);

AssertSortQuery

The AssertSortQuery helps test the SortQuery type. We provide a helper function, enabling one line to assert that the received SortQuery matches the expected SortQuery.

SondorQueriesAssert.AssertSortQuery(sortQuery, expected);

AssertField

The AssertField helps test the FieldsQuery type. We provide a helper function, enabling one line to assert that the received FieldsQuery matches the expected FieldsQuery.

SondorQueriesAssert.AssertField(fieldsQuery, expected);

AssertSearch

The AssertSearch helps test the SearchQuery type. We provide a helper function, enabling one line to assert that the received SearchQuery matches the expected SearchQuery.

SondorQueriesAssert.AssertSearch(searchQuery, expected);

AssertFilter

The AssertFilter helps test the Filter type. We provide a helper function, enabling one line to assert that the received Filter matches the expected Filter.

SondorQueriesAssert.AssertFilter(filter, expected);

AssertPatch

The AssertPatch helps test the Patch type. We provide a helper function, enabling one line to assert that the received Patch matches the expected Patch.

SondorQueriesAssert.AssertPatch(patch, expected);

AssertPatch

The AssertPatch helps test the Patch type. We provide a helper function, enabling one line to assert that the received Patch matches the expected Patch.

SondorQueriesAssert.AssertPatch(patch, expected);

AssertPatches

The AssertPatches helps test a collection of Patch errors. Ensure consistency when comparing the two arrays of Patch provided. The assert defaults to normalizing the order by ordering the sorts by Property and then by Value. This can be overridden by explicitly providing false to normalizeOrder when using.

SondorQueriesAssert.AssertPatches(patches, expected, normalizeOrder);

AssertPatchQuery

The AssertPatchQuery helps test the PatchQuery type. We provide a helper function, enabling one line to assert that the received PatchQuery matches the expected PatchQuery.

SondorQueriesAssert.AssertPatchQuery(patchQuery, expected);

Query Types

Throughout Sondor software, we provide a range of complex querying functionality. To improve the developer experience, we created the Sondor.Queries package which provides various custom types, extensions, and more to be able to easily add these complex features with ease and minimise the risk of bugs and variation across the business.

Query Attributes

To get started with Sondor.Queries, you'll need to use various custom attributes that are provided. Each attribute provides integration to various querying functionality automatically.

Attributes

1. SondorFieldAttribute
2. SondorFilterableAttribute
3. SondorPatchableAttribute
4. SondorSearchableAttribute
5. SondorSortableAttribute

SondorFieldAttribute

The field attribute decorates a property with querying metadata that is required to integrate with any of the querying functionality.

SondorFilterableAttribute

The filterable attribute labels a property as being Filterable. This means, that when a filter query is made, the property can be explicitly provided as one of the target properties for the filter.

SondorPatchableAttribute

The patchable attribute labels a property as being Patchable. This means, that the property of an instance of the type can be modified in isolation without having to completely update the entire instance.

SondorSearchableAttribute

The searchable attribute labels a property as being Searchable. This means, that when a search query is made, the property can either be explicitly provided as the target property for the search or will be included when searching against all searchable properties for a type.

SondorSortableAttribute

The sortable attribute labels a property as being Sortable. This means, that when a sort query is made, the property can either be provided as a sorting target.

Types

1. Fields Query
2. Filter Query
3. Patch Query
4. Search Query
5. Sort Query

Fields Query

The FieldsQuery type is used to normalise the format provided when explicitly specifying fields of interest, to optimise performance and only request data that is needed thus improving payload size. Specify a type field name(s) for properties by using the SondorFieldAttribute.

Format

The fields query format is simply a comma-separated list of property names.

Example: id,name,created

Methods

FieldsQuery FromQuery

FieldsQuery.FromQuery("id,name,active,created");

FieldsQuery GetDefault

FieldsQuery.GetDefault<TestClass>();

FieldsQuery ValidateFields

typeof(TestClass).ValidateFields(fieldsQuery);