Blob クラス

Blobクラスは、BLOB型オブジェクトの共通プロパティを定義します。BLOBは、データベース表の行の列値として格納されるラージ・バイナリ・オブジェクトです。Blobオブジェクトには、BLOBへの論理ポインタが含まれていますが、BLOB自体は含まれていません。

Blobクラスのメソッドを使用すると、Blobオブジェクトに関連する特定のタスクを実行できます。

getBlob()やsetBlob()など、ResultSetクラスとStatementクラスのメソッドによって、SQL BLOBの値にアクセスできます。

NULLのBlobオブジェクトに対する有効なメソッドは、setName()、isNull()およびoperator=()のみです。

未初期化のBlobオブジェクトは、次の方法で初期化できます。

setEmpty()メソッドを実行します。次に、このBLOBを表に挿入してBLOBを変更すると、SELECT...FOR UPDATEを使用してその内容を取り出すことができます。write()メソッドによってBLOBは変更されますが、変更されたデータは、トランザクションがコミットされたときにのみ表にフラッシュされます。UPDATEは必要ありません。
初期化したBlobオブジェクトを割り当てます。

メソッド	概要
Blob()	`Blob`クラスのコンストラクタです。
append()	指定した`BLOB`を現行の`BLOB`の最後に追加します。
close()	前にオープンした`BLOB`をクローズします。
closeStream()	`BLOB`から取得した`Stream`オブジェクトをクローズします。
copy()	`BFILE`または`BLOB`の指定部分を現行の`BLOB`にコピーします。
getChunkSize()	`BLOB`への効率的な書込みを実行するための最小データ・サイズを戻します。
getContentType()	`Blob`のコンテンツ・タイプを戻します。
getOptions()	指定した`LobOptionType`に対する`BLOB`の`LobOptionValue`を戻します。
getStream()	`Stream`オブジェクトとして`BLOB`からデータを戻します。
isInitialized()	`Blob`オブジェクトが初期化されているかどうかを確認します。
isNull()	`Blob`オブジェクトがアトミック`NULL`かどうかをテストします。
isOpen()	`BLOB`がオープンしているかどうかを確認します。
length()	`BLOB`のバイト数を戻します。
open()	`BLOB`を読取り専用または読取り/書込みアクセスでオープンします。
operator=()	`BLOB`ロケータを`Blob`オブジェクトに割り当てます。
operator==()	2つの`Blob`オブジェクトが等しいかどうかを確認します。
operator!=()	2つの`Blob`オブジェクトが等しくないかどうかを確認します。
read()	`BLOB`の一部をバッファに読み取ります。
setContentType()	`Blob`のコンテンツ・タイプを設定します。
setEmpty()	`Blob`オブジェクトを空に設定します。
setNull()	`Blob`オブジェクトをアトミック`NULL`に設定します。
setOptions()	特定の`LobOptionType`に対して`LobOptionValue`を指定します。`BLOB`の高度な圧縮、暗号化および重複除外を有効化します。
trim()	`BLOB`を指定した長さに切り捨てます。
write()	バッファをオープンされていない`BLOB`に書き込みます。
writeChunk()	バッファをオープンされている`BLOB`に書き込みます。

Blob()

Blobクラスのコンストラクタです。

構文	説明
Blob();	`NULL`の`Blob`オブジェクトを作成します。
Blob( const Connection *connectionp);	未初期化の`Blob`オブジェクトを構築します。
Blob( const Blob &srcBlob);	`Blob`オブジェクトのコピーを作成します。

パラメータ	説明
connectionp	接続ポインタを指定します。
srcBlob	コピー元の`Blob`オブジェクトを指定します。

append()

BLOBを現行のBLOBの最後に追加します。

構文

void append(
   const Blob &srcBlob);

パラメータ	説明
srcBlob	現行の`BLOB`オブジェクトに追加する`BLOB`オブジェクトを指定します。

close()

BLOBをクローズします。

構文

void close();

closeStream()

BLOBから取得したStreamオブジェクトをクローズします。

構文

void closeStream(
   Stream *stream);

パラメータ	説明
stream	クローズする`Stream`を指定します。

copy()

BFILEまたはBLOBの一部またはすべてを現行のBLOBにコピーします。

構文説明

構文	説明
void copy( const Bfile &srcBfile, unsigned int numBytes, unsigned int dstOffset = 1, unsigned int srcOffset = 1);	`BFILE`の一部を現行の`BLOB`にコピーします。
void copy( const Blob &srcBlob, unsigned int numBytes, unsigned int dstOffset = 1, unsigned int srcOffset = 1);	`BLOB`の一部を現行の`BLOB`にコピーします。コピー先の`BLOB`が重複除外に対応しており、コピー元およびコピー先の`BLOB`が同じ列内にある場合、新規`BLOB`がコピー・オン・ライトとして作成されます。コピー元の`BLOB`から他のすべての設定が継承されます。コピー先の`BLOB`が重複除外に対応していない場合、`BLOB`の完全に新しいコピーとなります。

void copy(
   const Bfile &srcBfile,
   unsigned int numBytes,
   unsigned int dstOffset = 1,
   unsigned int srcOffset = 1);

BFILEの一部を現行のBLOBにコピーします。

void copy(
   const Blob &srcBlob,
   unsigned int numBytes,
   unsigned int dstOffset = 1,
   unsigned int srcOffset = 1);

BLOBの一部を現行のBLOBにコピーします。

コピー先のBLOBが重複除外に対応しており、コピー元およびコピー先のBLOBが同じ列内にある場合、新規BLOBがコピー・オン・ライトとして作成されます。コピー元のBLOBから他のすべての設定が継承されます。コピー先のBLOBが重複除外に対応していない場合、BLOBの完全に新しいコピーとなります。

パラメータ	説明
srcBfile	データのコピー元の`BFILE`を指定します。
srcBlob	データのコピー元の`BLOB`を指定します。
numBytes	ソース`BFILE`またはソース`BLOB`からコピーするバイト数を指定します。有効な値は0 (ゼロ)以上の数値です。
dstOffset	現行の`BLOB`に書き込むデータの開始位置を指定します。有効な値は、1以上の数値です。
srcOffset	ソース`BFILE`またはソース`BLOB`から読み取るデータの開始位置を指定します。有効な値は、1以上の数値です。

getChunkSize()

BLOBへの効率的な書込みを実行するための最小データ・サイズを戻します。

構文

unsigned int getChunkSize() const;

getContentType()

Blobのコンテンツ・タイプを戻します。コンテンツ・タイプが割り当てられていない場合は、NULL文字列を戻します。

構文

string getContentType();

getOptions()

指定したLobOptionTypeに対するBLOBのLobOptionValueを戻します。

BLOBが格納されたデータベース列またはパーティションに対して設定されていないオプションの値を取得しようとすると、例外が発生します。

構文

LobOptionValue getOptions(
   LobOptionType optType);

パラメータ	説明
optType	要求される`LobOptionType`の設定です。これらの設定は、サーバーのラウンドトリップを避けるために、ビット単位の`or` (`\|`)を使用して結合できます。表7-1「LobOptionType型の値」および表7-2「LobOptionValue型の値」を参照してください。

getStream()

BLOBからStreamオブジェクトを戻します。ストリームがオープンしている場合、別のストリームをBlobオブジェクトでオープンすることはできません。したがって、ユーザーは、Blobオブジェクト操作を実行する前に、ストリームを常にクローズする必要があります。

構文

Stream* getStream(
   unsigned int offset = 1,
   unsigned int amount = 0);

パラメータ	説明
offset	`BLOB`から読み取るデータの開始位置を指定します。`offset`が未指定の場合、データは`BLOB`の最初から書き込まれます。有効な値は、`1`以上の数値です。
amount	`BLOB`から読み取るバイトの合計数を指定します。`amount`が`0` (ゼロ)の場合は、入力`offset`の位置から`BLOB`の終わりまでのデータがストリーム・モードで読み取られます。

isInitialized()

Blobオブジェクトが初期化されているかどうかを確認します。Blobオブジェクトが初期化されている場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

bool isInitialized() const;

isNull()

BlobオブジェクトがアトミックNULLかどうかをテストします。BlobオブジェクトがアトミックNULLの場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

bool isNull() const;

isOpen()

BLOBがオープンしているかどうかを確認します。BLOBがオープンしている場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

bool isOpen() const;

length()

BLOBのバイト数を戻します。

構文

unsigned int length() const;

open()

BLOBを読取り/書込みまたは読取り専用モードでオープンします。

構文

void open(
   LobOpenMode mode = OCCI_LOB_READWRITE);

パラメータ	説明
mode	`BLOB`をオープンするモードを指定します。次の値が有効です。 `OCCI_LOB_READWRITE` `OCCI_LOB_READONLY`

operator=()

現行のBLOBにBLOBを割り当てます。割当て元BLOBは、割当て先BLOBが表に格納されているときにのみ、その割当て先BLOBにコピーされます。

構文

Blob& operator=(
   const Blob &srcBlob);

パラメータ	説明
srcBlob	データのコピー元の`BLOB`を指定します。

operator==()

2つのBlobオブジェクトを比較して、等しいかどうかを調べます。2つのBlobオブジェクトが同じBLOBを参照している場合、それらのオブジェクトは等しいと判断されます。2つのBlobオブジェクトがNULLの場合は、等しいとは判断されません。Blobオブジェクトが等しい場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

bool operator==(
   const Blob &srcBlob) const;

パラメータ	説明
srcBlob	現行の`BLOB`と比較するソース`BLOB`を指定します。

operator!=()

2つのBlobオブジェクトを比較して、等しくないかどうかを調べます。2つのBlobオブジェクトが同じBLOBを参照している場合、それらのオブジェクトは等しいと判断されます。2つのBlobオブジェクトがNULLの場合は、等しいとは判断されません。2つのBlobオブジェクトが等しくない場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

bool operator!=(
   const Blob &srcBlob) const;

パラメータ	説明
srcBlob	現行の`BLOB`と比較するソース`BLOB`を指定します。

read()

BLOBの一部またはすべてをバッファに読み取ります。実際に読み取られたバイト数が戻ります。

構文

unsigned int read(
   unsigned int amt,
   unsigned char *buffer,
   unsigned int bufsize,
   unsigned int offset = 1) const;

パラメータ	説明
amt	読み取るバイト数を指定します。有効な値は、`1`以上の数値です。
buffer	`BLOB`データを読み取るバッファを指定します。有効な値は、`amt`以上の数値です。
buffsize	`BLOB`データを読み取るバッファのサイズを指定します。有効な値は、`amt`以上の数値です。
offset	`BLOB`から読み取るデータの開始位置を指定します。`offset`が未指定の場合、データは`BLOB`の最初から書き込まれます。

setContentType()

Blobのコンテンツ・タイプを設定します。BlobがSecureFileでない場合は、例外が発生します。

構文

void setContentType(
   const string contenttype);

パラメータ	説明
contenttype	`Blob`のコンテンツ・タイプを指定します。ASCII Mime対応の文字列です。

setEmpty()

Blobオブジェクトを空に設定します。

構文	説明
void setEmpty();	`Blob`オブジェクトを空に設定します。
void setEmpty( const Connection* connectionp);	`Blob`オブジェクトを空に設定し、渡されたパラメータへの接続ポインタを初期化します。

パラメータ	説明
connectionp	`BLOB`オブジェクトの新しい接続ポインタを指定します。

setNull()

BlobオブジェクトをアトミックNULLに設定します。

構文

void setNull();

setOptions()

特定のLobOptionTypeに対してLobOptionValueを指定します。BLOBの高度な圧縮、暗号化および重複除外を有効化します。表7-1「LobOptionType型の値」および表7-2「LobOptionValue型の値」を参照してください。

BLOBが格納されたデータベース列またはパーティションに対して設定されていないオプションを設定または設定解除しようとすると、例外が発生します。

暗号化されたBLOB列で暗号化をオフにしようとすると、例外が発生します。

構文

void setOptions(
   LobOptionType optType,
   LobOptionValue optValue);

パラメータ	説明
optType	指定されている`LobOptionType`の設定です。これらの設定は、サーバーのラウンドトリップを避けるために、ビット単位の`or` (`\|`)を使用して結合できます。
optValue	`optType`パラメータで指定された`LobOptionType`の`LobOptionValue`設定です。

trim()

BLOBを新しく指定した長さに切り捨てます。

構文

void trim(
   unsigned int newlen);

パラメータ	説明
newlen	`BLOB`の新しい長さを指定します。有効な値は、`BLOB`の現在の長さ以下の数値です。

write()

バッファのデータをBLOBに書き込みます。このメソッドは、BLOBを暗黙的にオープンしてバッファのデータをBLOBにコピーし、BLOBを暗黙的にクローズします。BLOBがオープンしている場合は、かわりにwriteChunk()を使用します。実際に書き込まれたバイト数が戻ります。

構文

unsigned int write(
   unsigned int amt,
   unsigned char *buffer,
   unsigned int bufsize,
   unsigned int offset = 1);

パラメータ	説明
amt	`BLOB`に書き込むバイト数を指定します。
buffer	`BLOB`に書き込むデータが含まれているバッファを指定します。
buffsize	`BLOB`に`書き込むデータが含まれているバッファ`のサイズを指定します。有効な値は、`amt`以上の数値です。
offset	`BLOB`に書き込むデータの開始位置を指定します。`offset`が未指定の場合、データは`BLOB`の最初から書き込まれます。有効な値は、1以上の数値です。

writeChunk()

バッファのデータを前にオープンしたBLOBに書き込みます。実際に書き込まれたバイト数が戻ります。

構文

unsigned int writeChunk(
   unsigned int amount,
   unsigned char *buffer,
   unsigned int bufsize,
   unsigned int offset = 1);

パラメータ	説明
amt	`BLOB`に書き込むバイト数を指定します。
buffer	`BLOB`に書き込むデータが含まれているバッファを指定します。
buffsize	`BLOB`に書き込むデータが含まれているバッファのサイズを指定します。有効な値は、`amt`以上の数値です。
offset	`BLOB`に書き込むデータの開始位置を指定します。`offset`が未指定の場合、データは`BLOB`の最初から書き込まれます。有効な値は、`1`以上の数値です。

Blobクラス