クライアントインタフェース

PostgreSQL 8.4.1文書
前のページ | 巻戻し | 第 31章ラージオブジェクト | 早送り | 次のページ

# 31.3. クライアントインタフェース

本節では、PostgreSQLクライアントインタフェースライブラリで提供されるラージオブジェクトへのアクセス手段について説明します。 これらの関数を使用したラージオブジェクトの操作は全てSQLトランザクションブロック内で行われなければなりません PostgreSQLラージオブジェクトインタフェースは、Unixファイルシステムインタフェースに因んで設計されており、`open`、`read`、`write`、`lseek`など同様のインタフェースを有しています。

libpqのラージオブジェクトインタフェースを使用するクライアントアプリケーションは、`libpq/libpq-fs.h`ヘッダファイルをインクルードし、libpqライブラリとリンクしなければなりません。

## 31.3.1. ラージオブジェクトの作成

    Oid lo_creat(PGconn *conn, int mode);

この関数はラージオブジェクトを新規に作成します。 戻り値は新規ラージオブジェクトに割り当てられたOIDで、失敗時には`InvalidOid`（0）が返されます。 PostgreSQL 8.1では、`mode`は使用されず、無視されます。 しかし、以前のリリースとの後方互換性を保持するために、これを`INV_READ`、`INV_WRITE`、`INV_READ` `|` `INV_WRITE`に設定することが最善です。 （これらの定数シンボルは`libpq/libpq-fs.h`ヘッダファイルで定義されています。）

以下に例を示します。

    inv_oid = lo_creat(conn, INV_READ|INV_WRITE);

    Oid lo_create(PGconn *conn, Oid lobjId);

この関数もラージオブジェクトを新規に作成します。 割り当てられるOIDを`lobjId`で指定することができます。 こうした場合、そのOIDが他のラージオブジェクトですでに使用されていた場合、失敗します。 `lobjId`が`InvalidOid`（0）の場合、`lo_create`は未使用のOIDを割り当てます。 （これは`lo_creat`と同じ動作です。） 戻り値は新規ラージオブジェクトに割り当てられたOIDで、失敗時には`InvalidOid`（0）が返されます。

`lo_create`はPostgreSQL 8.1から導入されました。 この関数を古いバージョンで実行させると失敗し、`InvalidOid`が返されます。

例を示します。

    inv_oid = lo_create(conn, desired_oid);

## 31.3.2. ラージオブジェクトのインポート

オペレーティングシステム上のファイルをラージオブジェクトとしてインポートするには、以下の関数を呼び出します。

    Oid lo_import(PGconn *conn, const char *filename);

`filename`には、ラージオブジェクトとしてインポートするオペレーティングシステム上のファイルのパス名を指定します。 戻り値は、新規ラージオブジェクトに割り当てられたOIDです。 失敗時は`InvalidOid`（0）が返されます。 このファイルがサーバではなく、クライアントインタフェースライブラリから読み取られることに注意してください。 ですから、このファイルはクライアントのファイルシステム上に存在し、クライアントアプリケーションから読み取り可能でなければなりません。

    Oid lo_import_with_oid(PGconn *conn, const char *filename, Oid lobjId);

この関数も新規のラージオブジェクトをインポートします。 割り当てられるOIDを`lobjId`で指定することができます。 こうした場合、そのOIDが他のラージオブジェクトですでに使用されていた場合、失敗します。 `lobjId` が`InvalidOid`（0）の場合、`lo_import_with_oid`は未使用のOIDを割り当てます。 （これは`lo_import`と同じ動作です。） 戻り値は新規ラージオブジェクトに割り当てられたOIDで、失敗時には`InvalidOid`（0）が返されます。

`lo_import_with_oid`はPostgreSQL 8.4から導入され、 8.1から導入された`lo_create`を内部で使用しています。 この関数を8.0以前のバージョンで実行させると失敗し、`InvalidOid`が返されます。

## 31.3.3. ラージオブジェクトのエクスポート

ラージオブジェクトをオペレーティングシステム上のファイルにエクスポートするには、以下の関数を呼び出します。

    int lo_export(PGconn *conn, Oid lobjId, const char *filename);

`lobjId`引数には、エクスポートさせるラージオブジェクトのOIDを指定し、`filename`引数には、オペレーティングシステム上のファイルのパス名を指定します。 このファイルはサーバではなく、クライアントインタフェースライブラリによって書き込まれることに注意してください。 成功時には1、失敗時には-1が返されます。

## 31.3.4. 既存のラージオブジェクトのオープン

読み取りまたは書き込みのために既存のラージオブジェクトを開く場合は、以下の関数を呼び出します。

    int lo_open(PGconn *conn, Oid lobjId, int mode);

`lobjId`引数には開きたいラージオブジェクトのOIDを指定します。 `mode`の各ビットは、そのオブジェクトを読み取りのみ（`INV_READ`）、書き込みのみ（`INV_WRITE`）、またはその両方できるように開くのかを制御するものです。 （これらの定数シンボルは`libpq/libpq-fs.h`ヘッダファイルで定義されています。） 作成していないラージオブジェクトを開くことはできません。 `lo_open`は、`lo_read`、`lo_write`、`lo_lseek`、`lo_tell`、`lo_close`で使用する（非負の）ラージオブジェクト記述子を返します。 この記述子は現在のトランザクション期間のみで有効です。 失敗時には-1が返されます。

現時点では、サーバは`INV_WRITE`モード、`INV_READ` `|` `INV_WRITE`モードとを区別しません。 どちらの場合でも記述子から読み取り可能です。 しかし、これらのモードと`INV_READ`だけのモードとの間には大きな違いがあります。 `INV_READ`モードでは記述子に書き込むことができません。 そして、読み込んだデータは、このトランザクションや他のトランザクションで後で書き込んだかどうかは関係なく、`lo_open`を実行した時に有効だったトランザクションスナップショットの時点のラージオブジェクトの内容を反映したものになります。 `INV_WRITE`を付けて開いた記述子から読み取ると、現在のトランザクションによる書き込みや他のトランザクションがコミットした書き込みすべてを反映したデータが返されます。 これは、通常の`SELECT` SQLコマンドにおける`SERIALIZABLE`トランザクションの動作と`READ COMMITTED`トランザクションの動作の違いに似ています。

以下に例を示します。

    inv_fd = lo_open(conn, inv_oid, INV_READ|INV_WRITE);

## 31.3.5. ラージオブジェクトへのデータの書き込み

    int lo_write(PGconn *conn, int fd, const char *buf, size_t len);

この関数は、`len`長のバイトを、`buf`から`fd`ラージオブジェクト記述子に書き込みます。 `fd`引数は事前に実行した`lo_open`の戻り値でなければいけません。 実際に書き込まれたバイト数が返されます。 エラーが発生した場合は、負の値を返します。

## 31.3.6. ラージオブジェクトからのデータの読み込み

    int lo_read(PGconn *conn, int fd, char *buf, size_t len);

この関数は、`len`長のバイトを、`fd`ラージオブジェクト記述子から`buf`に読み込みます。 `fd`引数は事前に実行した`lo_open`の戻り値でなければいけません。 実際に読み込まれたバイト数が返されます。 エラーが発生した場合は、負の値を返します。

## 31.3.7. ラージオブジェクトのシーク

ラージオブジェクト記述子に関連付けされている、現在の読み取りまたは書き込みを行う位置を変更するには、以下の関数を呼び出します。

    int lo_lseek(PGconn *conn, int fd, int offset, int whence);

この関数は`fd`で識別されるラージオブジェクト識別子の現在の位置を指すポインタを、`offset`で指定した新しい位置に変更します。 `whence`に指定可能な値は、`SEEK_SET`（オブジェクトの先頭位置からシーク）、`SEEK_CUR`（現在位置からシーク）、`SEEK_END`（オブジェクトの末尾位置からシーク）のいずれかです。 戻り値は新しい位置ポインタで、エラー時に-1が返されます。

## 31.3.8. ラージオブジェクトのシーク位置の入手

ラージオブジェクト記述子の現在の読み取り、書き込み位置を入手するには、以下の関数を呼び出します。

    int lo_tell(PGconn *conn, int fd);

エラーが発生した場合は負の値が返されます。

## 31.3.9. ラージオブジェクトを切り詰める

ラージオブジェクトを指定した長さに切り詰めるには、以下を呼び出します。

    int lo_truncate(PGcon *conn, int fd, size_t len);

これはラージオブジェクト記述子`fd`を`len`長に切り詰めます。 `fd`引数は前もって`lo_open`が返したものでなければなりません。 `len`が現在のラージオブジェクト長より大きければ、ラージオブジェクトはヌルバイト('\0')で拡張されます。

ファイルのオフセットは変わりません。

成功時`lo_truncate`は0を返します。 エラー時は負の値を返します。

`lo_truncate`はPostgreSQL 8.3で新規に導入されました。 この関数を古いバージョンのサーバに対して実行した場合は失敗し、負の値が返されます。

## 31.3.10. ラージオブジェクト記述子を閉じる

以下を呼び出すことでラージオブジェクト記述子を閉ざすことができます。

    int lo_close(PGconn *conn, int fd);

ここで、`fd`は`lo_open`の戻り値であるラージオブジェクト記述子です。 成功すると、`lo_close`は0を返します。 失敗すると、負の値を返します。

開いたままのラージオブジェクト記述子は全てトランザクションの終了時に自動的に閉ざされます。

## 31.3.11. ラージオブジェクトの削除

データベースからラージオブジェクトを削除するには、以下の関数を呼び出します。

    int lo_unlink(PGconn *conn, Oid lobjId);

`lobjId`引数は削除するラージオブジェクトのOIDを指定します。 成功時に1を、失敗時に-1を返します。

前のページ | ホーム | 次のページ
実装機能 | 上に戻る | サーバ側の関数