3.2.10 キーフィールドオプション（-key-def）

キーフィールドを指定します。
1つのキーフィールドは、位置、長さ、データ形式、および操作で構成されます。
キーフィールドは複数指定することができます。複数のキーフィールドを指定する場合は、キーフィールドをコンマ(,)で区切って指定します(-key-def,key-def)。また、1つ前のキーフィールドの指定に続けて指定(-key-def key-def)することや、キーフィールドオプションを複数指定することもできます(-key-def -key-def)。複数のキーフィールドを指定した場合、指定順に比較が行われます。
キーフィールドの指定を省略した場合、レコード全体をキーフィールドとみなしてコードの昇順に並べます。キーフィールドの指定を省略して降順に並べる場合は、降順オプション(-r)を使用します。

注意

テキストファイルCSV形式、テキストファイルTSV形式の場合、キーフィールドの指定は省略できません。

記述形式

-key-def [ ,key-def ...]

key-def の記述形式

pos.len typ [ opt ]

pos

キーフィールドの位置を指定します。
バイナリファイルとテキストファイル固定フィールド指定の場合は、レコードの先頭を0としたバイト位置を指定します。テキストファイル浮動フィールド指定、テキストファイルCSV形式、およびテキストファイルTSV形式の場合は、0から数えたフィールド番号を指定します。

len

キーフィールドの長さをバイト数で指定します。
テキストファイル浮動フィールド指定、テキストファイルCSV形式、およびテキストファイルTSV形式の場合、指定したフィールド長よりも長いフィールドが現れた場合は、指定したフィールド長で処理します。指定したフィールド長よりも短いフィールドが現れた場合は、実際のフィールド長で処理します。
typ に符号なし2進数を指定する場合、len には1バイト分のビットを選択するためのマスク値を10進数で指定します。このとき、pos の位置にある1バイトのフィールド値とマスク値の論理積がキーフィールドの値となります。
各データ形式における指定可能な長さについては、1.6.4.1 キーフィールドに指定可能なデータ形式を参照してください。

注意

テキストファイルCSV形式、およびテキストファイルTSV形式の場合、フィールドを囲むダブルクォーテーション(")は、キーフィールドの長さに含みません。また、ダブルクォーテーション(")で囲まれたフィールド内の2つ連続したダブルクォーテーション("")は、1つのダブルクォーテーション(")として長さを計算します。

例) テキストファイルCSV形式における、キーフィールドと長さ

キーフィールド        キーフィールドとして有効な文字        キーフィールドの長さ
ABC                   ABC                                   3バイト
"ABC"                 ABC                                   3バイト
"A""B""C"             A"B"C                                 5バイト
"A,B,C"               A,B,C                                 5バイト

typ

キーフィールドのデータ形式を指定します。
指定可能なデータ形式については、1.6.4.1 キーフィールドに指定可能なデータ形式を参照してください。

opt

キーフィールドの操作を指定します。
指定可能な操作を以下に示します。バイナリファイルの場合は、a、l、およびrが指定できます。テキストファイルの場合は、全てのキーフィールドの操作が指定できます。複数の操作を指定する場合は、続けて記述します。aとrを両方とも省略した場合は、aを指定したものとして動作します。

opt	意味
a	昇順に並べます。 rとは排他関係にあります。
b	キーフィールドの先頭の空白とタブを無視します。
d	空白と英数字だけを比較の対象とします。
i	制御文字コードを無視します。 EUCコードのシングルシフト2(SS2)0x8e、およびシングルシフト3(SS3)0x8fは、ASCIIコード指定の場合は制御文字、EUCコード指定の場合は文字とみなされます。
j	英小文字を英大文字として比較します。
l	環境変数LC_COLLATEで定義した照合順序に並べます。データ形式がASCIIコード、EUCファイルコード、EUC2バイトプロセスコード、EUC4バイトプロセスコード、またはUnicode UTF-8形式で、入力コード系オプション(-q)がEBCDICコード系以外の場合に指定できます。 n、およびNとは排他関係にあります。
n	符号を含んだ数字の文字列を算術的な値で比較します。文字列中に数字以外の文字が存在した場合の結果は保証されません。データ形式がASCIIコード、EBCDICコード、Unicode UCS-2形式、Unicode UTF-32形式、またはUnicode UTF-8形式の場合に指定できます。 l、およびNとは排他関係にあります。
N	英字と数字の連結データ(例えば「data123」など)を英字と数値に分けて評価し並べます。英字だけを比較の対象として比較後、数字だけの文字列を算術的な値で比較します。指定フィールドの左から評価し、有効データ後に出現したデータは無視します。データ形式がASCIIコード、EBCDICコード、Unicode UCS-2形式、Unicode UTF-32形式、またはUnicode UTF-8形式の場合に指定できます。 l、およびnとは排他関係にあります。
r	降順に並べます。 aとは排他関係にあります。

注意

キーフィールドのデータ形式に照合順序変更を指定した場合、キーフィールドの操作にa、またはr以外を指定することはできません。
キーフィールドのデータ形式に文字形式2桁年号、外部10進形式2桁年号、内部10進形式2桁年号、および10進形式2桁年号を指定した場合、キーフィールドの操作にa、またはr以外を指定しても無視されます。

記述例

例

入力レコードの先頭から長さ10バイトのASCIIコードのフィールドを昇順に並べる場合は、以下のように指定します。
```
-0.10asca
```
入力レコードの5バイト目から長さ8バイトの外部10進数のフィールドを降順に並べる場合は、以下のように指定します。
```
-4.8zdlr
```
テキストファイル固定フィールド指定の場合、入力レコードの10バイト目から長さ20バイトのASCIIコードのフィールドを昇順に並べる場合は、以下のように指定します。なお、キーフィールドの先頭の空白とタブは無視し、英小文字を英大文字として比較します。
```
-9.20ascabj
```

参考

バイナリファイルの可変長レコード形式、またはテキストファイルの場合、キーフィールドが存在しないレコードが入力されたときは、キーフィールドが存在しない部分の値を0とみなして処理します。
ここに記載した「キーフィールドが存在しないレコード」とは、指定されたキーフィールドにデータが存在しないレコードを意味します。

例1) バイナリファイル可変長レコード形式、テキストファイル固定フィールド指定の場合

キーフィールドの指定が「6.4asca」のとき

  0123456789   : キーフィールドが存在するレコード
  012345       : キーフィールドが存在しないレコード

例2) テキストファイル浮動フィールド指定、CSV形式、TSV形式の場合

キーフィールドの指定が「2.1asca」のとき(ここではフィールドの区切りをカンマ(,)で表します）

  fld0,fld1,fld2,fld3   : キーフィールドが存在するレコード
  fld0,fld1             : キーフィールドが存在しないレコード
  fld0,fld1,,fld3       : キーフィールドが存在しないレコード