埋込みSQL文およびディレクティブ

「EXECUTE(実行可能埋込みSQL)」

FETCH DESCRIPTOR (実行可能埋込みSQL)

FREE (実行可能埋込みSQL拡張機能)。

E.5 ALLOCATE DESCRIPTOR (実行可能埋込みSQL)

用途

記述子を割り当てるANSI動的SQL文です。

前提条件

なし。

構文

図alldesc.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
array_size integer	処理される行数を格納するホスト変数。処理する行数。
descriptor_name descriptor name	ANSI記述子の名前を含むホスト変数。 ANSI記述子の名前。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。
WITH MAX integer	ホスト変数の最大数。デフォルトは100です。

使用上のノート

DYNAMIC=ANSIプリコンパイラ・オプションを使用してください。この文の使用の詳細は、ALLOCATE DESCRIPTORを参照してください。

例

EXEC SQL FOR :batch ALLOCATE DESCRIPTOR GLOBAL :binddes WITH MAX 25 ;

関連項目

DESCRIBE DESCRIPTOR (実行可能埋込みSQL) 。

DEALLOCATE DESCRIPTOR (埋込みSQL文)

ALLOCATE (実行可能埋込みSQL拡張機能)。

E.6 CACHE FREE ALL (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内のすべてのメモリーを解放します。

前提条件

アクティブなデータベース接続が存在している必要があります。

構文

図cache.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
db_name	CONNECT文で先に設定されるデータベース接続名を含むNULL終了文字列。省略した場合または空文字の場合は、デフォルトのデータベース接続とみなされます。
host_variable	データベース接続名を格納するホスト変数。

使用上のノート

接続カウントが0(ゼロ)になると、SQLLIBにより自動的にすべてのオブジェクト・キャッシュ・メモリーが解放されます。詳細は、CACHE FREE ALLを参照してください。

例

EXEC SQL AT mydb CACHE FREE ALL ;

関連項目

FREE (実行可能埋込みSQL拡張機能)。

E.7 CALL (実行可能埋込みSQL)

用途

ストアド・プロシージャをコールします。

前提条件

アクティブなデータベース接続が存在している必要があります。

構文

図call.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
schema	プロシージャを格納するスキーマ。省略した場合、Oracleはプロシージャが固有のスキーマ内にあるとみなします。
pkg	プロシージャが格納されているパッケージ。
st_proc	コールするストアド・プロシージャ。
db_link	プロシージャが格納されているリモート・データベースへのデータベース・リンクの、完全または一部の名前。データベース・リンク参照の情報は、『Oracle Database SQL言語リファレンス』を参照してください。
expr	プロシージャのパラメータ式のリスト。
ret_var	関数からの戻り値を受け取るホスト変数。
ret_ind	ret_varの標識変数。

使用上のノート

この文の詳細は、ストアドPL/SQLまたはJavaサブプログラムのコールを参照してください。

例

int emp_no;
char emp_name[10];
float salary;
char dept_name[20];
...
emp_no = 1325;
EXEC SQL CALL get_sal(:emp_no, :emp_name, :salary) INTO :dept_name ;
/* Print emp_name, salary, dept_name */
...

関連項目

なし。

E.8 CLOSE (実行可能埋込みSQL)

用途

カーソルのオープン時に取得したリソースを解放し、解析ロックを解除して、カーソルを使用禁止にします。

前提条件

MODE=ANSIの場合は、カーソルまたはカーソル変数はオープンである必要があります。

構文

図close.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
cursor	クローズするカーソル。
cursor_variable	クローズするカーソル変数。

使用上のノート

クローズしたカーソルからは行をフェッチできません。カーソルを再オープンするには、そのカーソルがクローズされている必要はありません。HOLD_CURSORおよびRELEASE_CURSORのプリコンパイラ・オプションによって、CLOSE文の結果は異なります。これらのオプションの詳細は、プリコンパイラのオプションを参照してください。

例

この例では、CLOSE文の使用方法を示します。

EXEC SQL CLOSE emp_cursor;

関連項目

OPEN (実行可能埋込みSQL) 。

E.9 COLLECTION APPEND (実行可能埋込みSQL拡張機能)

用途

1つのコレクションの要素を別のコレクションの最後に追加します。

前提条件

NULLコレクションに追加すること、またはコレクションの上限を超えて追加することはできません。

構文

図collapp.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COLLECTION APPENDを参照してください。

関連項目

他のCOLLECTION文を参照してください。

E.10 COLLECTION DESCRIBE (実行可能埋込みSQL拡張機能)

用途

コレクションについての情報を取得します。

前提条件

ALLOCATEおよびOBJECT GET文を使用して記述子を割り当て、記述子にコレクション属性を格納します。

構文

図colldes.epsの説明

attribは次のとおりです。

図collatt.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COLLECTION DESCRIBEを参照してください。

関連項目

他のCOLLECTION文を参照してください。

E.11 COLLECTION GET (実行可能埋込みSQL拡張機能)

用途

コレクションの要素を取得します。

構文

図collget.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COLLECTION文を参照してください。

関連項目

他のCOLLECTION文を参照してください。

E.12 COLLECTION RESET (実行可能埋込みSQL拡張機能)

用途

コレクションのスライス・エンドポイントをコレクションの最初にリセットします。

構文

図collres.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COLLECTION RESETを参照してください。

関連項目

他のCOLLECTION文を参照してください。

E.13 COLLECTION SET (実行可能埋込みSQL拡張機能)

用途

コレクションの現行のスライスの要素値を更新します。

構文

図collset.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COLLECTION SETを参照してください。

関連項目

他のCOLLECTION文を参照してください。

E.14 COLLECTION TRIM (実行可能埋込みSQL拡張機能)

用途

コレクションの最後から要素を削除します。

構文

図colltr.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COLLECTION TRIMを参照してください。

関連項目

他のCOLLECTION文を参照してください。

E.15 COMMIT (実行可能埋込みSQL)

用途

データベースの変更内容をすべて確定し、またオプションですべてのリソースを解放して切断し、現行のトランザクションを終了します。

前提条件

カレント・トランザクションをコミットするために必要な権限はありません。

ユーザーがコミットしたインダウトの分散トランザクションを手動でコミットするには、FORCE TRANSACTIONのシステム権限が必要です。他のユーザーがコミットしたインダウトの分散トランザクションを手動でコミットするには、FORCE ANY TRANSACTIONのシステム権限が必要です。

構文

図commit.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	どのデータベースに対してCOMMIT文を発行するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 値がdb_nameのホスト変数。この句を省略した場合、Oracleはデフォルトのデータベースに対して文を発行します。
WORK	標準SQLへの準拠のためにのみサポートされています。COMMIT文とCOMMIT WORK文は同等です。
COMMENT	現行のトランザクションに対応付けるコメントを指定します。'text'は50文字以内の引用符付きリテラルで、トランザクションがインダウトになった場合に、Oracleによりデータ・ディクショナリ・ビューDBA_2PC_PENDINGにトランザクションIDとともに格納されます。
RELEASE	リソースをすべて解放し、アプリケーションをサーバーから切断します。
FORCE	インダウトの分散トランザクションを手動でコミットします。トランザクションは、ローカル・トランザクションIDまたはグローバル・トランザクションIDを含む'text'により指定します。このようなトランザクションのIDを検索するには、データ・ディクショナリ・ビューDBA_2PC_PENDINGに問合せをします。また、オプションの整数を使用してトランザクションにシステム変更番号(SCN)を明示的に割り当てることができます。integerを省略した場合、トランザクションはカレントSCNを使用してコミットされます。

使用上のノート

プログラムの最後のトランザクションは、COMMITコマンドまたはROLLBACK文およびRELEASEオプションを使用して、必ず明示的にコミットまたはロールバックしてください。プログラムが異常終了すると、Oracleは自動的に変更をロールバックします。

COMMIT文は、ホスト変数やプログラムの制御の流れには影響しません。この文の詳細は、データベースの概要を参照してください。

例

この例では、埋込みSQL COMMIT文の使用方法を示します。

EXEC SQL AT sales_db COMMIT RELEASE;

関連項目

ROLLBACK (実行可能埋込みSQL)

SAVEPOINT (実行可能埋込みSQL)

E.16 CONNECT (実行可能埋込みSQL拡張機能)

用途

データベースにログインすること。

前提条件

指定するデータベースに対してCREATE SESSIONのシステム権限が必要です。

構文

EXEC SQL
 CONNECT { :user IDENTIFIED BY :oldpswd | :usr_psw }
 [[AT { dbname | :host_variable }] USING :connect_string ]
 [ {ALTER AUTHORIZATION :newpswd | IN {SYSDBA | SYSOPER | SYSBACKUP} MODE} ]
 END-EXEC.

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
user password	ユーザー名およびパスワードを個別に指定します。
user_password	ユーザー名とパスワードをスラッシュ(/)で区切って格納した1つのホスト変数。 Oracleで、使用しているオペレーティング・システムとの接続を検証するには、「/」をuser_password値として指定します。
AT	接続先のデータベースを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 値がdb_nameのホスト変数。この句を省略した場合、Oracleはデフォルトのデータベースに対して文を発行します。
USING	非デフォルトのデータベースへの接続に使用されるOracle Netデータベース指定の文字列を指定します。この句を省略した場合は、デフォルトのデータベースに接続します。
ALTER AUTHORIZATION	パスワードを次の文字列に変更します。
new_password	新しいパスワード。
IN SYSDBA MODE IN SYSOPER MODE IN SYSBACKUP MODE	SYSDBA、SYSOPERまたはSYSBACKUPシステム権限で接続します。ALTER AUTHORIZATIONが使用されているとき、またはプリコンパイラ・オプションのAUTO_CONNECTがYESに設定されているときは、接続が許可されません。

使用上のノート

プログラムは複数の接続を持つことができますが、デフォルト・データベースには1度しか接続できません。この文の詳細は、OCIリリース7コールの埋込みを参照してください。

例

次の例では、CONNECTの使用方法を示します。

EXEC SQL CONNECT :username 
    IDENTIFIED BY :password ;

この文では、useridの値に、'SCOTT/TIGER'のように、usernameの値とpasswordの値をスラッシュ(/)で区切って使用することもできます。

EXEC SQL CONNECT :userid ;

関連項目

ROLLBACK (実行可能埋込みSQL)

E.17 CONTEXT ALLOCATE (実行可能埋込みSQL拡張機能)

用途

EXEC SQL CONTEXT USE文で参照されているSQLLIBランタイム・コンテキストを初期化します。

前提条件

ランタイム・コンテキストはsql_context型で宣言する必要があります。

構文

図conall.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
context	メモリーを割り当てるSQLLIBランタイム・コンテキスト。

使用上のノート

マルチスレッド・アプリケーションでは、ランタイム・コンテキストごとにこのファンクションを実行します。

この文の詳細は、OCIリリース8のSQLLIB拡張相互運用性を参照してください。

例

この例では、Pro*C/C++プログラムでCONTEXT ALLOCATE文を使用する方法を示します。

EXEC SQL CONTEXT ALLOCATE :ctx1;

関連項目

「ENABLE THREADS(実行可能埋込みSQL拡張機能)」

E.18 CONTEXT FREE (実行可能埋込みSQL拡張機能)

用途

ランタイム・コンテキストに関連付けられたすべてのメモリーを解放し、NULLポインタをホスト・プログラム変数に代入します。

前提条件

CONTEXT FREE文を使用してランタイム・コンテキストに割り当てられたメモリーを解放する前に、CONTEXT ALLOCATE文を使用して、指定されているランタイム・コンテキストにメモリーを割り当てる必要があります。

構文

図confree.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
:context	メモリーの割当てを解除する、割当て済ランタイム・コンテキスト。

使用上のノート

この文の詳細は、OCIリリース8のSQLLIB拡張相互運用性を参照してください。

例

この例では、Pro*C/C++プログラムでCONTEXT FREE文を使用する方法を示しています。

EXEC SQL CONTEXT FREE :ctx1;

関連項目

「ENABLE THREADS(実行可能埋込みSQL拡張機能)」

E.19 CONTEXT OBJECT OPTION GET (実行可能埋込みSQL拡張機能)

用途

CONTEXT OBJECT OPTION SETによって設定される使用中のコンテキストのオプションの値を決定します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。

構文

図conobget.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
option	オプション値については、CONTEXT OBJECT OPTION SETを参照してください。
host_variable	optionリストと同じ順序で表されたSTRING、VARCHAR、CHARZ型の出力変数。

使用上のノート

CONTEXT OBJECT OPTION SETを参照してください。

例

char EuroFormat[50];
...
EXEC SQL CONTEXT OBJECT OPTION GET DATEFORMAT INTO :EuroFormat ;
printf("Date format is %s\n", EuroFormat);

関連項目

「CONTEXT OBJECT OPTION SET(実行可能埋込みSQL拡張機能)」

E.20 CONTEXT OBJECT OPTION SET (実行可能埋込みSQL拡張機能)

用途

使用中のコンテキストに対する指定済の日付属性DATEFORMATおよびDATELANGにオプションを設定します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。

構文

図conobset.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
option	オプション値については、CONTEXT OBJECT OPTION SETを参照してください。
host_variable	STRING、VARCHAR、CHARZ型の入力変数。optionリストと同じ順序。

使用上のノート

CONTEXT OBJECT OPTION GETを参照してください。

例

char *new_format = "DD-MM-YYY";
char *new_lang = "French";
...
EXEC SQL CONTEXT OBJECT OPTION SET DATEFORMAT, DATELANG TO :new_format, :new_lang;

関連項目

「CONTEXT OBJECT OPTION SET(実行可能埋込みSQL拡張機能)」

E.21 CONTEXT USE (Oracle埋込みSQLディレクティブ)

用途

後続の実行SQL文で指定のSQLLIBランタイム・コンテキストを使用するようにプリコンパイラに指示します。

前提条件

CONTEXT USEディレクティブによって指定されたランタイム・コンテキストは、事前に宣言されている必要があります。

構文

図conuse.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
context	後続の実行SQL文によって使用される、割当て済ランタイム・コンテキストです。たとえば、使用するコンテキストをソース・コードに指定した後(複数のコンテキストを割り当てることができます)、Oracleサーバーに接続し、コンテキストのスコープ内でデータベースを操作できます。DEFAULTは作業したグローバル・コンテキストが使用されることを示します。
DEFAULT	グローバル・コンテキストが使用されることを示します。

説明

context

後続の実行SQL文によって使用される、割当て済ランタイム・コンテキストです。たとえば、使用するコンテキストをソース・コードに指定した後(複数のコンテキストを割り当てることができます)、Oracleサーバーに接続し、コンテキストのスコープ内でデータベースを操作できます。DEFAULTは作業したグローバル・コンテキストが使用されることを示します。

DEFAULT

グローバル・コンテキストが使用されることを示します。

使用上のノート

この文はEXEC SQL INCLUDEやEXEC ORACLE OPTIONなどの宣言文では無効です。この文は、EXEC SQL WHENEVERディレクティブと同様に、指定したソース・ファイル内でこのディレクティブの後に続くすべての実行SQL文に影響し、C言語の標準のスコープ規則には従いません。

この文の詳細は、OCIリリース8のSQLLIB拡張相互運用性を参照してください。

例

この例では、Pro*C/C++の埋込みSQLプログラムでCONTEXT USEディレクティブを使用する方法を示します。

EXEC SQL CONTEXT USE :ctx1;

関連項目

「ENABLE THREADS(実行可能埋込みSQL拡張機能)」

E.22 DEALLOCATE DESCRIPTOR (埋込みSQL文)

用途

記述子領域の割当てを解除し、メモリーを解放するANSI動的SQL文です。

前提条件

DEALLOCATE DESCRIPTOR文で指定されている記述子は、ALLOCATE DESCRIPTOR文を使用して事前に割り当てる必要があります。

構文

図dealdesc.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。
descriptor_name 'descriptor name'	割り当てられたANSI記述子名を格納するホスト変数。割り当てられたANSI記述子の名前。

説明

GLOBAL | LOCAL

LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。

descriptor_name

'descriptor name'

割り当てられたANSI記述子名を格納するホスト変数。

割り当てられたANSI記述子の名前。

使用上のノート

DYNAMIC=ANSIプリコンパイラ・オプションを使用してください。

この文の詳細は、DEALLOCATE DESCRIPTORを参照してください。

例

EXEC SQL DEALLOCATE DESCRIPTOR GLOBAL 'SELDES' ;

関連項目

DESCRIBE(実行可能埋込みSQL拡張機能)

E.23 DECLARE CURSOR (埋込みSQLディレクティブ)

用途

カーソルを宣言するためにカーソルに名前を付け、それをSQL文またはPL/SQLブロックに対応付けます。

前提条件

SQL文またはPL/SQLブロックの識別子を使用してカーソルを対応付けるには、DECLARE STATEMENT文を使用してこの識別子を事前に宣言する必要があります。

構文

図appedclco1.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	カーソルを宣言するデータベースを指定します。次のいずれかを使用してデータベースを指定します。
db_name	DECLARE DATABASE文を使用してすでに宣言されているデータベース識別子。
host_variable	すでに宣言されているdb_name値のホスト変数。この句を省略した場合、Oracleはデフォルトのデータベースに対してこのカーソルを宣言します。
cursor	宣言するカーソルの名前。
WITH HOLD	カーソルはCOMMITの実行後もオープン状態のままです。UPDATEの場合は、カーソルを宣言しないでください。
SELECT文	カーソルに対応付けるSELECT文。直後の文にINTO句を含めないでください。
statement_name	カーソルに対応付けるSQL文またはPL/SQLブロックを指定します。statement_nameまたはblock_nameは、DECLARE STATEMENT文を使用して事前に宣言する必要があります。

使用上のノート

カーソルは、他の埋込みSQL文で参照する前に、宣言する必要があります。カーソル宣言のスコープはプリコンパイル・ユニット内全体になるため、各カーソルの名前はスコープ内で一意であることが必要です。1つのプリコンパイル・ユニット内で同じ名前のカーソルを複数宣言することはできません。

カーソルは、UPDATE文またはDELETE文のWHERE句内でCURRENT OF構文を使用して参照できます。このとき、カーソルはOPEN文を使用してオープンし、FETCH文を使用して行に位置付けられている必要があります。この文の詳細は、埋込みPL/SQLのカーソルの使用方法を参照してください。

例

この例では、DECLARE CURSOR文の使用方法を示します。

EXEC SQL DECLARE emp_cursor CURSOR 
    FOR SELECT ename, empno, job, sal 
        FROM emp 
        WHERE deptno = :deptno 
        FOR UPDATE OF sal;

関連項目

DELETE (実行可能埋込みSQL) 。

OPEN DESCRIPTOR (実行可能埋込みSQL)

SELECT (実行可能埋込みSQL)。

UPDATE (実行可能埋込みSQL)

E.24 DECLARE DATABASE (Oracle埋込みSQLディレクティブ)

用途

後続の埋込みSQL文でアクセスされるデフォルト以外のデータベースの識別子を宣言します。

前提条件

非デフォルト・データベースのユーザー名にアクセスできる必要があります。

構文

図dcldbase.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
db_name	非デフォルト・データベースに対して設定する識別子。

使用上のノート

デフォルト以外のデータベースに対してdb_nameを宣言するのは、他の埋込みSQL文がAT句を使用してそのデータベースを参照できるようにするためです。AT句を指定してCONNECT文を発行する前に、DECLARE DATABASE文を使用してデフォルト以外のデータベースに対してdb_nameを宣言する必要があります。

この文の詳細は、単一の明示的接続を参照してください。

例

この例では、DECLARE DATABASEディレクティブの使用方法を示します。

EXEC SQL DECLARE oracle3 DATABASE ;

関連項目

CONNECT (実行可能埋込みSQL拡張機能)

EXECUTE ...END-EXEC (実行可能埋込みSQL拡張機能)

DELETE (実行可能埋込みSQL) 。

EXECUTE IMMEDIATE (実行可能埋込みSQL)。

INSERT (実行可能埋込みSQL) 。

SELECT (実行可能埋込みSQL)。

UPDATE (実行可能埋込みSQL)

E.25 DECLARE STATEMENT (埋込みSQLディレクティブ)

用途

SQL文またはPL/SQLブロックの識別子を宣言し、他の埋込みSQL文で使用できるようにします。

前提条件

なし。

構文

dcl_stmt.gifの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	SQL文またはPL/SQLブロックが宣言されるデータベースを識別します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 値がdb_nameのホスト変数。この句を省略した場合、Oracleではデフォルトのデータベースに対してSQL文またはPL/SQLブロックが宣言されます。
statement_name	文に対して宣言する識別子。

説明

AT

SQL文またはPL/SQLブロックが宣言されるデータベースを識別します。次のいずれかを使用してデータベースを指定します。

db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。

host_variable: 値がdb_nameのホスト変数。この句を省略した場合、Oracleではデフォルトのデータベースに対してSQL文またはPL/SQLブロックが宣言されます。

statement_name

文に対して宣言する識別子。

使用上のノート

DECLARE STATEMENT文を使用してSQL文またはPL/SQLブロックの識別子を宣言する必要があるのは、その識別子を参照するDECLARE CURSOR文の埋込みSQLプログラム内での位置が、文またはブロックを解析して識別子と対応付けるPREPARE文よりも物理的に(論理的ではなく)前になっているときのみです。

文の宣言のスコープは、カーソルの宣言と同様に、プリコンパイル・ユニット内全体です。この文の詳細は、データ型とホスト変数およびOracle動的SQLを参照してください。

例I

この例では、DECLARE STATEMENT文の使用方法を示します。

EXEC SQL AT remote_db DECLARE my_statement STATEMENT; 
EXEC SQL PREPARE my_statement FROM :my_string; 
EXEC SQL EXECUTE my_statement;

例II

このPro*C/C++の埋込みSQLプログラムからの例では、DECLARE CURSOR文がPREPARE文の前にあるため、DECLARE STATEMENT文が必要です。

EXEC SQL DECLARE my_statement STATEMENT; 
EXEC SQL DECLARE emp_cursor CURSOR FOR my_statement; 
EXEC SQL PREPARE my_statement FROM :my_string; 
...

関連項目

OPEN DESCRIPTOR (実行可能埋込みSQL)

「DECLARE TYPE(Oracle埋込みSQLディレクティブ)」

E.26 DECLARE TABLE (Oracle埋込みSQLディレクティブ)

用途

それぞれの列のデータ型、デフォルト値、Oracleプリコンパイラによる意味検査のためのNULLまたはNOT NULL仕様部など、表またはビューの構造を定義します。

前提条件

なし。

構文

リレーショナル表に使用する構文は、次のとおりです。

図dcltab.epsの説明

オブジェクト表に使用する構文は、次のとおりです。

図dcltabob.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
table	宣言した表の名前。
column	表の列。
datatype	列のデータ型。データ型の詳細は、Oracleのデータ型を参照してください。データ型がユーザー定義オブジェクトの場合は、sizeをカッコで囲んで入力できます。sizeはマクロまたは複雑なC言語の式にはできません。sizeは省略できます。例を参照してください。
NOT NULL	NULLを含めることのできない列を指定します。
obj_type	オブジェクト型を表します。

使用上のノート

この文の使用方法は、DECLARE TABLEの使用についてを参照してください。

例

次の文では、PARTNO、BINおよびQTYの列を含むPARTSという表を宣言しています。

EXEC SQL DECLARE parts TABLE 
     (partno NUMBER  NOT NULL, 
      bin    NUMBER, 
      qty    NUMBER);

次のようにオブジェクト型を使用します。

EXEC SQL DECLARE person TYPE AS OBJECT (name VARCHAR2(20), age INT);
EXEC SQL DECLARE odjtab1 TABLE OF person;

関連項目

E.27 DECLARE TYPE (Oracle埋込みSQLディレクティブ)

用途

プリコンパイラによる意味検査に使用される型の属性を定義します。

前提条件

なし。

構文

図dcltype.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
column	列の名前。
datatype	列のデータ型。
size	VARRAYの要素数。
element_type	VARRAYの要素型。オブジェクトにすることもできます。
object_type	以前に宣言されていたオブジェクト型。

使用上のノート

この文の使用方法は、DECLARE TYPEの使用についてを参照してください。

例

EXEC SQL DECLARE project_type TYPE AS OBJECT(
              pno           CHAR(5),
              pname         CHAR(20),
              budget        NUMBER);
EXEC SQL DECLARE project_array TYPE as VARRAY(20) OF project_type ;
EXEC SQL DECLARE employees TYPE AS TABLE OF emp_objects ;

関連項目

DECLARE TABLE (Oracle埋込みSQLディレクティブ)

E.28 DELETE (実行可能埋込みSQL)

用途

表またはビューの実表から行を削除します。

前提条件

表から行を削除するには、表がユーザーのスキーマ内にあるか、表に対してDELETEの権限を持っている必要があります。

ビューの実表から行を削除するには、ビューが属するスキーマの所有者が、実表に対してDELETEの権限を持っている必要があります。また、ビューがユーザー所有のスキーマ以外のスキーマにある場合は、ビューに対するDELETEの権限を付与されている必要があります。

DELETE ANY TABLEのシステム権限では、どの表またはビューの実表からでも行を削除できます。

構文

図delete.epsの説明

DML RETURNING句は次のとおりです。

図return.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	どのデータベースに対してDELETE文を発行するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 事前に宣言したdb_name の値を持つホスト変数。この句を省略した場合、DELETE文はデフォルトのデータベースに対して発行されます。
FOR :host_integer	WHERE句に配列ホスト変数が含まれる場合に、文を実行する回数を制限します。この句を省略した場合、データベースは最小の配列の各コンポーネントにつき1回ずつ文が実行されます。
subquery	対応する列に割り当てられた新しい値を戻す副問合せ。副問合せの構文は、SELECTを参照してください。
schema	表またはビューを含むスキーマ。schemaを省略した場合、データベースでは表またはビューが自分のスキーマ内にあるとみなされます。
table	行を削除する表の名前。
view	ビューの名前。データベースはビューの実表から行を削除します。
FOR :host_integer	WHERE句に配列ホスト変数が含まれる場合に、文を実行する回数を制限します。この句を省略した場合、データベースは最小の配列の各コンポーネントにつき1回ずつ文が実行されます。
subquery	対応する列に割り当てられた新しい値を戻す副問合せ。副問合せの構文は、SELECTを参照してください。
schema	表またはビューを含むスキーマ。schemaを省略した場合、データベースでは表またはビューが自分のスキーマ内にあるとみなされます。
table	行を削除する表の名前。
view	ビューの名前。データベースではビューの実表から行が削除されます。

使用上のノート

WHERE句のホスト変数は、すべてスカラーか、すべて配列である必要があります。変数がスカラーの場合、データベースはDELETE文を1回のみ実行します。変数が配列の場合は、データベースでは配列のコンポーネントのセットごとに文が1回実行されます。1回の実行で0行、1行または複数行を削除できます。

WHERE句の配列ホスト変数は、サイズが異なっていてもかまいません。この場合、データベースで文が実行される回数は、次の値のうち小さい方によって決まります。

最小の配列のサイズ
オプションのFOR句の:host_integerの値

この条件を満たす行が存在しない場合、行は削除されず、SQLCODEはNOT_FOUND条件を戻します。

削除された行の累積数はSQLCAを介して戻されます。WHERE句に配列ホスト変数が指定されていると、DELETE文によって処理された配列のすべてのコンポーネントにおよぶ削除行数の合計がこの値に設定されます。

条件を満たす行がない場合、データベースはSQLCAのSQLCODEを介してエラーを戻します。WHERE句を省略した場合、データベースはSQLCAのSQLWARNの第5コンポーネントに警告フラグを設定します。この文とSQLCAの詳細は、ランタイム・エラーの処理を参照してください。

DELETE文でコメントを使用して、指示(つまりヒント)をオプティマイザに渡すことができます。オプティマイザは、これらのヒントを使用して文の実行計画を選択します。

例

この例では、Pro*C/C++の埋込みSQLプログラムにおけるDELETE文の使用方法を示します。

EXEC SQL DELETE FROM emp 
    WHERE deptno = :deptno 
    AND job = :job;

EXEC SQL DECLARE emp_cursor CURSOR 
    FOR SELECT empno, comm 
        FROM emp; 
EXEC SQL OPEN emp_cursor; 
EXEC SQL FETCH c1 
    INTO :emp_number, :commission; 
EXEC SQL DELETE FROM emp 
    WHERE CURRENT OF emp_cursor;

関連項目

「DECLARE DATABASE(Oracle埋込みSQLディレクティブ)」

E.29 DESCRIBE (実行可能埋込みSQL拡張機能)

用途

Oracle記述子に動的SQL文またはPL/SQLブロックについての情報を入力します。

前提条件

埋込みSQLのPREPARE文を使用して、SQL文またはPL/SQLブロックを事前に準備しておく必要があります。

構文

図describe.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
BIND VARIABLES FOR	SQL文またはPL/SQLブロックの入力変数に関する情報を保持する記述子を初期化します。
SELECT LIST FOR	SELECT文の選択リストに関する情報を保持する記述子を初期化します。デフォルトはSELECT LIST FORです。
statement_name	PREPARE文を使用して事前に準備したSQL文またはPL/SQLブロックを指定します。
descriptor	入力する記述子の名前。

使用上のノート

埋込みSQLプログラム内のバインド記述子または選択記述子を操作するには、その前にDESCRIBE文を発行する必要があります。

入力変数と出力変数の両方を同じ記述子に記述することはできません。

DESCRIBE文で検出される変数の数は、一意に名前が指定されたプレースホルダの合計数ではなく、準備するSQL文またはPL/SQLブロックのプレースホルダの合計数です。この文の詳細は、Oracle動的SQLを参照してください。

例

この例では、Pro*C/C++の埋込みSQLプログラムにおけるDESCRIBE文の使用方法を示します。

EXEC SQL PREPARE my_statement FROM :my_string; 
EXEC SQL DECLARE emp_cursor 
    FOR SELECT empno, ename, sal, comm 
            FROM emp 
            WHERE deptno = :dept_number;
EXEC SQL DESCRIBE BIND VARIABLES FOR my_statement 
    INTO bind_descriptor; 
EXEC SQL OPEN emp_cursor 
    USING bind_descriptor; 
EXEC SQL DESCRIBE SELECT LIST FOR my_statement 
    INTO select_descriptor; 
EXEC SQL FETCH emp_cursor 
    INTO select_descriptor;

関連項目

E.30 DESCRIBE DESCRIPTOR (実行可能埋込みSQL)

用途

SQL文についての情報を取得するために使用するANSI動的SQL文で、情報は記述子に格納されます。

前提条件

埋込みSQLのPREPARE文を使用して、SQL文を事前に準備しておく必要があります。

構文

図descans.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
statement_id	事前に準備されているSQL文またはPL/SQLブロックの名前。OUTPUTはデフォルトです。
desc_name	SQL文の情報を保持する記述子名を格納するホスト変数。
'descriptor name'	記述子の名前。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。

使用上のノート

DYNAMIC=ANSIプリコンパイラ・オプションを使用してください。

INPUT記述子では、COUNTおよびNAMEのみインプリメントされます。

DESCRIBE文で検出される変数の数は、一意に名前が指定されたプレースホルダの合計数ではなく、準備するSQL文またはPL/SQLブロックのプレースホルダの合計数です。この文の詳細は、DESCRIBE INPUTおよびDESCRIBE OUTPUTを参照してください。

例

EXEC SQL PREPARE s FROM :my_stament; 
EXEC SQL DESCRIBE INPUT s USING DESCRIPTOR 'in' ;

関連項目

DEALLOCATE DESCRIPTOR (埋込みSQL文)。

E.31 ENABLE THREADS (実行可能埋込みSQL拡張機能)

用途

複数のスレッドをサポートするプロセスを初期化します。

前提条件

マルチスレッド・アプリケーションをサポートするプラットフォーム用にプリコンパイラ・アプリケーションを開発し、このプラットフォームでコンパイルを実行して、コマンドラインにTHREADS=YESを指定する必要があります。

ノート:

Pro*C/C++プリコンパイラとXAを併用する場合は、XAのマルチスレッド処理を使用する必要があります。EXEC SQL ENABLE THREADS文を使用してPro*C/C++のマルチスレッド処理を使用するとエラーになります。

構文

enable_t.gifの説明

キーワードおよびパラメータ

なし。

使用上のノート

ENABLE THREADS文は、他の実行SQL文の前、かつスレッドを作成する前に実行する必要があります。この文にはホスト変数を指定する必要はありません。

この文の詳細は、OCIリリース8のSQLLIB拡張相互運用性を参照してください。

例

この例では、Pro*C/C++プログラムでENABLE THREADS文を使用する方法を示しています。

EXEC SQL ENABLE THREADS;

関連項目

EXECUTE IMMEDIATE (実行可能埋込みSQL)。

E.32 EXECUTE ... END-EXEC (実行可能埋込みSQL拡張機能)

用途

Pro*C/C++プログラムに無名PL/SQLブロックを埋め込みます。

前提条件

なし。

構文

図execeex.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	PL/SQLブロックをどのデータベースに対して実行するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、PL/SQLブロックはデフォルトのデータベースに対して実行されます。
pl/sql_block	PL/SQLブロックの作成方法など、PL/SQLの詳細は『Oracle Database PL/SQL言語リファレンス』を参照してください。
END-EXEC	このキーワードは、Oracleプリコンパイラ・プログラムが使用するプログラミング言語に関係なく、埋込みPL/SQLブロックの後に配置する必要があります。キーワードEND-EXECの後には、C/C++の文終了記号「;」を付ける必要があります。

説明

AT

PL/SQLブロックをどのデータベースに対して実行するかを指定します。次のいずれかを使用してデータベースを指定します。

db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。

host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、PL/SQLブロックはデフォルトのデータベースに対して実行されます。

pl/sql_block

PL/SQLブロックの作成方法など、PL/SQLの詳細は『Oracle Database PL/SQL言語リファレンス』を参照してください。

END-EXEC

このキーワードは、Oracleプリコンパイラ・プログラムが使用するプログラミング言語に関係なく、埋込みPL/SQLブロックの後に配置する必要があります。キーワードEND-EXECの後には、C/C++の文終了記号「;」を付ける必要があります。

使用上のノート

Pro*C/C++では埋込みPL/SQLブロックが1つの埋込みSQL文のように扱われるため、PL/SQLブロックはプログラムでSQL文を埋め込める場所であればどこでも埋込みが可能です。Oracleプリコンパイラ・プログラムへのPL/SQLブロックの埋込みに関する詳細は、埋込みPL/SQLを参照してください。

例

このEXECUTE文をPro*C/C++プログラムに使用すると、PL/SQLブロックがプログラムに埋め込まれます。

EXEC SQL EXECUTE 
    BEGIN 
        SELECT ename, job, sal 
            INTO :emp_name:ind_name, :job_title, :salary 
            FROM emp 
            WHERE empno = :emp_number; 
        IF :emp_name:ind_name IS NULL 
            THEN RAISE name_missing; 
        END IF; 
    END; 
END-EXEC;

関連項目

E.33 EXECUTE (実行可能埋込みSQL)

用途

Oracle動的SQLでは、埋込みSQLのPREPARE文によって準備済のDELETE文、INSERT文またはUPDATE文、あるいはPL/SQLブロックを実行します。ANSI動的SQL方法4については、EXECUTE DESCRIPTOR(実行可能埋込みSQL)を参照してください。

前提条件

埋込みSQLのPREPARE文を使用して、SQL文またはPL/SQLブロックを先に準備しておく必要があります。

構文

図execo.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
FOR :array_size	処理される行の数を格納するホスト変数。処理される行数。
FOR integer	USING句に配列ホスト変数が含まれる場合に文が実行される回数を制限します。この句を省略した場合、Oracleでは最小の配列の各コンポーネントに対して1回ずつ文が実行されます。
statement_id	実行するSQL文またはPL/SQLブロックに対応付けられているプリコンパイラ識別子。プリコンパイラ識別子を文またはPL/SQLブロックに対応付けるには、埋込みSQLのPREPARE文を使用します。
USING DESCRIPTOR SQLDA_descriptor	Oracle記述子を使用します。ANSI記述子(INTO句)と一緒には使用できません。
USING	オプションの標識変数を使用してホスト変数のリストを指定します(Oracleは実行する文にこれらの変数を入力変数として代入します)。ホスト変数および標識変数は、すべてスカラーか、すべて配列であることが必要です。
host_variable	ホスト変数
indicator_variable	標識変数。

使用上のノート

この文の詳細は、OracleバージョンのOracle動的SQLを参照してください。

例

この例では、Pro*C/C++プログラムでEXECUTE文を使用する方法を示しています。

EXEC SQL PREPARE my_statement 
    FROM :my_string; 
EXEC SQL EXECUTE my_statement
    USING :my_var;

関連項目

E.34 EXECUTE DESCRIPTOR (実行可能埋込みSQL)

用途

ANSI SQL方法4では、埋込みSQLのPREPARE文によって準備済のDELETE文、INSERT文またはUPDATE文、あるいはPL/SQLブロックを実行します。

前提条件

埋込みSQLのPREPARE文を使用して、SQL文またはPL/SQLブロックを先に準備しておく必要があります。

構文

図execa.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
FOR :array_size	処理される行の数を格納するホスト変数。処理される行数。
FOR integer	文が実行される回数を制限します。Oracleは最小の配列の各コンポーネントに対してこの文を1回ずつ実行します。
statement_id	実行するSQL文またはPL/SQLブロックに対応付けられているプリコンパイラ識別子。プリコンパイラ識別子を文またはPL/SQLブロックに対応付けるには、埋込みSQLのPREPARE文を使用します。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。
USING	ANSI記述子。
descriptor_name	入力記述子名を格納するホスト変数。
'descriptor name'	入力記述子の名前。
INTO	ANSI記述子。
descriptor_name	出力記述子の名前が含まれるホスト変数。
'descriptor name'	出力記述子の名前。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。

使用上のノート

この文の詳細は、ANSI動的SQLを参照してください。

例

ANSI動的SQL方法4では、EXECUTEのINTO句を使用して次のようにSELECTのDML RETURNING句がサポートされます。

EXEC SQL EXECUTE S2 USING DESCRIPTOR :bv1 INTO DESCRIPTOR 'SELDES' ;

関連項目

E.35 EXECUTE IMMEDIATE (実行可能埋込みSQL)

用途

ホスト変数を含まないDELETE文、INSERT文またはUPDATE文、あるいはPL/SQLブロックを準備し、実行します。

図execi.epsの説明

前提条件

なし。

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	SQL文またはPL/SQLブロックをどのデータベースに対して宣言するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、文またはブロックはデフォルトのデータベースに対して実行されます。
text	実行するSQL文またはPL/SQLブロックが含まれる引用符付きのテキスト・リテラル(または引用符なしのテキスト・リテラル)。 SQL文は、DELETE文、INSERT文またはUPDATE文のいずれかであることが必要です。
host_string	SQL文を含むホスト変数。

説明

AT

SQL文またはPL/SQLブロックをどのデータベースに対して宣言するかを指定します。次のいずれかを使用してデータベースを指定します。

db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。

host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、文またはブロックはデフォルトのデータベースに対して実行されます。

text

実行するSQL文またはPL/SQLブロックが含まれる引用符付きのテキスト・リテラル(または引用符なしのテキスト・リテラル)。

SQL文は、DELETE文、INSERT文またはUPDATE文のいずれかであることが必要です。

host_string

SQL文を含むホスト変数。

使用上のノート

EXECUTE IMMEDIATE文を発行すると、Oracleは指定したSQL文またはPL/SQLブロックを解析してエラーをチェックし、実行します。見つかったエラーは、SQLCAのSQLCODEコンポーネントに戻されます。

この文の詳細は、Oracle動的SQLおよびANSI動的SQLを参照してください。

例

この例では、EXECUTE IMMEDIATE文の使用方法を示します。

EXEC SQL EXECUTE IMMEDIATE 'DELETE FROM emp WHERE empno = 9460' ;

関連項目

EXECUTE (実行可能埋込みSQL)。

E.36 FETCH (実行可能埋込みSQL)

用途

Oracle動的SQLでは、選択リストの値がホスト変数に割り当てられ、問合せが戻した1行または複数の行が取り出されます。ANSI動的SQL方法4については、FETCH DESCRIPTOR(実行可能埋込みSQL)を参照してください。

前提条件

まず、OPEN文を使用してカーソルを先にオープンする必要があります。

構文

図fetcho.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
FOR :array_size	処理される行の数を格納するホスト変数。処理される行数。
FOR integer	配列ホスト変数を使用する場合にフェッチする行数を制限します。この句を省略した場合、Oracleは最小の配列を満たすのに十分な数の行をフェッチします。
cursor	DECLARE CURSOR文を使用して宣言したカーソル。FETCH文は、カーソルに対応付けられた問合せが選択した行のうちの1行を戻します。
cursor_variable	ALLOCATE文を使用して割り当てたカーソル変数。FETCH文は、カーソル変数に対応付けられた問合せが選択した行のうちの1行を戻します。
INTO	データをフェッチするホスト変数およびオプションの標識変数のリストを指定します。これらのホスト変数および標識変数は、プログラム内で宣言されている必要があります。
host_variable	データを受け取るホスト変数。
indicator_variables	ホスト標識変数。
USING SQLDA_variable	DESCRIBE文を使用して事前に参照しているOracle記述子を指定します。この句は、動的埋込みSQL方法4以外では使用しないでください。カーソル変数を使用している場合は、USING句は適用されません。

使用上のノート

FETCH文はアクティブ・セットの行を読み取り、結果が含まれる出力変数の名前を示します。対応付けられたホスト変数がNULLの場合、インジケータの値は-1に設定されます。また、カーソルに対する最初のFETCH文は、必要に応じてアクティブ・セットの行をソートします。

出力ホスト変数のサイズは取り出された行数を示し、FOR句は値を示します。データを取得するホスト変数は、すべてがスカラーか、あるいはすべてが配列であることが必要です。スカラーの場合は、Oracleは1行のみフェッチします。配列の場合、Oracleは配列を満たすのに十分な数の行をフェッチします。

配列ホスト変数は、サイズが異なってもかまいません。この場合、Oracleがフェッチする行数は、次の値のうち小さい方です。

最小の配列のサイズ
オプションのFOR句の:array_sizeの値

フェッチする行数は、実際に問合せを満たす行数によってさらに限定できます。

FETCH文が、問合せで戻された行すべてを取得しなかった場合、カーソルは戻された次の行に配置されます。問合せで戻された最後の行を取得すると、次のFETCH文を実行すると、SQLCAのSQLCODE要素にエラー・コードが戻されることになります。

FETCH文にはAT句は含まれません。カーソルによってアクセスされるデータベースは、DECLARE CURSOR文で指定する必要があります。

FETCH文では、アクティブ・セット内を前方向にのみ進めます。すでにフェッチした行に戻る場合は、カーソルを再オープンして各行を順番に取り出す必要があります。アクティブ・セットを変更するには、新しい値をカーソルの問合せの入力ホスト変数に割り当て、カーソルを再オープンします。

Oracleの記述子の詳細は、FETCH文を参照してください。

例

この例では、FETCH文を示します。

EXEC SQL DECLARE emp_cursor CURSOR FOR 
    SELECT job, sal FROM emp WHERE deptno = 30; 
EXEC SQL OPEN emp_cursor;
... 
EXEC SQL WHENEVER NOT FOUND GOTO ... 
for(;;)
    {
    EXEC SQL FETCH emp_cursor INTO :job_title1, :salary1; 
    ... 
    }

関連項目

OPEN (実行可能埋込みSQL) 。

E.37 FETCH DESCRIPTOR (実行可能埋込みSQL)

用途

選択リストの値をホスト変数に割り当てて、問合せが戻した1つまたは複数の行を取り出します。ANSI動的SQL方法4で使用します。

前提条件

OPEN文を使用してカーソルを先にオープンしておく必要があります。

構文

図fetcha.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
array_size	処理される行の数を格納するホスト変数。処理される行数。
integer	配列ホスト変数を使用する場合にフェッチする行数を制限します。この句を省略した場合、Oracleは最小の配列を満たすのに十分な数の行をフェッチします。
cursor	DECLARE CURSOR文を使用して宣言したカーソル。FETCH文は、カーソルに対応付けられた問合せが選択した行のうちの1行を戻します。
cursor_variable	ALLOCATE文を使用して割り当てたカーソル変数。FETCH文は、カーソル変数に対応付けられた問合せが選択した行のうちの1行を戻します。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。
INTO	データをフェッチするホスト変数およびオプションの標識変数のリストを指定します。これらのホスト変数および標識変数は、プログラム内で宣言されている必要があります。
descriptor name' :descriptor_name	出力ANSI記述子の名前。出力記述子名を格納するホスト変数。

使用上のノート

出力ホスト変数のサイズは取り出された行数を示し、FOR句は値を示します。データを取得するホスト変数は、すべてがスカラーか、あるいはすべてが配列であることが必要です。スカラーの場合は、Oracleは1行のみフェッチします。配列の場合、Oracleは配列を満たすのに十分な数の行をフェッチします。

配列ホスト変数は、サイズが異なってもかまいません。この場合、Oracleがフェッチする行数は、次の値のうち小さい方です。

最小の配列のサイズ
オプションのFOR句の:array_sizeの値

フェッチする行数は、実際に問合せを満たす行数によってさらに限定できます。

FETCH文が、問合せで戻された行すべてを取得しなかった場合、カーソルは戻された次の行に配置されます。問合せで戻された最後の行を取得すると、次のFETCH文を実行すると、SQLCAのSQLCODE要素にエラー・コードが戻されることになります。

FETCH文にはAT句は含まれません。カーソルによってアクセスされるデータベースは、DECLARE CURSOR文で指定する必要があります。

FETCH文では、アクティブ・セット内を前方向にのみ進めます。すでにフェッチした行に戻る場合は、カーソルを再オープンして各行を順番に取り出す必要があります。アクティブ・セットを変更するには、新しい値をカーソルの問合せの入力ホスト変数に割り当て、カーソルを再オープンします。

ANSI SQL方法4アプリケーション用にDYNAMIC=ANSIプリコンパイラ・オプションを使用してください。ANSI SQL方法4アプリケーションの詳細は、FETCHを参照してください。

例

...
EXEC SQL ALLOCATE DESCRIPTOR 'output_descriptor' ;
...
EXEC SQL PREPARE S FROM :dyn_statement ;
EXEC SQL DECLARE mycursor CURSOR FOR S ;
...
EXEC SQL FETCH mycursor INTO DESCRIPTOR 'output_descriptor' ;
...

関連項目

OPEN DESCRIPTOR (実行可能埋込みSQL)

ALLOCATE (実行可能埋込みSQL拡張機能)。

E.38 FREE (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内のメモリーを解放します。

前提条件

メモリーがすでに割り当てられている必要があります。

アクティブなデータベース接続が存在している必要があります。

構文

図free.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
dbname	CONNECT文で先に設定されるデータベース接続名を含むNULL終了文字列。これが省略される、または空の文字列である場合は、デフォルトのデータベース接続とみなされます。
host_ptr	事前にALLOCATEで割り当てられていたホスト変数ポインタ。
ind_ptr	インジケータ・ポインタ。

使用上のノート

接続が切り離されると、オブジェクト・キャッシュに割り当てられているメモリーはすべて自動的に解放されます。詳細は、FREEを参照してください。

例

EXEC SQL FREE :ptr ;

関連項目

「CACHE FREE ALL(実行可能埋込みSQL拡張機能)」

E.39 GET DESCRIPTOR (実行可能埋込みSQL)

用途

SQL記述子領域のホスト変数の情報を取得します。

前提条件

値構文でのみ使用します。

構文

図getdesc.epsの説明

item_nameのみ次の中から選択できます。

図getdnc.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
array_size	処理される行の数を格納するホスト変数。
integer	処理される行数。
descriptor_name 'descriptor name'	割り当てられたANSI記述子名を格納するホスト変数。割り当てられたANSI記述子の名前。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。
host_var = COUNT	入力および出力変数の合計数を格納するホスト変数。
integer	入力および出力変数の合計数。
VALUE :host_integer	参照される入力または出力変数の位置を格納するホスト変数。
VALUE integer	参照される入力または出力変数の位置。
host_var	項目の値を受け取るホスト変数。
item_name	item_nameに関しては、表10-4および表10-5の「記述子項目名」列を参照してください。

使用上のノート

DYNAMIC=ANSIプリコンパイラ・オプションを使用してください。配列サイズ句は、DATA、RETURNED_LENGTHおよびINDICATORの項目名で使用できます。「GET DESCRIPTOR」を参照してください。

例

EXEC SQL GET DESCRIPTOR GLOBAL 'mydesc' :mydesc_num_vars = COUNT ;

関連項目

DEALLOCATE DESCRIPTOR (埋込みSQL文)。

E.40 INSERT (実行可能埋込みSQL)

用途

表またはビューの実表に行を追加します。

前提条件

表に行を挿入するには、その表が自分のスキーマ内にあるか、またはその表に対してINSERTの権限を持っている必要があります。

ビューの実表に行を挿入するには、ビューが属するスキーマの所有者が、その実表に対してINSERTの権限を持っている必要があります。また、ビューがユーザーのスキーマ以外のスキーマ内にある場合は、ビューに対してINSERTの権限を持っている必要があります。

INSERT ANY TABLEシステム権限を使用すると、どの表またはビューの実表にも行を挿入できます。

構文

図insert.epsの説明

DML RETURNING句は次のとおりです。

図return.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	INSERT文をどのデータベースについて実行するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 値がdb_nameのホスト変数。この句を省略した場合、INSERT文はデフォルトのデータベースに対して実行されます。
FOR :host_integer 整数	VALUES句に配列ホスト変数が含まれる場合に、文を実行する回数を制限します。この句を省略した場合、Oracleは最小の配列の各コンポーネントにつき1回ずつ文が実行されます。
schema	表またはビューを含むスキーマ。schemaを省略した場合、Oracleでは表またはビューが自分のスキーマ内にあるとみなされます。
table view	行を挿入する表の名前。ビューを指定すると、Oracleではそのビューの実表に行が挿入されます。
db_link	表またはビューがあるリモート・データベースへのデータベース・リンクの完全名または部分名。 Oracleを分散オプションで使用している場合にのみ、リモートの表またはビューに行を挿入できます。 `dblink`を省略した場合、Oracleでは表またはビューがローカル・データベース内にあるとみなされます。
part_name	表のパーティションの名前。
column	このリストから表の列を削除する場合、挿入された行の列値は、表の作成時に指定した列のデフォルト値となります。列のリストを完全に省略した場合は、VALUES句または問合せによって、表のすべての列の値を指定する必要があります。
VALUES	表またはビューに挿入される値の行を指定します。構文については、『Oracle Database SQL言語リファレンス』を参照してください。式には、ホスト変数とオプションの標識変数を使用できます。VALUES句では、列のリストの各列に式を指定する必要があります。
subquery	表に挿入される行を戻す副問合せ。この副問合せの選択リストの列数は、INSERT文の列のリストの列数と同じであることが必要です。副問合せの構文記述については、SELECTを参照してください。
DML RETURNING句	DML RETURNING句を参照してください。

使用上のノート

WHERE句内のホスト変数は、すべてスカラーか、すべて配列である必要があります。変数がスカラーの場合、OracleはINSERT文を1回実行します。変数が配列の場合、OracleはINSERT文を各配列コンポーネント・セットについて1回ずつ実行して、1行ずつ挿入します。

WHERE句の配列ホスト変数は、サイズが異なっていてもかまいません。この場合、Oracleが文を実行する回数は、次のうちの小さい方の値によって決定します。

最小の配列のサイズ
オプションのFOR句の:host_integerの値。

この文の詳細は、INSERT文を参照してください。

例I

この例では、埋込みSQL INSERT文の使用方法を示しています。

EXEC SQL 
     INSERT INTO emp (ename, empno, sal) 
     VALUES (:ename, :empno, :sal) ;

例II

この例では、副問合せを使用した埋込みSQLのINSERT文を示します。

EXEC SQL 
   INSERT INTO new_emp (ename, empno, sal) 
   SELECT ename, empno, sal FROM emp
   WHERE deptno = :deptno ;

関連項目

E.41 LOB APPEND (実行可能埋込みSQL拡張機能)

用途

LOBを別のLOBの最後に追加します。

前提条件

LOBバッファリングは使用可能にしないでください。宛先LOBが初期化されている必要があります。

構文

図lobapp.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、APPENDを参照してください。

関連項目

他のLOB文を参照してください。

E.42 LOB ASSIGN (実行可能埋込みSQL拡張機能)

用途

LOBまたはBFILEロケータを別のロケータに割り当てます。

構文

図lobass.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、ASSIGNを参照してください。

関連項目

他のLOB文を参照してください。

E.43 LOB CLOSE (実行可能埋込みSQL拡張機能)

用途

オープンされているLOBまたはBFILEをクローズします。

構文

図lobclose.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、CLOSE (LOB用)を参照してください。

関連項目

他のLOB文を参照してください。

E.44 LOB COPY (実行可能埋込みSQL拡張機能)

用途

LOB値の全部または一部を別のLOBにコピーします。

構文

図lobcop.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、COPYを参照してください。

関連項目

他のLOB文を参照してください。

E.45 LOB CREATE TEMPORARY (実行可能埋込みSQL拡張機能)

用途

一時LOBを作成します。

構文

図lobcreat.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、CREATE TEMPORARYを参照してください。

関連項目

他のLOB文を参照してください。

E.46 LOB DESCRIBE (実行可能埋込みSQL拡張機能)

用途

LOBから属性を取り出します。

構文

図lobdesc.epsの説明

attribは次のとおりです。

図lobatt.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、DESCRIBEを参照してください。

関連項目

他のLOB文を参照してください。

E.47 LOB DISABLE BUFFERING (実行可能埋込みSQL拡張機能)

用途

LOBバッファリングを使用禁止にします。

構文

図lobdisab.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、DISABLE BUFFERINGを参照してください。

関連項目

他のLOB文を参照してください。

E.48 LOB ENABLE BUFFERING (実行可能埋込みSQL拡張機能)

用途

LOBバッファリングを有効にします。

構文

図lobenab.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、ENABLE BUFFERINGを参照してください

関連項目

他のLOB文を参照してください。

E.49 LOB ERASE (実行可能埋込みSQL拡張機能)

用途

指定されたオフセットから始まる指定された量のLOBデータを消去します。

構文

図loberas.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、ERASEを参照してください。

関連項目

他のLOB文を参照してください。

E.50 LOB FILE CLOSE ALL (実行可能埋込みSQL拡張機能)

用途

カレント・セッションでオープンしているすべてのBFILEをクローズします。

構文

図lobficl.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、FILE CLOSE ALLを参照してください。

関連項目

他のLOB文を参照してください。

E.51 LOB FILE SET (実行可能埋込みSQL拡張機能)

用途

BFILEロケータのDIRECTORYおよびFILENAMEを設定します。

構文

図lobfise.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、FILE SETを参照してください。

関連項目

他のLOB文を参照してください。

E.52 LOB FLUSH BUFFER (実行可能埋込みSQL拡張機能)

用途

LOBのバッファをデータベース・サーバーに書き込みます。

構文

図lobflbuf.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、FLUSH BUFFERを参照してください。

関連項目

他のLOB文を参照してください。

E.53 LOB FREE TEMPORARY (実行可能埋込みSQL拡張機能)

用途

LOBロケータ用に一時領域を解放します。

構文

図lobfrtem.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、FREE TEMPORARYを参照してください。

関連項目

他のLOB文を参照してください。

E.54 LOB LOAD (実行可能埋込みSQL拡張機能)

用途

BFILEの全部または一部を、内部LOBにコピーします。

構文

図loblofr.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、LOAD FROM FILEを参照してください。

関連項目

他のLOB文を参照してください。

E.55 LOB OPEN (実行可能埋込みSQL拡張機能)

用途

読取りまたは読取り/書込みを行うLOBまたはBFILEをオープンします。

構文

図lobopen.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、OPEN (LOB用)を参照してください。

関連項目

他のLOB文を参照してください。

E.56 LOB READ (実行可能埋込みSQL拡張機能)

用途

LOBまたはBFILEの一部をバッファに読み込みます。

構文

図lobread.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、READを参照してください。

関連項目

他のLOB文を参照してください。

E.57 LOB TRIM (実行可能埋込みSQL拡張機能)

用途

LOB値を切り捨てます。

構文

図lobtrim.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、TRIMを参照してください。

関連項目

他のLOB文を参照してください。

E.58 LOB WRITE (実行可能埋込みSQL拡張機能)

用途

バッファの内容をLOBに書き込みます。

構文

図lobwri.epsの説明

使用上のノート

使用上のノート、キーワード、パラメータおよび例は、WRITEを参照してください。

関連項目

他のLOB文を参照してください。

E.59 OBJECT CREATE (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内に参照可能なオブジェクトを作成します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objcrea.epsの説明

tabは次のとおりです。

図objtab.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT CREATEを参照してください。

例

person *pers_p;
person_ind *pers_ind;
person_ref *pers_ref;
...
EXEC SQL OBJECT CREATE :pers_p:pers_ind TABLE PERSON_TAB
          RETURNING REF INTO :pers_ref ;

関連項目

この付録における他のすべてのOBJECT文を参照してください。

E.60 OBJECT DELETE (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内の永続オブジェクトまたはオブジェクトの配列を削除済としてマークします。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objdel.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT DELETEを参照してください。

例

customer *cust_p;
...
EXEC SQL OBJECT DELETE :cust_p;

関連項目

この付録にある他のすべてのOBJECT文を参照してください。永続オブジェクトの場合、この文はオブジェクト・キャッシュ内のオブジェクトまたはオブジェクトの配列を削除済としてマーク設定します。

E.61 OBJECT DEREF (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内にオブジェクトまたはオブジェクトの配列を保持します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objder.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT DEREFを参照してください。

例

person *pers_p;
person_ref *pers_ref;
...
/* Pin the person REF, returning a pointer to the person object */
EXEC SQL OBJECT DEREF :pers_ref INTO :pers_p;

関連項目

この付録にある他のすべてのOBJECT文を参照してください。ALLOCATE(実行可能埋込みSQL拡張機能)を参照してください。

E.62 OBJECT FLUSH (実行可能埋込みSQL拡張機能)

用途

更新済、削除済または作成済としてマーク設定された永続オブジェクトを、サーバーに反映します。この処理はフラッシュと呼ばれます。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objflu.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT FLUSHを参照してください。

例

person *pers_p;
...
EXEC SQL OBJECT DELETE :pers_p;
/* Flush the changes, effectively deleting the person object */
EXEC SQL OBJECT FLUSH :pers_p;
/* Finally, free all object cache memory and logoff */
EXEC SQL OBJECT CACHE FREE ALL;
EXEC SQL COMMIT WORK RELEASE;

関連項目

この付録にある他のすべてのOBJECT文を参照してください。

E.63 OBJECT GET (実行可能埋込みSQL拡張機能)

用途

オブジェクト型の属性をネイティブなC言語のデータ型に変換します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objget.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT GETを参照してください。

例

person *pers_p;
struct { char lname[21], fname[21]; int age; } pers;
...
/* Convert object types to native C types */
EXEC SQL OBJECT GET lastname, firstname, age FROM :pers_p INTO :pers;
printf("Last Name: %s\nFirstName: %s\nAge: %d\n",
        pers.lname, pers.fname, pers.age );

関連項目

この付録にある他のすべてのOBJECT文を参照してください。

E.64 OBJECT RELEASE (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内のオブジェクトを解放します。オブジェクトが確保されず、更新もされなければ、暗黙的な解放の対象になります。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objrel.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT RELEASEを参照してください。

例

person *pers_p;
...
EXEC SQL OBJECT RELEASE :pers_p;

関連項目

この付録にある他のすべてのOBJECT文を参照してください。

E.65 OBJECT SET (実行可能埋込みSQL拡張機能)

用途

永続オブジェクトの属性を更新し、オブジェクトのフラッシュ時、またはキャッシュのフラッシュ時にサーバーへの書込み対象にします。

一時オブジェクトの属性を更新します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objset.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT FLUSHを参照してください。

例

person *pers_p;
struct {int num; char street[61], city[31], state[3], zip[11];} addr1;
...
addr1.num = 500;
strcpy((char *)addr1.street , (char *)"Oracle Parkway");
strcpy((char *)addr1.city,    (char *)"Redwood Shores");
strcpy((char *)addr1.state,   (char *)"CA");
strcpy((char *)addr1.zip,     (char *)"94065");

/* Convert native C types to object types */
EXEC SQL OBJECT SET :pers_p->addr TO :addr1;

関連項目

この付録にある他のすべてのOBJECT文を参照してください。

E.66 OBJECT UPDATE (実行可能埋込みSQL拡張機能)

用途

オブジェクト・キャッシュ内の永続オブジェクトまたはオブジェクトの配列を更新済としてマーク設定します。

前提条件

プリコンパイラ・オプションOBJECTSをYESに設定する必要があります。INTYPEオプションでは、OTTによって生成される型ファイルを指定する必要があります。OTTによって生成されるヘッダー・ファイルをプログラムにインクルードしてください。

構文

図objupd.epsの説明

使用上のノート

使用上のノート、キーワードおよびパラメータは、OBJECT UPDATEを参照してください。

例

person *pers_p;
...
/* Mark as updated */
EXEC SQL OBJECT UPDATE :pers_p;

関連項目

この付録にある他のすべてのOBJECT文を参照してください。

E.67 OPEN (実行可能埋込みSQL)

用途

対応付けられた問合せを評価し、USING句が示すホスト変数名を問合せのWHERE句に代入して、カーソルをオープンします。ANSI動的SQL方法4バージョンについては、OPEN DESCRIPTOR(実行可能埋込みSQL)を参照してください。

前提条件

カーソルは、オープンする前に埋込みSQLのDECLARE CURSOR文を使用して宣言しておく必要があります。

構文

図openo.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
array_size integer	処理される行の数を格納するホスト変数。処理される行数。
cursor	オープンする(すでに宣言されている)カーソル。
host_variable	カーソルに対応付けられた文に代入するホスト変数を指定します。 ANSI記述子(INTO句)と一緒には使用できません。
DESCRIPTOR SQLDA_descriptor	対応付けられた問合せのWHERE句に代入するホスト変数を表すOracle記述子を指定します。記述子は、DESCRIBE文を使用して事前に初期化されている必要があります。代入は、位置に基づきます。この文で指定するホスト変数名は、対応付けられた問合せの変数名と異なってもかまいません。 ANSI記述子(INTO句)と一緒には使用できません。

使用上のノート

OPEN文は、行のアクティブ・セットを定義し、アクティブ・セットの最初の行の直前でカーソルを初期化します。OPEN時のホスト変数の値が文に代入されます。この文は、実際には行を取り出しません。行はFETCH文を使用して取り出されます。

カーソルを一度オープンすると、入力ホスト変数はカーソルを再オープンするまで再テストされません。入力ホスト変数およびアクティブ・セットを変更するには、カーソルを再オープンする必要があります。

プログラム内のすべてのカーソルは、プログラムを開始する場合またはCLOSE文を使用してカーソルを明示的にクローズした後にクローズ状態になります。

カーソルは事前にクローズしなくても、再オープンできます。この文の詳細は、INSERT文を参照してください。

例

この例では、Pro*C/C++プログラムでOPEN文を使用する方法を示しています。

EXEC SQL DECLARE emp_cursor CURSOR FOR 
    SELECT ename, empno, job, sal 
    FROM emp 
    WHERE deptno = :deptno; 
EXEC SQL OPEN emp_cursor;

関連項目

E.68 OPEN DESCRIPTOR (実行可能埋込みSQL)

用途

対応付けられた問合せを評価し、USING句が示す入力ホスト変数名を問合せのWHERE句に代入して、カーソル(ANSI動的SQL方法4用)をオープンします。INTO句は、出力記述子を示します。

前提条件

カーソルは、オープンする前に埋込みSQLのDECLARE CURSOR文を使用して宣言しておく必要があります。

構文

図opena.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
array_size integer	処理される行の数を格納するホスト変数。処理される行数。
cursor	オープンする(すでに宣言されている)カーソル。
USING DESCRIPTOR	ANSI入力記述子を指定します。
descriptor_name	ANSI記述子の名前が含まれるホスト変数。
'descriptor name'	ANSI記述子の名前。
INTO DESCRIPTOR	ANSI出力記述子を指定します。
descriptor_name	ANSI記述子の名前が含まれるホスト変数。
'descriptor name'	ANSI記述子の名前。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。

使用上のノート

プリコンパイラのオプションDYNAMICにANSIを設定します。

OPEN文は、行のアクティブ・セットを定義し、アクティブ・セットの最初の行の直前でカーソルを初期化します。OPEN時のホスト変数の値がSQL文に代入されます。この文は、実際には行を取り出しません。行はFETCH文を使用して取り出されます。

カーソルを一度オープンすると、入力ホスト変数はカーソルを再オープンするまで再テストされません。入力ホスト変数およびアクティブ・セットを変更するには、カーソルを再オープンする必要があります。

プログラム内のすべてのカーソルは、プログラムを開始する場合またはCLOSE文を使用してカーソルを明示的にクローズした後にクローズ状態になります。

カーソルは事前にクローズしなくても、再オープンできます。この文の詳細は、INSERT文を参照してください。

例

char dyn_statement[1024] ;
...
EXEC SQL ALLOCATE DESCRIPTOR 'input_descriptor' ;
EXEC SQL ALLOCATE DESCRIPTOR 'output descriptor'
...
EXEC SQL PREPARE S FROM :dyn_statement ;
EXEC SQL DECLARE C CURSOR FOR S ;
...
EXEC SQL OPEN C USING DESCRIPTOR 'input_descriptor' ;
...

関連項目

FETCH DESCRIPTOR (実行可能埋込みSQL)

E.69 PREPARE (実行可能埋込みSQL)

用途

ホスト変数で指定するSQL文またはPL/SQLブロックを解析し、識別子に対応付けます。

前提条件

なし。

構文

図prepare.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
statement_id	準備済のSQL文またはPL/SQLブロックに対応付ける識別子。この識別子がすでに別の文またはブロックに割り当てられている場合は、以前の割当てが置き換えられます。
db_name	CONNECT文で先に設定されるデータベース接続名を含むNULL終了文字列。省略した場合または空文字の場合は、デフォルトのデータベース接続とみなされます。
host_variable	データベース接続名を格納するホスト変数。
text	準備するSQL文またはPL/SQLブロックを含む文字列リテラル。
select_command	選択文。

使用上のノート

host_stringまたはtextの変数はすべてプレースホルダです。実際のホスト変数名は、OPEN文のUSING句(入力ホスト変数)またはFETCH文のINTO句(出力ホスト変数)で割り当てます。

SQL文は一度準備すると、何回でも実行できます。詳細は、PREPARE(動的SQL)を参照してください。

例

この例では、Pro*C/C++の埋込みSQLプログラムにおけるPREPARE文の使用方法を示します。

EXEC SQL PREPARE my_statement FROM :my_string; 
EXEC SQL EXECUTE my_statement;

関連項目

FETCH DESCRIPTOR (実行可能埋込みSQL)

OPEN (実行可能埋込みSQL) 。

E.70 REGISTER CONNECT (実行可能埋込みSQL拡張機能)

用途

外部CプロシージャをPro*C/C++アプリケーションからコールできるようにします。

前提条件

なし。

構文

図regconn.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
ext_proc_ctxt	PL/SQLによってプロシージャに渡される外部プロシージャ・コンテキスト。OCIExtProcContextへのタイプ・ポインタです。
context	戻されるランタイム・コンテキスト。sql_context型になります。現在の設定は、デフォルト(グローバル)・コンテキストです。

使用上のノート

外部プロシージャを作成する方法および有効な制限の詳細は、「外部プロシージャ」を参照してください。

例

void myfunction(epctx)
OCIExtProcContext *epctx;
sql_context context;
...
{
EXEC SQL REGISTER CONNECT USING :epctx ;
EXEC SQL USE :context;
...

関連項目

なし。

E.71 ROLLBACK (実行可能埋込みSQL)

用途

現行のトランザクションで実行した作業を取り消します。

この文は、インダウトの分散トランザクションの処理を手動で取り消すときにも使用できます。

前提条件

現行のトランザクションをロールバックする場合、権限は不要です。

ユーザーがコミットしたインダウトの分散トランザクションを手動でロールバックするには、FORCE TRANSACTIONのシステム権限が必要です。他のユーザーがコミットしたインダウトの分散トランザクションを手動でロールバックするには、FORCE ANY TRANSACTIONのシステム権限が必要です。

構文

図rollb.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	セーブポイントをどのデータベースに対して作成するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: 事前にCONNECT文で確立されたデータベース接続の名前を含み、ヌル文字で終了する文字列。省略した場合または空文字の場合は、デフォルトのデータベース接続とみなされます。 host_variable: データベース接続の名前を含むホスト変数。この句を省略した場合、セーブポイントはデフォルトのデータベースに対して作成されます。
WORK	オプションで、ANSIとの互換性のために用意されています。
TO	指定したセーブポイントまでカレント・トランザクションをロールバックします。この句を省略した場合、ROLLBACK文はトランザクション全体をロールバックします。
FORCE	インダウトの分散トランザクションを手動でロールバックします。トランザクションは、ローカル・トランザクションIDまたはグローバル・トランザクションIDを含むテキストにより指定します。このようなトランザクションのIDを検索するには、データ・ディクショナリ・ビューDBA_2PC_PENDINGに問合せをします。 ROLLBACK文でのFORCE句の使用はPL/SQLではサポートされていません。
RELEASE	リソースをすべて解放し、アプリケーションをデータベースから切断します。RELEASE句は、SAVEPOINT句およびFORCE句とは併用できません。
savepoint	ロールバックするセーブポイント

使用上のノート

トランザクション(または論理作業単位)は、Oracleが1つの単位として扱う一連のSQL文です。トランザクションは、COMMIT文、ROLLBACK文またはデータベースへの接続後の、最初の実行SQL文から始まります。トランザクションは、COMMIT文、ROLLBACK文またはデータベースからの切断(意図的かどうかに関係なく)で終了します。Oracleでは、データ定義言語文の処理前および処理後に暗黙的なCOMMIT文が発行されます。

TO SAVEPOINT句を指定せずにROLLBACK文を使用すると、次の処理が実行されます。

トランザクションを終了します。
現行のトランザクションに対するすべての変更の取消し
トランザクション内のすべてのセーブポイントが消去されます。
トランザクションのロックが解除されます。

TO SAVEPOINT句を指定してROLLBACK文を使用すると、次の処理が実行されます。

トランザクションのセーブポイント後の部分のみがロールバックされます。
指定したセーブポイントの後に作成したセーブポイントがすべて消去されます。名前付きのセーブポイントが保持されるため、複数回同じセーブポイントにロールバックできます。指定したセーブポイントより前に作成されたセーブポイントも残ります。
指定したセーブポイント以降に取得されたすべての表と行のロックの解除。セーブポイント後にロックされた行へのアクセスを要求した他のトランザクションは、コミットまたはロールバックされるまで待つ必要があります。行を要求していない他のトランザクションは、すぐに行の要求およびアクセスができます。

アプリケーション・プログラムでは、COMMIT文またはROLLBACK文を使用してトランザクションを明示的に終了することをお薦めします。トランザクションを明示的にコミットしなかった場合にプログラムが異常終了すると、Oracleはコミットされていない最後のトランザクションをロールバックします。

例1

次の文はカレント・トランザクション全体をロールバックします。

EXEC SQL ROLLBACK;

例2

次の文はカレント・トランザクションをセーブポイントSP5までロールバックします。

EXEC SQL ROLLBACK TO SAVEPOINT sp5;

分散トランザクション

Oracleで分散オプションを使用すると、分散トランザクション、または複数データベース上のデータを変更するトランザクションが可能になります。分散トランザクションをコミットまたはロールバックするには、他のトランザクションと同じようにCOMMIT文またはROLLBACK文を発行するだけで済みます。

分散トランザクションのコミット・プロセス中にネットワーク障害が発生すると、トランザクションの状態が不明、つまりインダウトになる可能性があります。そのトランザクションに関連する他のデータベースの管理者に問い合せて、ローカル・データベースのトランザクションを手動でコミットするか、ロールバックするかを決定できます。ローカル・データベースのトランザクションを手動でロールバックするには、FORCE句を指定してROLLBACK文を発行します。

インダウトのトランザクションを手動でセーブポイントまでロールバックすることはできません。

FORCE句を指定したROLLBACK文は、指定したトランザクションのみロールバックします。この文は、現行のトランザクションには影響しません。

例3

次の文は、インダウト分散トランザクションを手動でロールバックします。

EXEC SQL
    ROLLBACK WORK
    FORCE '25.32.87' ;

関連項目

SAVEPOINT (実行可能埋込みSQL)

E.72 SAVEPOINT (実行可能埋込みSQL)

用途

後でロールバックする位置をトランザクション内に指定します。

前提条件

なし。

構文

図savep.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	セーブポイントをどのデータベースに対して作成するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、セーブポイントはデフォルトのデータベースに対して作成されます。
savepoint	作成するセーブポイントの名前。

説明

AT

セーブポイントをどのデータベースに対して作成するかを指定します。次のいずれかを使用してデータベースを指定します。

db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。

host_variable: 事前に宣言したdb_nameの値を持つホスト変数。

この句を省略した場合、セーブポイントはデフォルトのデータベースに対して作成されます。

savepoint

作成するセーブポイントの名前。

使用上のノート

この文の詳細は、SAVEPOINT文の使用を参照してください。

例

この例では、埋込みSQLのSAVEPOINT文の使用方法を示します。

EXEC SQL SAVEPOINT save3;

関連項目

ROLLBACK (実行可能埋込みSQL)

E.73 SELECT (実行可能埋込みSQL)

用途

選択した値をホスト変数に割り当てて、1つ以上の表、ビューまたはスナップショットからデータを取り出します。

前提条件

表またはスナップショットからデータを選択するには、表またはスナップショットがユーザーのスキーマ内にあるか、あるいは表またはスナップショットに対してSELECTの権限を持っている必要があります。

ビューの実表から行を選択するには、ビューが属するスキーマの所有者が、実表に対してSELECTの権限を持っている必要があります。また、ビューが自分のスキーマ以外のスキーマ内にある場合は、ビューに対してSELECTの権限を持つ必要があります。

SELECT ANY TABLEのシステム権限を使用すると、すべての表、スナップショット、ビューの実表からデータを選択できます。

構文

図select.epsの説明

select_b.gifの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	どのデータベースに対してSELECT文を発行するかを指定します。次のいずれかを使用してデータベースを指定します。 db_name: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、SELECT文はデフォルトのデータベースに対して発行されます。
select_list	非埋込みSELECT文と同じですが、リテラルのかわりにホスト変数を使用できます。
INTO	SELECT文が戻すデータを受け取る出力ホスト変数とオプションの標識変数を指定します。これらの変数は、すべてスカラーか、すべて配列である必要があります。ただし、配列は同じサイズでなくてもかまいません。
WHERE	戻される行を、条件がTRUEの行のみに制限します。conditionの構文は、「条件」を参照してください。条件には、ホスト変数は使用できますが、標識変数は使用できません。これらのホスト変数はスカラーである必要があり、配列は使用できません。その他のキーワードおよびパラメータは、非埋込みSQLのSELECT文と同じです。ORDER BY句のデフォルトは、昇順を示すASCです。

使用上のノート

WHERE句の条件を満たす行が存在しない場合、行は取り出されず、OracleはSQLCAのSQLCODEコンポーネントを使用してエラー・コードを戻します。

SELECT文でコメントを使用して、指示(つまりヒント)をオプティマイザに渡すことができます。

例

この例では、埋込みSQLのSELECT文の使用方法を示します。

EXEC SQL SELECT ename, sal + 100, job 
    INTO :ename, :sal, :job 
    FROM emp 
    WHERE empno = :empno;

関連項目

EXECUTE (実行可能埋込みSQL)。

E.74 SET DESCRIPTOR (実行可能埋込みSQL)

用途

ANSI動的SQL文を使用して、ホスト変数の記述子領域内の情報を設定します。

前提条件

DESCRIBE DESCRIPTOR文の後に使用します。

構文

図setdesc.epsの説明

item_nameのみ次の中から選択できます。

図setdnc.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
array_size integer	処理される行の数を格納するホスト変数。処理される行数。配列サイズの句は、DATA、RETURNED_LENGTHおよびINDICATORの項目名でのみ使用できます。
GLOBAL \| LOCAL	LOCAL (デフォルト)はファイルのスコープで、GLOBALはアプリケーションのスコープです。
descriptor_name 'descriptor name'	割り当てられたANSI記述子名を格納するホスト変数。割り当てられたANSI記述子の名前。
COUNT	入力変数または出力変数の数。
VALUE	参照されるホスト変数の位置。
item_name	item_namesのリストおよび説明は、表10-6および表10-7を参照してください。
host_integer integer	項目またはCOUNTまたはVALUEの設定に使用するホスト変数。 COUNTまたはVALUEの設定に使用する整数。
host_var	記述子項目の設定に使用するホスト変数。
REF	参照セマンティクスが使用されます。RETURNED_LENGTH、DATAおよびINDICATORの項目名以外では使用できません。 RETURNED_LENGTHを設定するときに使用する必要があります。

使用上のノート

DYNAMIC=ANSIプリコンパイラ・オプションを使用してください。

クライアント側でUnicodeをサポートするには、CHARACTER_SET_NAMEにUTF16を設定します。

記述子項目名の表などの詳細は、SET DESCRIPTORを参照してください。

例

EXEC SQL SET DESCRIPTOR GLOBAL :mydescr COUNT = 3 ;

関連項目

DEALLOCATE DESCRIPTOR (埋込みSQL文)。

DESCRIBE(実行可能埋込みSQL拡張機能)

VAR (Oracle埋込みSQLディレクティブ)

E.75 TYPE (Oracle埋込みSQLディレクティブ)

用途

ユーザー定義型の同値化を行うか、外部データ型をユーザー定義のデータ型に同値化することで、外部データ型をホスト変数のクラス全体に割り当てます。

前提条件

ユーザー定義のデータ型は、埋込みSQLプログラムで事前に宣言する必要があります。

構文

図type.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
type	外部データ型と同値化するユーザー定義データ型。
datatype	プリコンパイラによって認識される内部データ型ではない外部データ型。データ型には、長さ、精度または位取りを含めることができます。この外部データ型は、ユーザー定義型と同値化された後に、型が割り当てられているホスト変数すべてに割り当てられます。外部データ型のリストは、Oracleのデータ型を参照してください。
REFERENCE	同値化した型をポインタ型にします。

使用上のノート

ユーザー定義型の同値化は、データ型の同値化の一種です。Pro*C/C++プログラムでは、ユーザー定義型を同値化するには、埋込みSQLのTYPE文を使用する必要があります。データ型の同値化は、次のいずれかの目的で使用します。

文字ホスト変数を自動的にヌル文字で終了します。
プログラム・データをバイナリ・データとしてデータベースに格納します。
デフォルトのデータ型のかわりに使用します。

Pro*C/C++では、VARCHARおよびVARRAW配列がワード整列されているものとみなされます。配列型をVARCHARまたはVARRAWデータ型に同値化する場合は、長さ+2が4で割り切れる数になっていることを確認してください。

Pro*C/C++では、ホスト変数の同値化のための埋込みSQL VAR文もサポートされています。詳細は、ユーザー定義型同値化を参照してください。

例I

この例では、Pro*C/C++のプリコンパイラ・プログラムにおける埋込みSQL TYPE文を示します。

struct screen {
    short len; 
    char  buff[4002];
}; 

typedef struct screen graphics; 

    EXEC SQL TYPE graphics IS VARRAW(4002); 
    graphics crt;  -- host variable of type graphics 
    ...

関連項目

E.76 UPDATE (実行可能埋込みSQL)

用途

表またはビューの実表の既存の値を変更します。

前提条件

表またはスナップショットの値を更新するには、表がユーザーのスキーマ内にあるか、または表に対してUPDATEの権限を持っている必要があります。

ビューの実表の値を更新するには、ビューが属するスキーマの所有者が、実表に対してUPDATEの権限を持っている必要があります。また、ビューがユーザーのスキーマ以外のスキーマ内にある場合は、ビューに対してUPDATEの権限を持っている必要があります。

UPDATE ANY TABLEのシステム権限により、すべての表またはビューの実表の値も更新できます。

構文

図update.epsの説明

DML RETURNING句は次のとおりです。

図return.epsの説明

キーワードおよびパラメータ

キーワードおよびパラメータ	説明
AT	UPDATE文の発行先のデータベースを識別します。次のいずれかを使用してデータベースを指定します。 dbname: DECLARE DATABASE文を使用して事前に宣言したデータベース識別子。 host_variable: 事前に宣言したdb_nameの値を持つホスト変数。この句を省略した場合、UPDATE文はデフォルトのデータベースに対して発行されます。
FOR :host_integer integer	SET句およびWHERE句が配列ホスト変数を含む場合に、UPDATE文を実行する回数を制限します。この句を省略した場合、Oracleは最小の配列の各コンポーネントにつき1回ずつ文が実行されます。
schema	表またはビューを含むスキーマ。schemaを省略した場合、Oracleでは表またはビューが自分のスキーマ内にあるとみなされます。
table、view	更新する表の名前。ビューを指定すると、Oracleではそのビューの実表が更新されます。
dblink	表またはビューがあるリモート・データベースへのデータベース・リンクの完全または部分的な名前。データベース・リンクの参照の詳細は、Oracle Database SQL言語リファレンスを参照してください。データベース・リンクを使用してリモートの表またはビューを更新できるのは、Oracleで分散オプションを使用している場合のみです。
part_name	表のパーティションの名前。
column	表またはビューで更新する列の名前。SET句から表の列を削除する場合、その列の値は変更されません。
expr	対応する列に割り当てる新しい値。この式には、ホスト変数およびオプションの標識変数を含めることができます。
subquery_1	対応する列に割り当てられた新しい値を戻す副問合せ。副問合せの構文は、SELECTを参照してください。
subquery_2	対応する列に割り当てられた新しい値を戻す副問合せ。副問合せの構文は、SELECTを参照してください。
WHERE	更新される表またはビューの行を指定します。
condition CURRENT OF	この条件がTRUEの行のみを更新します。この条件には、ホスト変数およびオプションのインジケータ変数を含めることができます。条件の構文は、条件を参照してください。カーソルによって最後にフェッチされた行のみを更新します。結合を実行するSELECT文にカーソルを対応付けるには、FOR UPDATE句で明示的に1つの表のみをロックするほかに方法はありません。この句を完全に省略した場合、表またはビューのすべての行が更新されます。
DML RETURNING句	DML RETURNING句を参照してください。

使用上のノート

SET句およびWHERE句に含まれるホスト変数は、すべてスカラーか、またはすべて配列であることが必要です。変数がスカラーの場合、OracleはUPDATE文を1回のみ実行します。変数が配列の場合、Oracleは配列のコンポーネント・セットごとに1回ずつこの文を実行します。1回の実行で、0行または1行、複数行を更新できます。

配列ホスト変数は、サイズが異なってもかまいません。この場合、Oracleが文を実行する回数は、次のうちの小さい方の値によって決定します。

最小の配列のサイズ
オプションのFOR句の:host_integerの値

更新された行の累積数は、SQLCAのSQLERRDコンポーネントの第3要素に設定されて戻されます。入力ホスト変数として配列を使用した場合、この数値はUPDATE文で処理された配列のすべてのコンポーネントにおよぶ更新数の合計を示します。この条件を満たす行が存在しない場合、行は更新されず、OracleはSQLCAのSQLCODE要素を通じてエラー・メッセージを戻します。WHERE句を省略した場合は、すべての行が更新され、OracleはSQLCAのSQLWARN要素の第5コンポーネントに警告フラグを設定します。

UPDATE文においてコメントを使用して、指示やヒントをオプティマイザに渡すことができます。オプティマイザは、これらのヒントを使用して文の実行計画を選択します。

この文の詳細は、埋込みSQLおよびデータベースの概要を参照してください。

例

次の例では、埋込みSQLのUPDATE文の使用方法を示します。

EXEC SQL UPDATE emp 
    SET sal = :sal, comm = :comm INDICATOR :comm_ind 
    WHERE ename = :ename; 
 
EXEC SQL UPDATE emp 
    SET (sal, comm) = 
        (SELECT AVG(sal)*1.1, AVG(comm)*1.1 
         FROM emp) 
    WHERE ename = 'JONES';

関連項目