Aanvullende SQL-functies definiëren adding-additional-sql-functions

Last update: Tue Sep 10 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Configuratie

Gemaakt voor:

Ontwikkelaar

Adobe Campaign staat de gebruiker toe om hun eigen functies te bepalen die tot SQL functies kunnen toegang hebben, zowel die aangeboden door het gegevensbestand als die die niet reeds beschikbaar in de console zijn. Dit is nuttig voor geaggregeerde functies (gemiddelde, maximum, som) bijvoorbeeld, die alleen op de server kunnen worden berekend of wanneer de database een eenvoudigere manier biedt om bepaalde functies te implementeren, in plaats van "handmatig" de expressie in de console te schrijven (bijvoorbeeld datumbeheer).

Dit mechanisme kan ook worden gebruikt als u een recente of ongewone SQL-functie van de database-engine wilt gebruiken, die nog niet door de Adobe Campaign-console wordt aangeboden.

Zodra deze functies zijn toegevoegd, zullen zij in de uitdrukkingsredacteur enkel als andere vooraf bepaalde functies verschijnen.

IMPORTANT

SQL de functievraag in de console wordt niet meer van nature verzonden naar de server. Het hier beschreven mechanisme wordt daarom de enige manier om op de ongeplande SQL functieserver te roepen.

Installatie installation

De toe te voegen functie(s) bevindt (bevinden) zich in een "package"-bestand in XML-indeling , waarvan de structuur in de volgende alinea wordt beschreven.

Om het van de console te installeren, selecteer Hulpmiddelen/Geavanceerde/het pakket van de Invoer opties van het menu, toen Install from file, en volg de instructies in de invoermedewerker.

IMPORTANT

Waarschuwing: zelfs als de lijst met geïmporteerde functies direct in de functie-editor wordt weergegeven, zijn deze functies pas bruikbaar als Adobe Campaign opnieuw is gestart.

Algemene structuur van het te importeren pakket general-structure-of-package-to-import

De toe te voegen functie(s) kan in het "pakket"dossier in het formaat van XML worden gevonden. Hier volgt een voorbeeld:

<?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= "7.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>

De naam, namespace en etiket zijn slechts voor informatiedoeleinden. Zij laten u een samenvatting van het pakket in de geïnstalleerde pakketlijst (Ontdekkingsreiziger/Beleid/het beheer van het Pakket/Geïnstalleerde pakketten) bekijken.
De buildVersion en buildNumber gebieden zijn verplicht. Ze moeten overeenkomen met het servernummer waarmee de console is verbonden. Deze informatie vindt u in het vak "Help/Info".
De volgende blokken, entiteiten en funclist zijn verplicht. In funcList zijn de velden "name" en "namespace" verplicht, maar de gebruiker kan zelf beslissen welke naam hij of zij gebruikt en geven de functielijst op unieke wijze aan.

Dit betekent dat als een andere lijst met functies met dezelfde naamruimte/naamcombinatie (hier "cus::myList") wordt geïmporteerd, de eerder geïmporteerde functies worden verwijderd. Omgekeerd geldt dat als u dit naamruimte-/naampaar wijzigt, de nieuwe reeks geïmporteerde functies wordt toegevoegd aan de vorige.
Het groep element laat u de functiegroep specificeren waarin de ingevoerde functie(s) in de functieredacteur zullen verschijnen. Het kenmerk @name kan een naam zijn die al bestaat (in welk geval de functies worden toegevoegd aan de desbetreffende groep) of een nieuwe naam (in welk geval de functie wordt weergegeven in een nieuwe groep).

Herinnering: mogelijke waarden voor het kenmerk @name in het element <group> zijn:

code language-none

code language-none
`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" )`

  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" )

IMPORTANT

Zorg ervoor dat u het kenmerk @label invult: dit is de naam die wordt weergegeven in de lijst met beschikbare functies. Als u niets invoert, heeft de groep geen naam. Als u echter een andere naam invoert dan de bestaande naam, verandert de naam van de hele groep.

Als u functies wilt toevoegen aan verschillende groepen, kunt u verschillende <group> -elementen in dezelfde lijst laten bijhouden.

Tot slot kan een <group> -element de definitie van een of meer functies bevatten, dat is het doel van het pakketbestand. De <function> het element wordt in de volgende alinea nader beschreven.

Functiebeschrijving <function></function> function-descriptor--function-

Het hier voorgestelde geval is een algemeen geval waarbij wij de functietoevoer willen verstrekken.

Hieronder ziet u een voorbeeld van een functie van "relatieve rijpheid" die, op basis van een leeftijd, aangeeft hoeveel jaren de persoon als volwassen wordt beschouwd.

 <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>

Het veld @name verwijst naar de naam van de functie en "args" is de lijst met parameters die in de beschrijving wordt weergegeven. In dit geval wordt de functie weergegeven als "relativeMaturity ( <age> )" in het venster van de functieselectie.

hulp is het gebied dat bij de bodem van het venster van de uitdrukkingsredacteur wordt getoond.

@display is een informatief bericht.

note note
NOTE
In de kenmerken @help en @display vertegenwoordigt de tekenreeks "$1" de naam die is gegeven in de eerste functieparameter (hier, "Leeftijd"). $2, $3… zou de volgende parameters vertegenwoordigen. In het @body-kenmerk dat hieronder wordt beschreven, geeft $1 de argumentwaarde aan die tijdens de aanroep aan de functie wordt doorgegeven.

note note

NOTE

De beschrijving moet een tekenreeks van geldige XML-tekens zijn. Let op het gebruik van '<' en '>' in plaats van < en

.

@type is het type van de functieretratie en is een standaardwaarde (lang, koord, byte, datetime…). Als het wordt weggelaten, bepaalt de server het beste type onder de beschikbare types binnen de uitdrukking die de functie uitvoert.
@minArgs en maxArgs wijst het aantal parameters (minimum en maximum) voor een parameter aan. Voor een functie met 2 parameters zijn minArgs en maxArgs bijvoorbeeld 2 en 2. Voor drie parameters, plus 1 optioneel, zijn deze respectievelijk 3 en 4.

Tot slot verstrekt het providerPart element de functie implementatie.

Het leverancier attribuut is verplicht, specificeert het de gegevensbestandsystemen waarvoor de implementatie wordt verstrekt. Zoals getoond in het voorbeeld, wanneer de uitdrukkingssyntaxis of onderliggende functies verschillen, kunnen de alternatieve implementaties volgens het gegevensbestand worden verstrekt.
Het @body attribuut bevat de functie implementatie. Opmerking: deze implementatie moet een expressie zijn in de databasetaal (geen codeblok). Afhankelijk van de databases kunnen expressies subquery's zijn ("(selecteer kolom in de tabel waarin…)") die slechts één waarde retourneren. Dit is bijvoorbeeld het geval in Oracle (de query moet tussen haakjes worden geschreven).

note note
NOTE
Als slechts één of twee gegevensbestanden waarschijnlijk door de bepaalde functie zullen worden gevraagd, kunnen wij altijd slechts de definities verstrekken die aan deze gegevensbestanden beantwoorden.

Functiebeschrijving 'Pass-through' pass-through--function-descriptor

Een speciale functiebeschrijver is het "pass-through" blok, met een niet gespecificeerd "leverancier"gegevensbestandsysteem. In dit geval kan de implementatie van de 'body' slechts één functieaanroep bevatten met een syntaxis die niet afhankelijk is van de gebruikte database. Ondertussen is het blok "ProviderPart" uniek.

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

In dit geval dient het toevoegen van een functie alleen om een databasefunctie te maken die niet standaard beschikbaar zou zijn geweest, nu zichtbaar voor de client.

Voorbeelden examples

Meer functievoorbeelden vindt u in het vooraf gedefinieerde pakket "xtkdatakitfuncList.xml".

recommendation-more-help

601d79c3-e613-4db3-889a-ae959cd9e3e1