> ## Documentation Index
> Fetch the complete documentation index at: https://nestjs-query.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Nestjs-Query is collection of packages to make crud for  (and potentially other transports) easier.

## Why?[​](#why "Direct link to Why?")

While working on projects in nestjs it was very easy to get up and running with typeorm and graphql however, there were many patterns that were common between the resolvers. In particular querying, sorting and paging.

## Features[​](#features "Direct link to Features")

* Built on top of [nestjs](https://nestjs.com/)
* Out of the box [CRUD for GraphQL](/graphql/resolvers) using [TypeORM](https://typeorm.io/), [Sequelize](https://sequelize.org/) or [Mongoose](https://mongoosejs.com/)
* [Aggregate Queries](/graphql/aggregations) on objects and their relations.
* Out of the box [subscriptions](/graphql/subscriptions) on all `CRUD` operations.
* Support for one to one, one to many, many to one and many to many [relations](/graphql/relations).
* Built in [dataloader](https://github.com/graphql/dataloader) avoiding the `n+1` problem
* Relay [connections](https://facebook.github.io/relay/graphql/connections.htm) for paging results

## Install[​](#install "Direct link to Install")

Check out the [installation docs](/introduction/install)

## Packages[​](#packages "Direct link to Packages")

Nestjs-query is composed of multiple packages

* [`@ptc-org/nestjs-query-core`](https://github.com/tripss/nestjs-query/tree/master/packages/core) - Defines all interfaces and utility types implemented by the other packages.
* [`@ptc-org/nestjs-query-graphql`](https://github.com/tripss/nestjs-query/tree/master/packages/query-graphql) - Package that provides the graphql resolver and decorators for crud endpoints.
* [`@ptc-org/nestjs-query-typeorm`](https://github.com/tripss/nestjs-query/tree/master/packages/query-typeorm) - Package that implements a Typeorm service that can be used by itself or with the graphql resolver provided by `@ptc-org/nestjs-query-graphql`.
* [`@ptc-org/nestjs-query-sequelize`](https://github.com/tripss/nestjs-query/tree/master/packages/query-sequelize) - Package that implements a Sequelize service that can be used by itself or with the graphql resolver provided by `@ptc-org/nestjs-query-graphql`.
* [`@ptc-org/nestjs-query-mongoose`](https://github.com/tripss/nestjs-query/tree/master/packages/query-mongoose) - Package that implements a Mongoose service that can be used by itself or with the graphql resolver provided by `@ptc-org/nestjs-query-graphql`.
* [`@ptc-org/nestjs-query-typegoose`](https://github.com/tripss/nestjs-query/tree/master/packages/query-typegoose) - Package that implements a Typegoose service that can be used by itself or with the graphql resolver provided by `@ptc-org/nestjs-query-graphql`.

## Migration Guides[​](#migration-guides "Direct link to Migration Guides")

* [`v0.24.x` to `v0.25.x`](/migration-guides/v0.24.x-to-v0.25.x)
* [`v0.23.x` to `v0.24.x`](/migration-guides/v0.23.x-to-v0.24.x)
* [`v0.22.x` to `v0.23.x`](/migration-guides/v0.22.x-to-v0.23.x)
* [`v0.15.x` to `v0.16.x`](/migration-guides/v0.15.x-to-v0.16.x)
* [`v0.14.x` to `v0.15.x`](/migration-guides/v0.14.x-to-v0.15.x)
* [`v0.13.x` to `v0.14.x`](/migration-guides/v0.13.x-to-v0.14.x)
* [`v0.12.x` to `v0.13.x`](/migration-guides/v0.12.x-to-v0.13.x)
* [`v0.10.x` to `v0.11.x`](/migration-guides/v0.10.x-to-v0.11.x)
* [`v0.5.x` to `v0.6.x`](/migration-guides/v0.5.x-to-v0.6.x)

[Edit this page](https://github.com/tripss/nestjs-query/edit/master/docs/introduction/getting-started)
