.\" This is -*-nroff-*-
.\" $Header: /usr/local/cvsroot/pgsql/src/man/bki.5,v 1.3 1998/04/07 18:12:50 momjian Exp $
.\" Translated by Mitsuhiro Maeda (mitsu@cni.co.jp)
.TH BKI 5 11/04/96 日本語Postgres 日本語Postgres
.SH 名称
*.bki
.SH 説明
.\" Backend Interface (BKI) files are scripts that are input to the postgres
.\" backend running in the special "bootstrap" mode that allows it to perform
.\" database functions without a database system already existing.
バックエンドインタフェイス (BKI) ファイルは、
既に存在するデータベースシステムなしでデータベース関数を実行することができる
特別なブートストラップ("bootstrap")モードで走っているバックエンドへの入力となる
スクリプトです。
.\"   BKI files
.\" can therefore be used to create the database system in the first place.
ですから、BKI ファイルは
一番最初にデータベースシステムを作る時に使われます。
.PP
.\" .IR Initdb
.\" uses BKI files to do just that -- create a database system.
.IR initdb
は BKI ファイルを単にデータベースシステムの作成に使うのみです。
.\"   However,
.\" .IR initdb's
.\" BKI files are generated internally.
しかし、
.IR initdb
の BKI ファイルが内部的に生成されたものです。
.\"   It generates them using the files
.\" global1.bki.source and local1.template1.bki.source, which it finds in the
.\" Postgres "library" directory.
global1.bki.source と local1.template1.bki.source のファイルをを使って
生成されたもので、Postgres のライブラリディレクトリにあります。
.\"   They get installed there as part of installing
.\" Postgres.
Postgres のインストールの一部としてそこにインストールされています。
.\"   These .source files get build as part of the Postgres build
.\" process, by a build program called 
.\" .IR genbki.
これら .source ファイルは Postgres の組み立てプロセスの一部として
組み立てられます。
.IR genbki
という組み立てプログラムが呼び出されています。
.\"   Genbki
.\" takes as input Postgres source files that double as
.\" .IR genbki
.\" input that builds tables and C header files that describe those
.\" tables.
genbki は入力として Postgres のソースファイルを取って、
そうした表を記述する表と Cのヘッダファイルを組み立てます。
.PP
.\" The Postgres backend interprets BKI files as described below.
Postgres のバックエンドは BKI ファイルを下のように処理します。
.\"   This
.\" description will be easier to understand if the global1.bki.source file is
.\" at hand as an example.
もし global1.bki.source ファイルが手もとに例としてあるなら、
この記述は容易に理解できるでしょう。
.\"   (As explained above, this .source file isn't quite
.\" a BKI file, but you'll be able to guess what the resulting BKI file would be
.\" anyway).
(上で述べたように、この .source ファイルは厳密には BKI ファイルではありませんが、
結果としての BKI ファイルがどのようなものであるかを推測することはできるでしょう)
.PP
.\" Commands are composed of a command name followed by space separated
.\" arguments.
コマンドはコマンド名とそれに続く空白で区切られた引数とから構成されています。
.\"   Arguments to a command which begin with a \*(lq$\*(rq are
.\" treated specially.
コマンドへの引数で \*(lq$\*(rq で始まるものは特別に扱われます。
.\"   If \*(lq$$\*(rq are the first two characters, then
.\" the first \*(lq$\*(rq is ignored and the argument is then processed
.\" normally.
もし \*(lq$$\*(rq が最初の 2文字なら、
最初の \*(lq$\*(rq は無視され、それから引数は通常通りに処理されます。
.\"   If the \*(lq$\*(rq is followed by space, then it is treated
.\" as a
.\" .SM NULL
.\" value.
もし \*(lq$\*(rq のすぐ後がスペースなら、
.SM NULL
値として扱われます。
.\"   Otherwise, the characters following the \*(lq$\*(rq are
.\" interpreted as the name of a macro causing the argument to be replaced
.\" with the macro's value.
そうでなければ、
\*(lq$\*(rq に続く文字は
引数がマクロの値と置き換えられるようにする
マクロ名です。
.\"   It is an error for this macro to be
.\" undefined.
このマクロが定義されていないとエラーとなります。
.PP
.\" Macros are defined using
マクロは
.nf
.\" define macro macro_name = macro_value
define macro マクロ名 = マクロ値
.fi
で定義して、
.\" and are undefined using 
.nf
.\" undefine macro macro_name
undefine macro マクロ名
.fi
で定義を取り除いて、
.\" and redefined using the same syntax as define.
定義の時と同じ文法で再定義します。
.PP
.\" Lists of general commands and macro commands
.\" follow.
一般的なコマンドとマクロコマンドは次のようになります。
.\" .SH "GENERAL COMMANDS"
.SH "一般的なコマンド"
.TP 5n
.BR "open" " classname"
.\" Open the class called
.\" .IR classname
.\" for further manipulation.
.IR classname
というクラスを後の操作のためにオープンします。
.TP
.BR "close" " [classname]"
.\" Close the open class called
.\" .IR classname.
.IR classname
というオープンしたクラスをクローズします。
.\" It is an error if 
.\" .IR classname
.\" is not already opened.
もし
.IR classname
が既にオープンされた状態でなければエラーとなります。
.\"   If no
.\" .IR classname
.\" is given, then the currently open class is closed.
もし
.IR classname
が与えられなければ、現在オープンされているクラスが閉じられます。
.TP
.BR print
.\" Print the currently open class.
現在オープンされているクラスを出力します。
.TP
.BR "insert" " [oid=oid_value] " "(" " value1 value2 ... " ")"
.\" Insert a new instance to the open class using
.\" .IR value1 ,
.\" .IR value2 ,
.\" etc., for its attribute values and 
.\" .IR oid_value
.\" for its OID.
.IR value1 、
.IR value2
などをその属性値として、また
.IR oid_value
をその OID として使い、
オープンしているクラスに新しいインスタンスを挿入します。
.\"   If
.\" .IR oid_value
.\" is not \*(lq0\*(rq, then this value will be used as the instance's
.\" object identifier.  Otherwise, it is an error.
もし
.IR oid_value
が\*(lq0\*(rqでなければ、
この値がそのインスタンスのオブジェクト識別子となります。
そうでなければ、エラーとなります。
.TP
.BR "insert (" " value1 value2 ... " ")"
.\" As above, but the system generates a unique object identifier.
上記と同様ですが、システムが一意なオブジェクト識別子を生成します。
.TP
.BR "create" " classname " "(" " name1 = type1, name2 = type2, ... " ")"
.\" Create a class named
.\" .IR classname
.\" with the attributes given in parentheses.
括弧内に与えられた属性で
.IR classname
というクラスを作ります。
.TP
.BR "open (" " name1 = type1, name2 = type2,... " ") as" " classname"
.\" Open a class named
.\" .IR classname
.\" for writing but do not record its existence in the system catalogs.
.\" (This is primarily to aid in bootstrapping.)
.IR classname
というクラスを書き込みのためにオープンしますが、
システムカタログに現存するものは記録しません。
(これは主にブートストラップの手助けとするためのものです。)
.TP
.BR "destroy" " classname"
.\" Destroy the class named
.\" .IR classname .
.IR classname
というクラスを削除します。
.TP
.BR "define index" " index-name " "on" " class-name " "using" " amname "
( opclass attr | function({attr}) )
.br
.\" Create an index named
.\" .IR index_name
.\" on the class named
.\" .IR classname
.\" using the
.\" .IR amname
.\" access method.
.IR classname
というクラスに
.IR index_name
というインデックスを
.IR amname
アクセスメソッドを用いて作ります。
.\"   The fields to index are called
.\" .IR name1 ,
.\" .IR name2 ,
.\" etc., and the operator collections to use are
.\" .IR collection_1 ,
.\" .IR collection_2 ,
.\" etc., respectively.
インデックスのフィールドは
.IR name1 、
.IR name2
などで、
.IR collection_1 、
.IR collection_2
などがそれぞれの演算子の集合となります。
.\" .SH "MACRO COMMANDS"
.SH "マクロコマンド"
.TP
.BR "define function" " macro_name " "as" " rettype function_name ( args )"
.\" Define a function prototype for a function named
.\" .IR macro_name
.\" which has its value of type
.\" .IR rettype
.\" computed from the execution
.\" .IR function_name
.\" with the arguments
.\" .IR args 
.\" declared in a C-like manner.
Cのような形式で宣言された引数
.IR args
で
.IR function_name
を実行した結果の型
.IR rettype
を持つ
.IR macro_name
という名前の関数への関数のプロトタイプを定義します。
.TP
.BR "define macro" " macro_name " "from file" " filename"
.\" Define a macro named
.\" .IR macname
.\" which has its value 
.\" read from the file called
.\" .IR filename .
.IR filename
というファイルから読まれる
.IR macname
という名前のマクロを定義します。
.\" .uh "DEBUGGING COMMANDS"
.\" .sp
.\" .in .5i
.\" r
.\" .br
.\" Randomly print the open class.
.\" .sp
.\" m   -1
.\" .br
.\" Toggle display of time information.
.\" .sp
.\" m   0
.\" .br
.\" Set retrievals to now.
.\" .sp
.\" m   1 Jan 1 01:00:00 1988
.\" .br
.\" Set retrievals to snapshots of the specfied time.
.\" .sp
.\" m   2 Jan 1 01:00:00 1988, Feb 1 01:00:00 1988
.\" .br
.\" Set retrievals to ranges of the specified times.
.\" Either time may be replaced with space
.\" if an unbounded time range is desired.
.\" .sp
.\" \&.A    classname natts name1 type1 name2 type2 ...
.\" .br
.\" Add attributes named
.\" .ul
.\" name1,
.\" .ul
.\" name2,
.\" etc. of
.\" types
.\" .ul
.\" type1,
.\" .ul
.\" type2,
.\" etc. to the
.\" .ul
.\" class
.\" classname.
.\" .sp
.\" \&.RR   oldclassname newclassname
.\" .br
.\" Rename the
.\" .ul
.\" oldclassname
.\" class to
.\" .ul
.\" newclassname.
.\" .sp
.\" \&.RA   classname oldattname newattname
.\" .br
.\" Rename the
.\" .ul
.\" oldattname
.\" attribute in the class named
.\" .ul
.\" classname
.\" to
.\" .ul
.\" newattname.
.SH 例
.\" The following set of commands will create the \*(lqpg_opclass\*(rq
.\" class containing the
.\" .IR int_ops
.\" collection as object
.\" .IR 421,
.\" print out the class, and then close it.
つぎのコマンド群は、
.IR 421
のオブジェクトとして
.IR int_ops
のコレクションを含む\*(lqpg_opclass\*(rqクラス
を生成し、
クラスを出力して、クローズします。
.nf
create pg_opclass (opcname=char16)
open pg_opclass
insert oid=421 (int_ops)
print
close pg_opclass
.fi
.SH 参照
initdb(1),
createdb(1),
create_database(l).