SQL 関数の追加

はじめに

Adobe Campaignでは、SQL関数にアクセスできる​独自の関数​を定義できます。この関数は、データベースで提供される関数と、コンソールでまだ使用できない関数の両方です。 これは、集計関数(平均、最大、合計)に役立ちます。例えば、サーバー上でのみ計算できる場合や、コンソールに式を「手動」で書き込む(日付管理など)よりも、データベースで特定の関数を実装する方が簡単な場合に便利です。

このメカニズムは、Adobe Campaignコンソールでまだ提供されていない、最新または一般的でないデータベースエンジンのSQL関数を使用する場合にも使用できます。

これらの関数が追加されると、他の定義済み関数と同様に、式エディターに表示されます。

重要

コンソール内のSQL関数呼び出しは、サーバーに自然に送信されなくなりました。 したがって、ここで説明するメカニズムは、予期しないSQLファンクションサーバで​を呼び出す唯一の方法になります。

インストール

追加する関数は、XML形式​"package"ファイルに含まれます。このファイルの構造については、次の段落で詳しく説明します。

コンソールからインストールするには、メニューから「ツール/詳細設定/パッケージをインポート」オプションを選択し、「ファイルからインストール」を選択して、インポートウィザードの指示に従います。

重要

警告:読み込まれた関数のリストがすぐに関数エディターに表示されても、Adobe Campaignを再起動するまで使用できません。

をインポートするパッケージの一般的な構造

追加する関数は、XML形式の​"package"ファイル​にあります。 次に例を示します。

<?xml version="1.0" encoding='ISO-8859-1' ?>
<!-- ===========================================================================
  Additional SQL functions for Adobe Campaign
  ========================================================================== -->
<package
  namespace   = "nms"
  name        = "package-additional-funclist"
  label       = "Additional functions"
  buildVersion= "6.1"
  buildNumber = "10000">

  <entities schema="xtk:funcList">
    <funcList name="myList" namespace="cus">
      <group name="date" label="Personalized date">
        <function name="relativeMaturity" type="long" args="(<Âge>)" help="Returns the difference between a date and 18 years"
                  minArgs="1" maxArgs="1" display="Relative maturity of the person born on the date $1">
          <providerPart provider="MSSQL,Sybase,PostgreSQL" body="extract(year from age($1))-18"/>
        </function>
      </group>
    </funcList>
  </entities>
</package>
  • namenamespace​および​label​は、情報提供のみを目的としています。 インストール済みパッケージのリストにパッケージの概要を表示できます(エクスプローラー/管理/パッケージ管理/インストール済みパッケージ)。

  • buildVersion​と​buildNumber​のフィールドは必須です。 これらは、コンソールが接続されているサーバー番号に対応している必要があります。 この情報は、「ヘルプ/バージョン情報」ボックスに表示されます。

  • 次のブロック(entities​と​funclist)は必須です。 funcListでは、「name」と「namespace」の各フィールドは必須ですが、名前はユーザーが決定する必要があり、関数リストを一意に指定します。

    つまり、同じ名前空間/名前のペアを持つ関数の別のリスト(ここでは「cus::myList」)が読み込まれると、以前に読み込まれた関数は削除されます。 逆に、この名前空間と名前のペアを変更すると、新しい一連の読み込まれた関数が前の関数に追加されます。

  • group​要素を使用して、読み込んだ関数を関数エディターに表示する関数グループを指定できます。 @name属性は、既に存在する名前(対象のグループに関数が追加される場合)か、新しい名前(新しいグループに表示される場合)のどちらかです。

  • 注意:<group>要素内の@name属性に指定できる値は次のとおりです。

      name="aggregate"      ( label="Aggregates"         )
      name="string"             ( label="String"           )
      name="date"               ( label="Date"             )
      name="numeric"          ( label="Numeric"        )
      name="geomarketing" ( label="Geomarketing"     )
      name="other"              ( label="Others"           )
      name="window"          ( label="Windowing functions" )
    
重要

次の@label属性を必ず入力してください。これは、使用可能な関数のリストに表示される名前です。 何も入力しないと、グループに名前が付きません。 ただし、既存の名前以外の名前を入力すると、グループ全体の名前が変更されます。

複数の異なるグループに関数を追加する場合は、同じリスト内で複数の<group>要素を追跡するように設定できます。

最後に、<group>要素には、パッケージファイルの目的である1つまたは複数の関数の定義を含めることができます。 <function> 要素について詳しくは、次の段落で説明します。

関数記述子<function></function>

ここで紹介するケースは、関数の実装​を提供したい一般的なケースです。

以下は、年齢を用いて、成熟したと見なされた年数を示す「相対成熟度」関数の例です。

 <function name="relativeMaturity" type="long" args="(<Âge>)" help="Returns the difference between a date and 18 years"
              minArgs="1" maxArgs="1" display="Relative maturity of the person born on the date $1">
       <providerPart provider="PostgreSQL" body="extract(year from age($1))-18"/>
       <providerPart provider="MSSQL,Sybase,Teradata" body="[Other implementation]"/>
    </function>

@name​フィールドは関数の名前を表し、「args」は説明に表示されるパラメーターのリストです。 この場合、関数は関数選択ウィンドウに「relativeMaturity ( <age> )」と表示されます。

  • ​helpは、式エディターウィンドウの下部に表示されるフィールドです。

  • @displayは 情報メッセージです。

    メモ

    @help属性と@display属性で、文字列「$1」は、最初の関数パラメーター(ここでは「Age」)で指定された名前を表します。 $2、$3…は、次のパラメーターを表します。 以下に説明する@body属性で、$1は呼び出し中に関数に渡す引数値を指定します。

    メモ

    説明は、有効なXML文字の文字列にする必要があります。<と>の代わりに「<」と「>」を使用することに注意してください。

  • @type は関数の戻り値の型で、標準の値です(long、string、byte、datetimeなど)。省略した場合、サーバーは関数を実装する式内で使用可能な型の中で最適な型を判断します。

  • @minArgsand maxArgsは、 ​パラメータのパラメータの数(最小値と最大値)を指定します。例えば、2つのパラメーターを持つ関数の場合、minArgsとmaxArgsは2と2になります。 3つのパラメーターの場合、+ 1オプションの場合、それぞれ3と4になります。

  • 最後に、providerPart​要素が関数の実装を提供します。

    • provider​属性は必須で、実装が指定されるデータベースシステムを指定します。 例で示すように、式の構文や基になる関数が異なる場合は、データベースに従って代替実装を提供できます。
    • @body​属性には、関数の実装が含まれます。 注意:この実装は、(コードのブロックではなく)データベース言語の式である必要があります。 データベースに応じて、式はサブクエリ(「(テーブルから選択列の場合…)」)で、1つの値のみを返すことができます。 例えば、Oracleの場合は次のようになります(クエリは角括弧で囲む必要があります)。
    メモ

    定義した関数によってクエリされるデータベースが1つまたは2つだけの場合、常にこれらのデータベースに対応する定義のみを指定できます。

'パススルー'関数記述子

特別な関数記述子は、「プロバイダ」データベースシステムが指定されていない​"パススルー"​ブロックです。 この場合、「body」実装には、使用するデータベースに依存しない構文を使用した1つの関数呼び出しのみを含めることができます。 一方、「ProviderPart」ブロックは一意です。

    <function name="CountAll" args="()" help="Counts the values returned (all fields together)"
              type="long" minArgs="0" maxArgs="0">
      <providerPart body="Count(*)"/>
    </function>

この場合、関数を追加すると、デフォルトでは使用できなかったデータベース機能がクライアントに表示されるようになります。

その他の関数の例は、事前定義済みパッケージ「xtkdatakitfuncList.xml」に記載されています。

このページ