日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
RECNO(3) FreeBSD ライブラリ関数マニュアル RECNO(3)
名称
recno -- レコード番号データベースのアクセス方法
書式
#include <sys/types.h>
#include <db.h>
解説
ルーチン dbopen() は、データベースファイルのライブラリインタフェースで
す。サポートされるファイル形式の 1 つは、レコード番号ファイルです。データ
ベースアクセス方式の一般的な説明は、dbopen(3) にあり、このマニュアルペー
ジは、recno 特有の情報だけを説明しています。
レコード番号データ構造は、論理レコード番号によってアクセスされるフラット
ファイル形式で格納された変数または固定長レコードのいずれかです。レコード
番号 5 の存在は、レコード 1 から 4 までの存在することを意味し、レコード番
号 1 の削除によって、レコード番号 1 の後ろに位置付けられているなら、1 つ
のレコードを下方にシフトするカーソルと同様に、レコード番号 5 は、レコード
番号 4 に再番号付けられます。
dbopen() に提供された recno アクセス方式特有のデータ構造は、次のように
<db.h> インクルードファイルで定義されています:
typedef struct {
u_long flags;
u_int cachesize;
u_int psize;
int lorder;
size_t reclen;
u_char bval;
char *bfname;
} RECNOINFO;
この構造体の要素は、次のように定義されます:
flags フラグ値は、次の値のいずれかを論理和 (or) することによって指定さ
れます:
R_FIXEDLEN
レコードは、区切られたバイトではなく、固定長です。構造体
の要素 reclen は、レコードの長さを指定し、構造体の要素
bval は、詰め物 (pad) 文字として使用されます。reclen バイ
ト長未満のデータベースに挿入される、あらゆるレコードは、
自動的に詰め物されます。
R_NOKEY
dbopen() によって指定されたインタフェースで、シーケンシャ
ルなレコードの検索は、呼び出し側のキーとデータ構造の両方
で書き入れます。R_NOKEY フラグが指定されるなら、cursor
ルーチンは、キー構造体に書き入れるように要求されません。
これは、途中のレコードのすべてを読み込まずにファイルの終
わりでレコードを検索して取り出すことをアプリケーションに
許可します。
R_SNAPSHOT
このフラグは、オリジナルのファイルから読み込まれる、あら
ゆる変更されていないレコードを許可する代わりに、dbopen()
が呼び出されるとき、ファイルのスナップショットが取られる
ことを要求します。
cachesize
メモリキャッシュのバイト単位の推奨されている最大のサイズ。この値
は、助言であるのみで、アクセス方式は、失敗ではなくより多くのメモ
リを割り付けます。cachesize が 0 (サイズを、指定しない) であるな
ら、デフォルトのキャッシュが使用されます。
psize recno アクセス方式は、btree にそのレコードのメモリ内コピーを格納
します。この値は、そのツリーのノードのために使用されるページの
(バイト単位の) サイズです。psize が 0 (ページサイズを指定しない)
であるなら、ページサイズは、基本的なファイルシステム I/O ブロック
サイズに基づいて選択されます。詳細については、btree(3) を参照して
ください。
lorder 格納されたデータベースメタデータの整数のためのバイト順序。数値
は、整数として順序を表現するべきです。例えば、ビッグエンディアン
の順序は、数値 4,321 となるでしょう。lorder が、0 (順序を指定しな
い) であるなら、現在のホストの順序が使用されます。
reclen 固定長レコードの長さ。
bval 可変長レコードのためのレコードの終わりをマークするために使用され
る区切りバイトと固定長レコードのための詰め物文字。値が指定されな
いなら、改行 (``\n'') は、可変長レコードの終わりをマークするため
に使用され、固定長レコードは、空白で詰め物されます。
bfname recno アクセス方式は、btree でそのレコードのメモリ内コピーを格納
します。bfname が NULL でないなら、それは、あたかも btree ファイ
ルの dbopen() のためのファイル名として指定されるかのように、btree
ファイルの名前を指定します。
recno アクセス方式によって使用されるキー/データのペアのデータ部分は、他の
アクセス方式と同じです。キーは、異なります。キーの data フィールドは、
<db.h> インクルードファイルで定義されるようにタイプ recno_t のメモリ位置
へのポインタであるべきです。このタイプは、通常、実装に利用可能な最も大き
な符号なしの整数タイプです。キーの size フィールドは、そのタイプのサイズ
であるべきです。
基本的な recno アクセス方式ファイルに関連するメタデータがないかもしれない
ので、(例えば、固定されたレコード長またはバイト分離記号の値) デフォルト値
に行われるあらゆる変更は、ファイルがオープンされるたびに、明示的に指定さ
れなければなりません。
dbopen() によって指定されるインタフェースにおいて、新しいレコードを作成す
るための put インタフェースを使用することは、レコード番号が、現在のデータ
ベースで最も大きいレコードより 2 倍以上であるなら、空のレコードを複数作成
します。
エラー
recno アクセス方式ルーチンは、失敗して、ライブラリルーチン dbopen(3) のた
めに明記されたエラーのいずれか、または次のために errno を設定します:
[EINVAL] 適合するには大きすぎる固定長データベースにレコードを追
加する試みが行われました。
関連項目
btree(3), dbopen(3), hash(3), mpool(3)
Michael Stonebraker, Heidi Stettner, Joseph Kalash, Antonin Guttman, and
Nadene Lynn, Document Processing in a Relational Database System,
Memorandum No. UCB/ERL M82/32, May 1982.
バグ
ビッグエンディアンとリトルエンディアンのバイト順序のみサポートされていま
す。
FreeBSD 11.2 August 18, 1994 FreeBSD 11.2