[Oracle Database] CHAR型のデータの検索結果が0件になる？

# はじめに
Oracle Database にJDBCから以下のSQLを実行した結果が0件になりました。
もちろんCOL1には'ア'という文字データがINSERTされています。
```sample.java
String sql = "SELECT count(*) FROM HOGE WHERE COL1 = ?";
//略
statement.setString(1, "ア");
//略
```

COL1のデータ型は`CHAR(2)`、DBのNLS_CHARACTERSETは`AL32UTF8`です。
同じDBに対して、今度はSQL*Plusで以下のSQLを実行してみました。
```sample.sql
SELECT count(*) FROM HOGE WHERE COL1 = 'ア';
```

こちらは0件ではなく、正しい結果が返ってきます。

次に、COL1のデータ型を`VARCHAR2(2)`にしてsample.javaを実行してみました。
今度はsample.sqlと同様、正しい結果が返ってきました。

何がダメなのでしょうか？

本記事では、この原因を解明するのに必要な**Oracle Databaseにおける文字列データの扱い**についてまとめてみます。

# CHAR型とVARCHAR2型
Oracle Databaseにおいて、文字列型を格納するデータ型で最もよく使われるのが、CHAR型とVARCHAR2型です。
まずは、この2つのデータ型の違いを意識する必要があります。

一言で言うと、CHAR型は固定長、VARCHAR2型は可変長です。

例えば、CHAR(5)というデータ型に、'123'という文字列を格納するとします。
'123'という文字列は3バイトですが、指定バイト数は5です。
この場合、CHAR型は**半角スペースで空白を埋めます**。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1930162/6fe80f99-5e91-eb7d-e12a-43bfe0d6d5bb.png)

一方、VARCHAR2(5)というデータ型に'123'という文字列を格納すると、こちらは**データのバイト数で格納します**。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1930162/303aaffe-71a5-7b3f-b91a-a8c0720cda2c.png)

勘の良い方はお気づきになられたと思いますが、CHAR型で0件になり、VARCHAR2型では正しい結果が返ってくるのはこの違いが原因です。

CHAR型は指定バイトに満たない場合、半角スペースで残りを埋めるため、実際に格納されているデータとしては'ア△'になります。
**※△は半角スペース**

ですので、sample.javaでは以下のように検索すれば、正しく結果が返ってきます。
```sample2.java
String sql = "SELECT count(*) FROM HOGE WHERE COL1 = ?";
//略
statement.setString(1, "ア△");
//略
```

ここで、文字コードに知見のある方は違和感を覚えるかもしれません。

「CHAR(2)に'ア'って格納できるの？'ア'ってそもそもUTF8だと3バイト扱いでは？」

はい、その通りです。実はこのOracle Databaseでは事前にある設定をしていました。

# NLS_LENGTH_SEMANTICS
最初に言え、と思われたかもしれませんが、実はこのDBではNLS_LENGTH_SEMANTICSというパラメータを変更していました。
NLS_LENGTH_SEMANTICSは、データベース・オブジェクトのPL/SQL変数に使用するデフォルトの長さセマンティクスを指定するパラメータです。
このパラメータは以下のSQLで確認できます。

```sql
SELECT * FROM V$NLS_PARAMETERS WHERE parameter = 'NLS_LENGTH_SEMANTICS';

PARAMETER               VALUE       CON_ID
_______________________ ________ _________
NLS_LENGTH_SEMANTICS    BYTE            11
```

デフォルトでは、このように`VALUE=BYTE`となっているはずです。
このNLS_LENGTH_SEMANTICSは、BYTEもしくはCHARという設定が可能です。

デフォルトであるBYTEの場合、CHAR(2)というデータ型には**2バイト**まで格納できます。
一方、CHARの場合、CHAR(2)というデータ型には**2文字**まで格納できることになります。
これは'a'のような1文字＝1バイトであるシングルバイト文字であれば違いはないですが、今回の全角カタカナのようなマルチバイト文字を格納する場合には意識する必要があります。

なお、NLS_LENGTH_SEMANTICSはALTER SYSTEM文、またはALTER SESSION文で変更可能です。
```sql
ALTER SYSTEM SET NLS_LENGTH_SEMANTICS = 'CHAR';
```

このパラメータを変更していたため、CHAR(2)にも本来であれば3バイト使うため格納できない'ア'を格納できたわけです。
実際には1文字分余っているので'ア△'で格納されています。

さて、それではなぜSQL*Plusでは正しく検索できたのでしょうか？

答えはOracle Databaseの文字列比較セマンティクスにあります。

# 空白埋め比較セマンティクスと非空白埋め比較セマンティクス
Oracle Databaseでは、文字列の比較を行う際に2つの比較セマンティクスがあります。
空白埋め比較セマンティクスでは、2つの値の長さが異なる場合、まず短い方の値の最後に空白を追加して、2つの値が同じ長さになるようにします。
次に1文字ずつ比較していく、2つの値の後続空白数のみが異なる場合、その2つの値は等しいとみなされます。

つまり、'a△' = 'a' となります。

比較する両方の値が、CHARデータ型、NCHARデータ型、テキスト・リテラルのいずれかの式の場合、またはUSERファンクションの戻り値の場合のみ空白埋め比較セマンティクスを使用します。

一方、非空白埋め比較セマンティクスでは、2つの値を、最初に異なる文字まで1文字ずつ比較します。最初に異なる文字の位置で、大きい方の文字を持つ値の方が大きいとみなされます。長さが異なる2つの値を短い方の値の最後まで比較して、すべて同じ文字だった場合、長い方の値が大きいとみなされます。

つまり、'a△' ＞ 'a' となります。

比較する片方または両方の値がVARCHAR2データ型またはNVARCHAR2データ型の場合、非空白埋め比較セマンティクスを使用します。

これを踏まえて、sample.javaとsample.sqlの違いを見てみます。
sample.sqlのSQL文は、文字列埋め込みのSQL文です。このとき、'ア'はテキスト・リテラルとして扱われます。
COL1はCHAR型であるため、空白埋め比較セマンティクスを使用する条件を満たします。
このため、実際は'ア△'で格納されていても、COL1 = 'ア' という条件で検索ができるというわけです。

一方、sample.javaのSQL文は、Stringでパラメータとして値を渡しています。この場合、'ア'はVARCHAR2として扱われます。
COL1はCHAR型ですが、'ア'の方がVARCHAR2であるため、非空白埋め比較セマンティクスを使用します。
COL1は'ア△'で格納されているため、'ア△' ＞ 'ア' となり、検索されないというわけです。 

冒頭ではJDBCとSQL*Plusの違いが原因のように書いていますが、実際はパラメータとして扱われるかテキスト・リテラルとして扱われるかという違いによるものです。

SQL*Plusでも、以下のようにVARCHAR2のバインド変数を使えば0件になります。
```sql
variable str VARCHAR2(2);
execute :str := 'ア';

SELECT count(*) FROM HOGE WHERE COL1 = :str;
```

# その他の例
ここまで文字列の扱いの違いについて見てきましたが、最後に2つ例をご紹介します。
以下の条件では結果が0件になるでしょうか？

条件：文字コードJA16EUC / NLS_LENGTH_SEMANTICSはBYTE / データ型CHAR(2) / Stringで値を渡す

+ COL1 = 'ア'

**答え：正しく結果が返る**
文字コードがEUCなので、'ア'は2バイト分です。NLS_LENGTH_SEMANTICSがBYTEなので、CHAR(2)の2バイト分使いきることになります。
ちょうど'ア'の形で格納されるため、'ア'で検索可能です。

+ COL1 = 'a'

**答え：0件になる**
'a'はシングルバイトなので、CHAR(2)では1バイト分余ります。空白で埋めるため、'a△'の形で格納されます。よって結果は0件です。

# 参考
+ <a href="https://docs.oracle.com/cd/E57425_01/121/ZZPRE/GUID-9F34D892-C67C-4567-94C6-E402BB079FA8.htm" target="_blank" rel="noopener noreferrer">Oracleデータ型</a>
+ <a href="https://docs.oracle.com/cd/E16338_01/server.112/b56311/initparams152.htm" target="_blank" rel="noopener noreferrer">NLS_LENGTH_SEMANTICS</a>
+ <a href="https://docs.oracle.com/cd/E16338_01/server.112/b56299/sql_elements002.htm#:~:text=%E7%A9%BA%E7%99%BD%E5%9F%8B%E3%82%81%E6%AF%94%E8%BC%83%E3%82%BB%E3%83%9E%E3%83%B3%E3%83%86%E3%82%A3%E3%82%AF%E3%82%B9%E3%81%8A%E3%82%88%E3%81%B3%E9%9D%9E%E7%A9%BA%E7%99%BD%E5%9F%8B%E3%82%81%E6%AF%94%E8%BC%83%E3%82%BB%E3%83%9E%E3%83%B3%E3%83%86%E3%82%A3%E3%82%AF%E3%82%B9" target="_blank" rel="noopener noreferrer">空白埋め比較セマンティクスおよび非空白埋め比較セマンティクス</a>