modulus add-query

Scaffolds a CQRS query and its handler inside a module's Application layer. Queries represent read operations and always return a result. They are dispatched through the Modulus mediator pipeline and should have no side effects.

Synopsis

modulus add-query <query-name> [options]

Arguments

Argument	Description
<query-name>	PascalCase name for the query (e.g., GetProductById, ListOrders).

Options

Option	Description	Default
--module, -m <name>	(Required) Target module where the query will be created.	--
--result-type, -r <type>	(Required) The return type wrapped in Result<T>. Every query must declare what it returns.	--
--solution, -s <path>	Path to the .slnx solution file.	Auto-discovered

Generated Output

Running modulus add-query GetProductById --module Catalog --result-type ProductDto generates two files:

Query record

src/Modules/Catalog/EShop.Modules.Catalog.Application/Queries/GetProductById/GetProductByIdQuery.cs

using EShop.SharedKernel.Application;

namespace EShop.Modules.Catalog.Application.Queries.GetProductById;

public sealed record GetProductByIdQuery : IQuery<ProductDto>;

Handler class

src/Modules/Catalog/EShop.Modules.Catalog.Application/Queries/GetProductById/GetProductByIdQueryHandler.cs

using EShop.SharedKernel.Application;

namespace EShop.Modules.Catalog.Application.Queries.GetProductById;

public sealed class GetProductByIdQueryHandler
    : IQueryHandler<GetProductByIdQuery, ProductDto>
{
    public async Task<Result<ProductDto>> Handle(
        GetProductByIdQuery query,
        CancellationToken cancellationToken)
    {
        // TODO: Implement query logic
        throw new NotImplementedException();
    }
}

No Validator Generated

Unlike commands, queries do not generate a validator class. Queries are read-only operations and typically do not require input validation beyond what the type system provides. If you need validation on a query, you can add a validator manually and it will be picked up by the validation pipeline behavior automatically.

Examples

Create a query returning a single DTO:

modulus add-query GetProductById --module Catalog --result-type ProductDto

Create a query returning a list:

modulus add-query ListProducts --module Catalog --result-type "List<ProductDto>"

Create a query returning a paginated result:

modulus add-query SearchOrders --module Orders --result-type "PagedResult<OrderSummaryDto>"

Create a query with an explicit solution path:

modulus add-query GetCustomerProfile --module Identity --result-type CustomerProfileDto --solution ./EShop.slnx

See Also

• modulus add-command -- Scaffold write-side commands
• modulus add-endpoint -- Wire queries to HTTP GET endpoints
• Commands & Queries -- How the mediator dispatches queries
• Streaming Queries -- For queries that return IAsyncEnumerable<T>