CREATE PROCEDURE

SQL ストアド・プロシージャとして公開されるメソッドまたはクエリを生成します。

Synopsis

CREATE PROCEDURE procname(parameter_list) characteristics language
    code_body

CREATE PROC procname(parameter_list) characteristics language
   code_body

引数

procname	生成するストアド・プロシージャの名前。識別子です。このプロシージャ名には、修飾なし (StoreName) と修飾付き (Patient.StoreName) のどちらでも使用できます。パラメータを指定しない場合でも、procname の後には括弧を続ける必要があります。
parameter_list	オプション — プロシージャに渡すパラメータのリスト。パラメータのリストは括弧で囲み、パラメータはコンマで区切ります。パラメータを指定しない場合でも、括弧は必須です。各パラメータは、(先頭から順に) オプションの IN、OUT、または INOUT キーワード、変数名、データ型で構成します。
characteristics	オプション — プロシージャの特性を指定する 1 つまたは複数のキーワード。メソッドを生成する際に許可されるキーワードは FINAL、FOR、PRIVATE、RETURNS、SELECTMODE です。クエリを生成する際に許可されるキーワードは CONTAINID、FINAL、FOR、RESULTS、SELECTMODE です。複数の特性は、空白で区切り、任意の順序で指定できます。
language	オプション — code_body に使用するプログラミング言語を指定するキーワード節。LANGUAGE OBJECTSCRIPT (Caché ObjectScript の場合) または LANGUAGE SQL を指定します。language 節を省略する場合は、SQL が既定です。
code_body	プロシージャのプログラム・コード SQL プログラム・コードの開始には BEGIN キーワードを使用し、終了には END キーワードを使用します。code_body 内の完結した各 SQL 文は、セミコロン (;) で終わります。 Caché ObjectScript プログラム・コードは中括弧で囲みます。

概要

CREATE PROCEDURE 文は SQL ストアド・プロシージャとして自動的に公開されるメソッドまたはクエリを生成します。ストアド・プロシージャはサブクラスに継承されます。

LANGUAGE SQL の場合、code_body に SELECT 文を含める必要があります。
LANGUAGE OBJECTSCRIPT の場合、code_body で EXECUTE メソッドと FETCH メソッドを呼び出す必要があります。GETINFO、FETCHODBC、FETCHROWS および CLOSE メソッドを呼び出すことも可能です。

ストアド・プロシージャとして公開されないメソッドを生成するには、CREATE METHOD または CREATE FUNCTION を使用します。ストアド・プロシージャとして公開されないクエリを生成するには、CREATE QUERY を使用します。これらの文は、PROCEDURE 特性キーワードを指定することで、ストアド・プロシージャとして公開されるメソッドまたはクエリの生成にも使用できます。

プロシージャの生成には、GRANT コマンドで指定された %CREATE_PROCEDURE 管理者特権が必要です。

SQL 文内からの SQL 関数の呼び出しの詳細は、このドキュメントの "SQL の概念" のページの "関数の呼び出し" を参照してください。さまざまな状況での SQL ストアド・プロシージャの呼び出しについては、"CALL" 文を参照してください。

引数

procname

ストアド・プロシージャとして生成するメソッドまたはクエリの名前です。この名前には、修飾なし (StoreName) と、クラス名を指定する修飾付き (Patient.StoreName) のどちらでも指定できます。プロシージャの名前の後には括弧が必要です。

parameter_list

値をメソッドまたはクエリに渡すために使用するパラメータのリストです。パラメータのリストは括弧で囲み、リストのパラメータ宣言はコンマで区切ります。パラメータを指定しない場合も括弧は必須です。

リスト内の各パラメータ宣言は、(先頭から順番に) 以下の要素で構成されます。

パラメータ・モードが IN (入力値)、OUT (出力値)、または INOUT (変更値) のいずれかを指定するキーワード。
パラメータ名。
パラメータのデータ型。
オプション：キーワード DEFAULT とそれに続くパラメータの既定値 (既定値は、一重引用符で囲んだ文字列として指定)。

以下は、3 つのパラメータを持つプロシージャの例です。

CREATE PROCEDURE UpdatePay
  (IN Salary FLOAT DEFAULT '0',
   IN Name VARCHAR(50), 
   INOUT PayBracket VARCHAR(50) DEFAULT 'NULL')
BEGIN
   UPDATE Sample.Person SET Salary = :Salary
   WHERE Name=:Name ;
END

メソッドまたはクエリがストアド・プロシージャとして公開されるため、プロシージャ・コンテキスト・ハンドラによって、プロシージャとその呼び出し元 (ODBC サーバなど) 間でプロシージャ・コンテキストの相互受け渡しが行われます。このプロシージャ・コンテキスト・ハンドラは、Caché によって (%qHandle:%SQLProcContext として) %sqlcontext オブジェクトを使用して自動生成されます。

以下のようにプロシージャ・コンテキスト・ハンドラは、%SQLProcContext 型で最初のパラメータとして明示的に宣言できます。

  INOUT pHandle %SQLProcContext

%SQLProcContext の属性は SQLCode と RowCount です。これらは通常、以下のように SQL 変数 SQLCODE と %ROWCOUNT に設定されます。

SET pHandle.SQLCode=SQLCODE,pHandle.RowCount=%ROWCOUNT

SQLCODE と %ROWCOUNT の値は、SQL 文の実行によって自動的に設定されます。

characteristics

メソッドの生成にはクエリの生成とは異なる characteristics を使用します。

有効なメソッド characteristics キーワードは、以下のとおりです。

メソッド・キーワード	意味
FOR classname	メソッドを生成するクラス名を指定します。そのクラスが存在しない場合は、新規作成します。メソッド名を修飾することにより、クラス名を指定することもできます。FOR 節で指定されたクラス名の方が、メソッド名の修飾により指定されたクラス名よりも優先されます。
FINAL	サブクラスによってメソッドがオーバーライドされないように指定します。既定では、メソッドは最終ではありません。FINAL キーワードは、サブクラスによって継承されます。
PRIVATE	メソッドがそれ自身のクラス、またはサブクラスの他のメソッドによってのみ起動できることを指定します。既定ではメソッドはパブリックで、制限なしに起動できます。この制限はサブクラスによって継承されます。
RETURNS datatype	メソッドに対する呼び出しによって返される値のデータ型を指定します。RETURNS が省略されると、メソッドは値を返すことができません。この仕様はサブクラスによって継承されます。
SELECTMODE mode	メソッドのコンパイルに使用されるモードを指定します。使用可能な値は、LOGICAL、ODBC、RUNTIME、DISPLAY です。既定は LOGICAL です。

有効なクエリ characteristics キーワードは、以下のとおりです。

クエリ・キーワード	概要
CONTAINID integer	フィールドが存在する場合は、どのフィールドが ID を返すかを指定します。CONTAINID を ID を返す列の番号に設定するか、または ID を返す列が存在しない場合は 0 を設定します。Caché では、指定されたフィールドが実際に ID を含んでいるかどうかの検証が行われないため、ユーザの入力の誤りによってデータの不一致が起こる可能性があります。
FOR classname	メソッドを生成するクラス名を指定します。そのクラスが存在しない場合は、新規作成します。メソッド名を修飾することにより、クラス名を指定することもできます。FOR 節で指定されたクラス名の方が、メソッド名の修飾により指定されたクラス名よりも優先されます。
FINAL	サブクラスがメソッドをオーバーライドできないように指定します。既定では、メソッドは最終ではありません。FINAL キーワードは、サブクラスによって継承されます。
RESULTS result_set	データ・フィールドをクエリで返された順序で指定します。各フィールドには、列名、データ型 (既定で属性に割り当てられた型と異なる場合)、そしてオプションで見出しを指定します。これらフィールドの特性はコロンで区切ります。結果セット内の異なるフィールドはコンマで区切ります。 LANGUAGE SQL の場合、クエリが SELECT * でない限り RESULTS キーワードを省略することができます。RESULTS キーワードを省略する場合、ROWSPEC がクラス・コンパイル中に自動生成されます。
SELECTMODE mode	クエリをコンパイルするために使用するモードを指定します。使用可能な値は、LOGICAL、ODBC、RUNTIME、DISPLAY です。既定は RUNTIME です。

SELECTMODE はデータを返すモードを指定します。mode 値が LOGICAL の場合は、論理 (内部保存) 値が返されます。例えば、日付は $HOROLOG 形式で返されます。mode 値が ODBC の場合、論理から ODBC への変換が適用され、ODBC 形式値が返されます。mode 値が DISPLAY の場合、論理から表示への変換が適用され、表示形式値が返されます。mode 値が RUNTIME の場合、ローカル変数 %Runtime を設定して、実行時にモードを LOGICAL、ODBC、DISPLAY のいずれかに設定できます。これは、%Library.ResultSet RuntimeMode プロパティを使用して設定できます。RUNTIME モードの既定は LOGICAL です。SELECTMODE に指定した値は、#SQLCOMPILE SELECT=mode のように Caché ObjectScript クラス・メソッド・コードの最初に追加されます。

RESULTS 節は、クエリの結果を指定します。RESULTS 節の SQL データ型パラメータが、クエリの ROWSPEC の対応する Caché データ型パラメータに変換されます。例えば、RESULTS 節の RESULTS ( Code VARCHAR(15) ) では、ROWSPEC = "Code:%Library.String(MAXLEN=15)" という ROWSPEC 仕様が生成されます。

language

code_body に使用している言語を指定するキーワード節。使用可能な節は、LANGUAGE OBJECTSCRIPT (Caché ObjectScript の場合) か、LANGUAGE SQL です。LANGUAGE 節を省略する場合は、SQL が既定です。

code_body

生成されるメソッドまたはクエリのプログラム・コード。このコードは SQL または Caché ObjectScript で指定します。使用する言語は LANGUAGE 節と一致させる必要があります。ただし、Caché ObjectScript のコードには埋め込み SQL を記述できます。Caché は、メソッドまたはクエリの実際のコードを生成するために提供されたコードを使用します。

SQL プログラム・コードの開始には BEGIN キーワードを使用し、その後に SQL コード自体を続けます。完結した各 SQL 文の末尾では、セミコロン (;) を指定します。1 つのクエリに含めることができるのは、1 つの SQL 文、つまり 1 つの SELECT 文のみです。SQL プログラム・コードの終了には、END キーワードを使用します。

Caché ObjectScript プログラム・コードは、{ code } のように中括弧で囲みます。

SQL を Caché ObjectScript "ラッパ" に埋め込んだプロシージャを生成するとき、Caché によって、プロシージャ・コンテキスト・ハンドラを提供し、返り値を処理するコード行が追加されます。以下はこの Caché から生成されたラッパ・コードの例です。

   NEW SQLCODE,%ROWID,%ROWCOUNT,title
   &sql( code_body )
   QUIT $GET(title)

指定したコードが OBJECTSCRIPT の場合、(変数で NEW を実行し、QUIT で終了し、終了後に値を返す) "ラッパ" を明示的に定義する必要があります。

クエリを生成するとき、指定したコードが SQL の場合は、1 つの SELECT 文で構成する必要があります。指定したコードが OBJECTSCRIPT の場合、Caché が提供する EXECUTE メソッドと FETCH メソッドの呼び出しを含む必要があります。また、CLOSE、FetchRows、FetchODBC、GetInfo メソッド呼び出しを含めることも可能です。

例

以下の例は、ストアド・プロシージャとして公開される、PersonStateSP という名前のシンプルなクエリを作成します。このクエリでは、パラメータは宣言されず、characteristics および language に既定値が使用されます。

  WRITE !,"Creating a procedure"
  &sql(CREATE PROCEDURE PersonStateSP() BEGIN
       SELECT Name,Home_State FROM Sample.Person ;
       END)
  IF SQLCODE=0 { WRITE !,"Created a procedure" }
  ELSEIF SQLCODE=-361 { WRITE !,"Procedure already exists" }
  ELSE { WRITE !,"SQL error: ",SQLCODE }

システム管理ポータルで、[クラス] オプションを選択し、SAMPLES ネームスペースを選択します。上の例で作成したストアド・プロシージャの User.procPersonStateSP.cls を見つけます。上のプログラム例を再実行する前に、ここでこのプロシージャを削除できます。もちろん、DROP PROCEDURE を使用してプロシージャを削除できます。

  WRITE !,"Deleting a procedure"
  &sql(DROP PROCEDURE SAMPLES.PersonStateSP)
  IF SQLCODE=0 { WRITE !,"Deleted a procedure" }
  ELSEIF SQLCODE=-362 { WRITE !,"Procedure did not exist" }
  ELSE { WRITE !,"SQL error: ",SQLCODE }

以下の例は、CREATE PROCEDURE を使用して、Sample.Employee クラスに UpdateSalary メソッドを生成します。

CREATE PROCEDURE UpdateSalary ( IN SSN VARCHAR(11), IN Salary FLOAT )
   FOR Sample.Employee
   BEGIN
     UPDATE Sample.Employee SET Salary = :Salary WHERE SSN = :SSN;
   END

以下の例は、Caché ObjectScript コードで CREATE PROCEDURE を使用して、Sample.Employee クラスに GetTitle メソッドを生成し、Title 値を返します。

CREATE PROCEDURE Sample_Employee.GetTitle( 
   INOUT pHandle %SQLProcContext, 
   IN SSN VARCHAR(11), 
   INOUT Title VARCHAR(50) )
    RETURNS VARCHAR(30)
    FOR Sample.Employee
    LANGUAGE OBJECTSCRIPT
    {
        NEW SQLCODE,%ROWCOUNT
        &sql(SELECT Title INTO :Title FROM Sample.Employee 
             WHERE SSN = :SSN)
        IF $GET(pHandle)'=$$$NULLOREF {
           SET pHandle.SQLCode=SQLCODE
           SET pHandle.RowCount=%ROWCOUNT }
           QUIT
     }

プロシジャ・ハンドラ pHandle を使用します。対応する SQL 変数を使用して、このハンドラの SQLCode 属性と RowCount 属性を設定します。プロシージャの LANGUAGE OBJECTSCRIPT キーワードに続く Caché ObjectScript を中括弧で囲むことに注意してください。Caché ObjectScript コードには、&sql でマークされ、角括弧で囲まれた埋め込み SQL コードがあります。