PolarDB:DBMS_LOB

APPEND ストアドプロシージャは、ラージオブジェクトを別のオブジェクトに追加するために使用されます。 2 つのラージオブジェクトのデータ型は同じである必要があります。

APPEND(dest_lob IN OUT { BLOB | CLOB }, src_lob { BLOB | CLOB })

表3. パラメーター

パラメーター	説明
destロブ	追加先のラージオブジェクトの場所を指定します。 dest_lobパラメーターのデータ型は、src_lobパラメーターのデータ型と同じである必要があります。
srcロブ	追加するラージオブジェクトの場所を指定します。 src_lobパラメーターのデータ型は、dest_lobパラメーターのデータ型と同じである必要があります。

COMPARE関数は、指定された長さの指定されたオフセットで2つの大きなオブジェクトを比較します。 比較される 2 つのラージオブジェクトのデータ型は同じである必要があります。

ステータスINTEGER COMPARE(lob_1 { BLOB | CLOB} 、
  lob_2 { BLOB | CLOB }
  [, amount INTEGER [, offset_1 INTEGER [, offset_2 INTEGER ]]]) 

表4. パラメーター

パラメーター	説明
lob_1	最初のラージオブジェクトの場所を指定します。 lob_1パラメーターのデータ型は、lob_2パラメーターのデータ型と同じである必要があります。
lob_2	2 番目のラージオブジェクトの場所を指定します。 lob_2パラメーターのデータ型は、lob_1パラメーターのデータ型と同じである必要があります。
amount	ラージオブジェクトのデータ型がBLOBの場合、オブジェクトのバイト数が比較されます。 ラージオブジェクトのデータ型がCLOBの場合、オブジェクトの文字数が比較されます。 amount パラメーターのデフォルト値は、ラージオブジェクトの最大サイズです。
offset 1	比較を開始する最初のラージオブジェクト内の位置を指定します。 デフォルト値は 1 です。
offset_2	比較を開始する 2 番目のラージオブジェクト内の位置を指定します。 デフォルト値は 1 です。
status	比較結果を指定します。 2つの大きなオブジェクトが指定された長さ内の指定されたオフセットで同じである場合、0が返されます。 オブジェクトが同じでない場合は、ゼロ以外の値が返されます。 amount、offset_1、またはoffset_2パラメーターの値が0より小さい場合、NULLが返されます。

CONVERTTOBLOB ストアドプロシージャは、CLOB データ型のラージオブジェクトを BLOB データ型のラージオブジェクトに変換するために使用されます。

CONVERTTOBLOB(dest_lob IN OUT BLOB, src_clob CLOB,
  amount INTEGER, dest_offset IN OUT INTEGER,
  src_offset IN OUT INTEGER, blob_csid NUMBER,
  lang_context IN OUT INTEGER、警告OUT INTEGER) 

表5. パラメーター

パラメーター	説明
destロブ	BLOB データ型の変換先のラージオブジェクトを指定します。
srcクロブ	CLOB データ型の変換先のラージオブジェクトを指定します。
amount	src_clobパラメーターで指定したラージオブジェクトで変換する文字数を指定します。
dest_offset IN	書き込み操作を開始するターゲットラージオブジェクト内のバイトの位置を指定します。
dest_offset OUT	書き込み操作が完了した後のターゲットのラージオブジェクト内のバイト位置を指定します。
srcオフセットIN	変換が開始される変換元のラージオブジェクト内の文字の場所を指定します。
src_offset OUT	変換が完了した後の変換元のラージオブジェクト内の文字の位置を指定します。
ブロブcsid	変換先のラージオブジェクトの文字セット ID を指定します。
langcontext IN	変換の言語環境を指定します。 通常はデフォルト値0が使用されます。
langcontext OUT	変換が完了した後の言語環境を指定します。
warning	変換が成功した場合、0 が返されます。 変換が失敗した場合、1 が返されます。

CONVERTTOCLOB ストアドプロシージャは、BLOB データ型のラージオブジェクトを CLOB データ型のラージオブジェクトに変換するために使用されます。

CONVERTTOCLOB(dest_lob IN OUT CLOB, src_blob BLOB,
  amount INTEGER, dest_offset IN OUT INTEGER,
  src_offset IN OUT INTEGER, blob_csid NUMBER,
  lang_context IN OUT INTEGER、警告OUT INTEGER) 

表6. パラメーター

パラメーター	説明
destロブ	CLOB データ型の変換先のラージオブジェクトを指定します。
src_blob	BLOB データ型の変換元のラージオブジェクトを指定します。
amount	src_blobパラメーターで指定したラージオブジェクトで変換するバイト数を指定します。
dest_offset IN	書き込み操作を開始する対象のラージオブジェクト内の文字の位置を指定します。
dest_offset OUT	書き込み操作が完了した後のターゲットラージオブジェクト内の文字の位置を指定します。
srcオフセットIN	変換が開始される変換元のラージオブジェクトのバイト位置を指定します。
src_offset OUT	変換が完了した後の変換元のラージオブジェクト内のバイト位置を指定します。
ブロブcsid	変換先のラージオブジェクトの文字セット ID を指定します。
CLOB。 langcontext IN	変換の言語環境を指定します。 通常はデフォルト値0が使用されます。
langcontext OUT	変換が完了した後の言語環境を指定します。
warning	変換が成功した場合、0 が返されます。 変換が失敗した場合、1 が返されます。

COPY ストアドプロシージャは、ラージオブジェクトを別のオブジェクトにコピーするために使用されます。 コピー元のラージオブジェクトとコピー先のラージオブジェクトのデータ型は同じである必要があります。

COPY(dest_lob IN OUT { BLOB | CLOB }, src_lob)
{BLOB | CLOB} 、
  amount INTEGER
  [, dest_offset INTEGER [, src_offset INTEGER ]]) 

表7. パラメーター

パラメーター	説明
destロブ	コピー元のラージオブジェクトのコピー先となるコピー先のラージオブジェクトの場所を指定します。 このパラメーターのデータ型は、src_lobパラメーターのデータ型と同じである必要があります。
srcロブ	コピーするターゲットのラージオブジェクトの場所を指定します。 このパラメーターのデータ型は、dest_lobパラメーターのデータ型と同じである必要があります。
amount	src_lobパラメーターで指定したラージオブジェクトにコピーするバイト数または文字数を指定します。
destオフセット	コピー元のラージオブジェクトの書き込みを開始するターゲットのラージオブジェクト内の場所を指定します。 デフォルト値は 1 です。
srcオフセット	コピー操作が開始されるコピー元のラージオブジェクト内の文字の位置を指定します。 デフォルト値は 1 です。

ERASEストアドプロシージャは、ラージオブジェクト内のデータの一部を消去するために使用されます。 BLOB データ型のラージオブジェクトの場合、指定された部分は 0 バイトのフィルターに置き換えられます。 CLOB データ型のラージオブジェクトの場合、指定された部分はスペースで置き換えられます。 この操作では、ラージオブジェクトのサイズは変更されません。

ERASE(lob_loc IN OUT { BLOB | CLOB} 、金額IN OUT INTEGER)
  [, オフセットINTEGER ]) 

表8. パラメーター

パラメーター	説明
ロブloc	削除するラージオブジェクトを指定します。
amount IN	ラージオブジェクトで消去するバイト数または文字数を指定します。
amount OUT	消去されたバイト数または文字数を指定します。 指定されたバイト数または文字数が消去される前にラージオブジェクトの終わりに到達した場合、出力値は入力値よりも小さくなります。
offset	ラージオブジェクト内で消去操作を開始する場所を指定します。 デフォルト値は 1 です。

GET_STORAGE_LIMIT 関数は、ラージオブジェクトが使用できる最大ストレージスペースを取得するために使用されます。

サイズINTEGET_STORAGE_LIMIT (lob_loc BLOB)

サイズINTEGET_STORAGE_LIMIT (lob_loc CLOB) 

表9. パラメーター

パラメーター	説明
size	データベースのラージオブジェクトが使用できる最大ストレージ領域を指定します。
ロブloc	このパラメーターは、Oracle データベースとの互換性を確保するために提供されており、実行時に無視することができます。

GETLENGTH 関数は、ラージオブジェクトの長さを取得するために使用されます。

量INTEGER GETLENGTH(lob_loc BLOB)

金額INTEGER GETLENGTH(lob_loc CLOB) 

表10. パラメーター

パラメーター	説明
ロブloc	ラージオブジェクトの名前を指定します。
amount	ラージオブジェクトの長さを指定します。 BLOB データ型のラージオブジェクトの場合、長さはバイト単位で測定されます。 CLOB データ型のラージオブジェクトの場合、長さは文字数で測定されます。

INSTR関数は、指定されたパターンがラージオブジェクト内で指定されたn回目に現れる位置を取得するために使用されます。

position INTEGER INSTR(lob_loc { BLOB | CLOB },
  pattern { RAW | VARCHAR2 } [, offset INTEGER [, nth INTEGER ]]) 

表11. パラメーター

パラメーター	説明
ロブloc	ラージオブジェクトの名前を指定します。
pattern	ラージオブジェクトで照合するパターンを指定します。 パターンは、バイトまたは文字の組み合わせです。 lob_locパラメーターで指定されたラージオブジェクトのデータ型がBLOBの場合、パターンのデータ型はRAWでなければなりません。 lob_locパラメーターで指定されたラージオブジェクトのデータ型がCLOBの場合、パターンのデータ型はVARCHAR2でなければなりません。
offset	lob_locパラメーターで指定したラージオブジェクト内のパターンの検索を開始する位置を指定します。 最初のバイトまたは文字がオフセット 1 としてラベル付けされます。 デフォルト値は 1 です。
nth	指定されたパターンが指定されたオフセットから表示されるn回目を指定します。 デフォルト値は 1 です。
position	指定されたパターンがラージオブジェクト内で指定されたn回目に表示される位置を指定します。 指定したオフセットから検索が開始されます。

READストアドプロシージャは、大きなオブジェクトのデータの一部をバッファに読み込むために使用されます。

READ(lob_loc { BLOB | CLOB} 、INOUT BINARY_INTEGER、
  オフセットINTEGER、バッファOUT { RAW | VARCHAR2 }) 

表12. パラメーター

パラメーター	説明
ロブloc	読み込むラージオブジェクトを指定します。
amount IN	読み取るバイトまたは文字の総数を指定します。
amount OUT	読み取られたバイト数または文字数の合計を指定します。 読み取りに使用できるデータがもうない場合、0が返され、DATA_NOT_FOUND例外がスローされます。
offset	ラージオブジェクト内で読み取り操作を開始する場所を指定します。 最初のバイトまたは文字がオフセット 1 としてラベル付けされます。
buffer	ラージオブジェクト内のデータの一部を受け取る変数を指定します。 lob_locパラメーターのデータ型がBLOBの場合、bufferパラメーターのデータ型はRAWでなければなりません。 lob_locパラメーターのデータ型がCLOBの場合、bufferパラメーターのデータ型はVARCHAR2でなければなりません。

SUBSTR関数は、ラージオブジェクト内のデータの一部を取得するために使用されます。

データ {RAW | VARCHAR2 } SUBSTR(lob_loc { BLOB | CLOB})
  [, amount INTEGER [, offset INTEGER ]]) 

表13. パラメーター

パラメーター	説明
ロブloc	読み込むラージオブジェクトを指定します。
amount	返されるバイト数または文字数を指定します。 デフォルト値: 32,767
offset	ラージオブジェクト内で読み取り操作を開始する場所を指定します。 最初のバイトまたは文字がオフセット 1 としてラベル付けされます。 デフォルト値は 1 です。
data	ラージオブジェクトの取得された部分を指定します。 lob_locパラメーターのデータ型がBLOBの場合、dataパラメーターのデータ型はRAWでなければなりません。 lob_locパラメーターのデータ型がCLOBの場合、dataパラメーターのデータ型はVARCHAR2でなければなりません。

TRIM ストアドプロシージャは、ラージオブジェクトを指定した長さにトリミングするために使用されます。

トリム (lob_loc IN OUT { BLOB | CLOB} 、newlen INTEGER)

表14. パラメーター

パラメーター	説明
ロブloc	トリミングするラージオブジェクトを指定します。
newlen	トリミングするラージオブジェクトの合計バイト数または文字数を指定します。

WRITE ストアドプロシージャは、ラージオブジェクトにデータを書き込むために使用されます。 指定された長さ内の指定されたオフセットから始まるラージオブジェクトからのデータは、バッファ内のデータによって上書きされる。

WRITE(lob_loc IN OUT { BLOB | CLOB} 、
  amount BINARY_INTEGER,
  オフセットINTEGER、バッファ {RAW | VARCHAR2 }) 

表15. パラメーター

パラメーター	説明
ロブloc	書き込まれるラージオブジェクトを指定します。
amount	ラージオブジェクトに書き込むバッファ内のバイト数または文字数を指定します。
offset	書き込み操作を開始するラージオブジェクト内のバイトまたは文字の位置を指定します。
buffer	ラージオブジェクトの取得された部分を指定します。 lob_locパラメーターのデータ型がBLOBの場合、bufferパラメーターのデータ型はRAWでなければなりません。 lob_locパラメーターのデータ型がCLOBの場合、bufferパラメーターのデータ型はVARCHAR2でなければなりません。

WRITEAPPEND ストアドプロシージャは、ラージオブジェクトの最後にデータを追加するために使用されます。

WRITEAPPEND(lob_loc IN OUT { BLOB | CLOB} 、
  金額BINARY_INTEGER, buffer { RAW | VARCHAR2 }) 

表16. パラメーター

パラメーター	説明
ロブloc	データを追加するラージオブジェクトを指定します。
amount	ラージオブジェクトの最後に追加するバッファのバイト数または文字数を指定します。
buffer	ラージオブジェクトの取得された部分を指定します。 lob_locパラメーターのデータ型がBLOBの場合、bufferパラメーターのデータ型はRAWでなければなりません。 lob_locパラメーターのデータ型がCLOBの場合、bufferパラメーターのデータ型はVARCHAR2でなければなりません。