# SearchService

## Hierarchy

- `AbstractSearchService`

  ↳ **`SearchService`**

## Constructors

### constructor

**new SearchService**(`«destructured»`, `options`)

#### Parameters

| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
| `options` | `any` |

#### Overrides

AbstractSearchService.constructor

#### Defined in

[medusa/src/services/search.ts:16](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L16)

## Properties

### isDefault

 **isDefault**: `boolean` = `true`

#### Overrides

AbstractSearchService.isDefault

#### Defined in

[medusa/src/services/search.ts:11](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L11)

___

### logger\_

 `Protected` `Readonly` **logger\_**: `Logger`

#### Defined in

[medusa/src/services/search.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L13)

___

### options\_

 `Protected` `Readonly` **options\_**: Record<`string`, `unknown`\>

#### Overrides

AbstractSearchService.options\_

#### Defined in

[medusa/src/services/search.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L14)

## Accessors

### options

`get` **options**(): Record<`string`, `unknown`\>

#### Returns

Record<`string`, `unknown`\>

-`Record`: 
	-`string`: (optional) 
	-`unknown`: (optional) 

#### Inherited from

AbstractSearchService.options

#### Defined in

utils/dist/search/abstract-service.d.ts:5

## Methods

### addDocuments

**addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |
| `documents` | `unknown` |
| `type` | `string` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.addDocuments

#### Defined in

[medusa/src/services/search.ts:40](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L40)

___

### createIndex

**createIndex**(`indexName`, `options`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |
| `options` | `unknown` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.createIndex

#### Defined in

[medusa/src/services/search.ts:28](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L28)

___

### deleteAllDocuments

**deleteAllDocuments**(`indexName`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.deleteAllDocuments

#### Defined in

[medusa/src/services/search.ts:69](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L69)

___

### deleteDocument

**deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |
| `document_id` | `string` \| `number` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.deleteDocument

#### Defined in

[medusa/src/services/search.ts:60](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L60)

___

### getIndex

**getIndex**(`indexName`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.getIndex

#### Defined in

[medusa/src/services/search.ts:34](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L34)

___

### replaceDocuments

**replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |
| `documents` | `unknown` |
| `type` | `string` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.replaceDocuments

#### Defined in

[medusa/src/services/search.ts:50](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L50)

___

### search

**search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[]  }\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |
| `query` | `unknown` |
| `options` | `unknown` |

#### Returns

`Promise`<{ `hits`: `unknown`[]  }\>

-`Promise`: 
	-``object``: (optional) 

#### Overrides

AbstractSearchService.search

#### Defined in

[medusa/src/services/search.ts:75](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L75)

___

### updateSettings

**updateSettings**(`indexName`, `settings`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `indexName` | `string` |
| `settings` | `unknown` |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Overrides

AbstractSearchService.updateSettings

#### Defined in

[medusa/src/services/search.ts:86](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/search.ts#L86)