# groonga - An open-source fulltext search engine and column store.

- 日本語版はこちら

### Navigation

- index
- next |
- previous |
- Groonga v4.0.4-214-gb1aaec1 documentation »
- 8. Reference manual »
- 8.3. Command »

# 8.3.19. `normalize`

Caution

`normalize` command is the experimental feature. This command may be changed in the future.

## 8.3.19.1. Summary

`normalize` command normalizes text by the specified normalizer.

There is no need to create table to use `normalize` command. It is useful for you to check the results of normalizer.

## 8.3.19.2. Syntax

`normalize` commands has two required parameters. They are `normalizer` and `string`.

    normalize normalizer
              string
              [flags=NONE]

## 8.3.19.3. Usage

Here is a simple example of `normalize` command.

Execution example:

    normalize NormalizerAuto "aBcDe 123"
    # [
    #   [
    #     0,
    #     1337566253.89858,
    #     0.000355720520019531
    #   ],
    #   {
    #     "normalized": "abcde 123",
    #     "types": [],
    #     "checks": []
    #   }
    # ]

## 8.3.19.4. Parameters

This section describes parameters of `normalizer`.

### 8.3.19.4.1. Required parameter

There are required parameters, `normalizer` and `string`.

#### 8.3.19.4.1.1. `normalizer`

It specifies the normalizer name. `normalize` command uses the normalizer that is named `normalizer`.

See Normalizers about built-in normalizers.

Here is an example to use built-in `NormalizerAuto` normalizer.

TODO

If you want to use other normalizers, you need to register additional normalizer plugin by register command. For example, you can use MySQL compatible normalizer by registering groonga-normalizer-mysql.

#### 8.3.19.4.1.2. `string`

It specifies any string which you want to normalize.

If you want to include spaces in `string`, you need to quote `string` by single quotation (`'`) or double quotation (`"`).

Here is an example to use spaces in `string`.

TODO

### 8.3.19.4.2. Optional parameters

There are optional parameters.

#### 8.3.19.4.2.1. `flags`

It specifies a normalization customize options. You can specify multiple options separated by "`|`". For example, `REMOVE_BLANK|WITH_TYPES`.

Here are available flags.

Flag | Description
--- | ---
`NONE` | Just ignored.
`REMOVE_BLANK` | TODO
`WITH_TYPES` | TODO
`WITH_CHECKS` | TODO
`REMOVE_TOKENIZED_DELIMITER` | TODO

Here is an example that uses `REMOVE_BLANK`.

TODO

Here is an example that uses `WITH_TYPES`.

TODO

Here is an example that uses `REMOVE_TOKENIZED_DELIMITER`.

TODO

## 8.3.19.5. Return value

    [HEADER, normalized_text]

`HEADER`

> See Output format about `HEADER`.

`normalized_text`

> `normalized_text` is an object that has the following attributes.

> Name | Description
> --- | ---
> `normalized` | The normalized text.
> `types` | An array of types of the normalized text. The N-th `types` shows the type of the N-th character in `normalized`.

## 8.3.19.6. See also

- Normalizers

### Navigation

- index
- next |
- previous |
- Groonga v4.0.4-214-gb1aaec1 documentation »
- 8. Reference manual »
- 8.3. Command »