# nestjs-solr

> Solr client for Nestjs

Latest version **1.0.2** (published 2025-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install nestjs-solr
pnpm add nestjs-solr
yarn add nestjs-solr
bun add nestjs-solr
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2025-03-19 |
| First published | 2022-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 83.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dkduyanh |
| Maintainers | dkduyanh |
| Keywords | nestjs, solr |

## Links

- npm: https://www.npmjs.com/package/nestjs-solr
- Repository: https://github.com/dkduyanh/nestjs-solr
- Homepage: https://github.com/dkduyanh/nestjs-solr#readme
- Issues: https://github.com/dkduyanh/nestjs-solr/issues
- npm.io page: https://npm.io/package/nestjs-solr

## Recent versions

- 1.0.2 (latest) — 2025-03-19
- 1.0.1 — 2024-05-13
- 1.0.0 — 2022-10-10

## README

# nestjs-solr

## Description

Solr module for Nestjs.

## Installation

```bash
npm install nestjs-solr
```

## Usage

Register `SolrModule`:

```typescript
import { SolrModule } from 'nest-solr';

@Module({
  imports: [
    SolrModule.register({
      host: 'localhost',
      port: '8983',
      secure: false,
      core: 'mycore',
    }),
  ],
})
export class AppModule {}
```

Inject `SolrService`:

```typescript
import { SolrService } from 'nest-solr';

@Injectable()
export class SearchService {
  constructor(private readonly solrService: SolrService) {}
}
```

### Options for Basic Authentication combined with a self-signed certificate (TLS)
```typescript
import { SolrModule } from 'nest-solr';

@Module({
  imports: [
    SolrModule.register({
      host: 'localhost',
      port: '8983',
      secure: true,
      tls: {
        ca: [fs.readFileSync('solr-ssl.pem')],
      },
      auth: {
        basic: {
          username: 'solr',
          password: 'SolrRocks',
        },
      },
      core: 'mycore',
    }),
  ],
})
export class AppModule {}
```
***(See more [Securing Solr](https://solr.apache.org/guide/solr/latest/deployment-guide/securing-solr.html))

### Async options

```typescript
@Module({
  imports: [
    SolrModule.registerAsync({
      imports: [ConfigModule],
      useFactory: async (configService: ConfigService) => ({
        host: configService.get('SOLR_HOST'),
        port: configService.get('SOLR_PORT'),
        secure: configService.get('SOLR_SECURE'),
        core: 'mycore',
      }),
      inject: [ConfigService],
    }),
  ],
})
```

## Examples
```typescript
// Add a new document
const obj = await this.solrService.add({ id : 12, title_t : 'Hello', status: '1' });
console.log('Solr response:', obj);

// Search
const solrQuery = this.solrService
  .query()
  .q({ title_t: 'Hello' })
  .matchFilter('status', '1') //the fq (Filter Query)
  .fl(['title_t']) //the fl (field List)
  .start(0) //the offset where the set of returned documents should begin
  .rows(10) //the maximum number of documents returned
;
const ret: SearchResponse<any> = await this.solrService.search(solrQuery);
console.log('Solr response:', obj);

// Delete all documents
await this.solrService.deleteAll();
```

## API Spec

The `SolrService` wraps the Solr client from the [lbdremy/solr-node-client](https://github.com/lbdremy/solr-node-client) library. The `SolrModule.register()` takes options object as an argument to create the client, read more [here](https://lbdremy.github.io/solr-node-client/code/solr.js.html).

Solr Homepage: [https://solr.apache.org/](https://solr.apache.org/)

## License
Nestjs-Solr is MIT licensed.

---
_Source: https://npm.io/package/nestjs-solr · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._