数据库映射

我们示例模式的SQL映射提供了以下XML文档:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">
  <enumeration basetype="byte" name="gender">    
    <value label="Not specified" name="unknown" value="0"/>    
    <value label="Male" name="male" value="1"/>    
    <value label="Female" name="female" value="2"/> 
  </enumeration>  

  <element name="recipient" sqltable="CusRecipient">    
    <attribute desc="Recipient e-mail address" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>    
    <attribute default="GetDate()" label="Date of creation" name="created" sqlname="tsCreated" type="datetime"/>    
    <attribute enum="gender" label="Gender" name="gender" sqlname="iGender" type="byte"/>    
    <element label="Location" name="location">      
      <attribute label="City" length="50" name="city" sqlname="sCity" type="string" userEnum="city"/>    
    </element>  
  </element>
</schema>

说明

模式的根元素不再是, <srcschema>​而是 <schema>

这将我们带到另一种类型的文档,它是从源模式自动生成的,简称为模式。 此模式将由Adobe Campaign应用程序使用。

SQL名称会根据元素名称和类型自动确定。

SQL命名规则如下:

  • 表:模式命名空间和名称的串连

    在我们的示例中,表的名称是通过sqltable属性中模式的主元 素输 入的:

    <element name="recipient" sqltable="CusRecipient">
    
  • 字段:元素的名称,前面有根据类型定义的前缀(“i”表示整数,“d”表示多次,“s”表示字符串,“ts”表示日期,等等)

    字段名称通过每个类型的 sqlname 属性输入 <attribute> ,并 <element>:

    <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/> 
    
注意

SQL名称可以从源模式重载。 为此,请在相关元素上填充“sqltable”或“sqlname”属性。

用于创建从扩展模式生成的表的SQL脚本如下所示:

CREATE TABLE CusRecipient(
  iGender NUMERIC(3) NOT NULL Default 0,   
  sCity VARCHAR(50),   
  sEmail VARCHAR(80),
  tsCreated TIMESTAMP Default NULL);

SQL字段约束如下所示:

  • 数字和日期字段中没有空值,
  • 数字字段被初始化为0。

XML字段

默认情况下,任何 <attribute> 类型 <element> 和元素都会映射到数据模式表的SQL字段。 但是,您可以在XML中引用此字段,而不是SQL,这意味着数据存储在包含所有XML字段值的表的备注字段(“mData”)中。 这些数据的存储是观察模式结构的XML文档。

要在XML中填充字段,必须向相 关元素 添加带值“true”的xml属性。

示例:以下是两个XML字段使用示例。

  • 多行注释字段:

    <element name="comment" xml="true" type="memo" label="Comment"/>
    
  • HTML格式的数据描述:

    <element name="description" xml="true" type="html" label="Description"/>
    

    “html”类型允许您将HTML内容存储在CDATA标签中,并在Adobe Campaign客户端界面中显示特殊的HTML编辑检查。

使用XML字段,您无需修改数据库的物理结构即可添加字段。 另一个优势是您使用的资源较少(分配给SQL字段的大小、每个表的字段数限制等)。

主要缺点是无法对XML字段进行索引或筛选。

索引字段

索引使您能够优化应用程序中使用的SQL查询的性能。

从数据模式的主元素声明索引。

<dbindex name="name_of_index" unique="true/false">
  <keyfield xpath="xpath_of_field1"/>
  <keyfield xpath="xpath_of_field2"/>
  ...
</key>

索引遵循以下规则:

  • 索引可以引用表中的一个或多个字段。
  • 如果唯一属性包含值“true”,则索引在所有字段中都 可以是 唯一的(以避免重复)。
  • 索引的SQL名称由表的SQL名称和索引的名称确定。
注意

作为标准,索引是从模式的主要元素声明的第一个元素。

注意

索引在表映射(标准或联合数据访问)期间自动创建。

示例:

  • 向电子邮件地址和城市添加索引:

    <srcSchema name="recipient" namespace="cus">
      <element name="recipient">
        <dbindex name="email">
          <keyfield xpath="@email"/> 
          <keyfield xpath="location/@city"/> 
        </dbindex>
    
        <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
        <element name="location" label="Location">
          <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
        </element>
      </element>
    </srcSchema>
    
  • 将唯一索引添加到“id”名称字段:

    <srcSchema name="recipient" namespace="cus">
      <element name="recipient">
        <dbindex name="id" unique="true">
          <keyfield xpath="@id"/> 
        </dbindex>
    
        <dbindex name="email">
          <keyfield xpath="@email"/> 
        </dbindex>
    
        <attribute name="id" type="long" label="Identifier"/>
        <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
      </element>
    </srcSchema>
    

密钥管理

表必须具有至少一个用于标识表中记录的键。

从数据模式的主元素中声明密钥。

<key name="name_of_key">
  <keyfield xpath="xpath_of_field1"/>
  <keyfield xpath="xpath_of_field2"/>
  ...
</key>

密钥遵守以下规则:

  • 键可以引用表中的一个或多个字段。
  • 当键是要填充的模式中的第一个,或者它包含带有值“true”的内部属性时, 称为“primary”(或“priority”)。
  • 每个键定义隐式声明一个唯一索引。 通过添加值为“true”的noDbIndex属性,可 以阻止在键上 创建索引。
注意

作为标准,键是在定义索引后从模式的主元素声明的元素。

注意

键在表映射(标准或联合数据访问)过程中创建,Adobe Campaign会查找唯一索引。

示例:

  • 向电子邮件地址和城市添加密钥:

    <srcSchema name="recipient" namespace="cus">
      <element name="recipient">
        <key name="email">
          <keyfield xpath="@email"/> 
          <keyfield xpath="location/@city"/> 
        </key>
    
        <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
        <element name="location" label="Location">
          <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
        </element>
      </element>
    </srcSchema>
    

    生成的模式:

    <schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
      <element name="recipient" sqltable="CusRecipient">    
       <dbindex name="email" unique="true">      
         <keyfield xpath="@email"/>      
         <keyfield xpath="location/@city"/>    
       </dbindex>    
    
       <key name="email">      
        <keyfield xpath="@email"/>      
        <keyfield xpath="location/@city"/>    
       </key>    
    
       <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>    
       <element label="Location" name="location">      
         <attribute label="City" length="50" name="city" sqlname="sCity" type="string" userEnum="city"/>    
       </element>  
      </element>
    </schema>
    
  • 在“id”名称字段中添加主键或内部键:

    <srcSchema name="recipient" namespace="cus">
      <element name="recipient">
        <key name="id" internal="true">
          <keyfield xpath="@id"/> 
        </key>
    
        <key name="email" noDbIndex="true">
          <keyfield xpath="@email"/> 
        </key>
    
        <attribute name="id" type="long" label="Identifier"/>
        <attribute name="email" type="string" length="80" label="Email" desc="E-mail address of recipient"/>
      </element>
    </srcSchema>
    

    生成的模式:

    <schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
      <element name="recipient" sqltable="CusRecipient">    
        <key name="email">      
          <keyfield xpath="@email"/>    
        </key>    
    
        <dbindex name="id" unique="true">      
          <keyfield xpath="@id"/>    
        </dbindex>    
    
        <key internal="true" name="id">      
         <keyfield xpath="@id"/>    
        </key>    
    
        <attribute label="Identifier" name="id" sqlname="iRecipientId" type="long"/>    
        <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>  
      </element>
    </schema>
    

自动增量密钥

大多数Adobe Campaign表的主键是由数据库引擎自动生成的32位长整数。 键值的计算取决于生成整个数据库中唯一 的数字的序列(默认情况下 ,XtkNewId SQL函数)。 在插入记录时自动输入密钥的内容。

增量密钥的优点在于它为表之间的连接提供了不可修改的技术密钥。 此外,此键占用的内存不多,因为它使用多次字节整数。

您可以在源模式中指定要与pkSequence属性一起使用的序 列的名 称。 如果源模式中未提供此属性,则 将使用 XtkNewId默认序列。 应用程序将专用序 列用于nms :broadLog 和nms :trackingLog 模式( NmsBroadLogId和 ​NmsTrackingLogId),因为这些表包含最多记录。

从ACC 18.10 开始 ,XtkNewId不再是现成模式中序列的默认值。 您现在能够构建模式或使用专用序列扩展现有模式。

重要

创建新模式或在模式扩展期间,您需要为整个模式保留相同的主键序列值(@pkSequence)。

注意

Adobe Campaign模式(例如​NmsTrackingLogId )中引用的序列必须与SQL函数关联,该函数返回参数中的ID数(以逗号分隔)。 此函数必须 称为GetNewXXXIds,其中 XXX是序列的名称( 例如GetNewNmsTrackingLog ​Id)。 视图 datakit/nms/eng/sql/directory中随应 用程序提供的postgres-nms.nms、mssql-nms sql或 oracle-nmssql​**​** 文件,以恢复每个数据库引擎的“NmsTrackingLogId”序列创建示例。

要声明唯一键,请在数 据模式 的主要元素上填充autopk属性(带值“true”)。

示例:

在源模式中声明增量键:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient" autopk="true">
  ...
  </element>
</srcSchema>

生成的模式:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" autopk="true" pkSequence="XtkNewId" sqltable="CusRecipient"> 
    <dbindex name="id" unique="true">
      <keyfield xpath="@id"/>
    </dbindex>

    <key internal="true" name="id">
      <keyfield xpath="@id"/>
    </key>

    <attribute desc="Internal primary key" label="Primary key" name="id" sqlname="iRecipientId" type="long"/>
  </element>
</schema>

除了键及其索引的定义之外,还向扩展模式添加了名为“id”的数字字段,以包含自动生成的主键。

重要

创建表时,将自动插入主键设置为0的记录。 此记录用于避免外部连接,这对卷表无效。 默认情况下,所有外键都使用值0进行初始化,这样,在数据项未填充时,在连接时总能返回结果。

链接描述一个表与另一个表之间的关联。

各种类型的关联(称为“基数”)如下:

  • 基数1-1:源表的一个出现最多可以具有目标表的一个对应出现。
  • 基数1-N:源表的一个出现可以具有多个对应的目标表出现,但目标表的一个出现最多可以具有源表的一个对应出现。
  • 基数N-N:源表的一个实例可以具有多个相应的目标表实例,反之亦然。

在界面中,您可以借助关系的图标轻松区分不同类型的关系。

对于与活动表/数据库的连接关系:

  • :基数1-1。 例如,在收件人和当前订单之间。 收件人一次只能与当前订单表的一个匹配项相关。
  • :基数1-1,外部连接。 例如,在收件人和他们的国家之间。 收件人只能与表国家/地区的一个事件相关。 不保存国家/地区表的内容。
  • :基数1-N。例如,在收件人和订阅表之间。 收件人可以与订阅表上的多个事件相关。

对于使用联合数据库访问的连接关系:

  • :基数1-1
  • :基数1-N

有关联合数据访问表的详细信息,请参阅 访问外部数据库

必须在包含通过主元素链接的表的外键的模式中声明链接:

<element name="name_of_link" type="link" target="key_of_destination_schema">
  <join xpath-dst="xpath_of_field1_destination_table" xpath-src="xpath_of_field1_source_table"/>
  <join xpath-dst="xpath_of_field2_destination_table" xpath-src="xpath_of_field2_source_table"/>
  ...
</element>

链接遵循以下规则:

  • 链接的定义是在具有以下属 性的​链 <element> 接类型上输入的:

    • name:源表中链接的名称,

    • 目标:目标模式,

    • 标签:链接标签,

    • revLink (可选):目标模式的反向链接名称(默认情况下自动推断),

    • 完整性 (可选):源表的出现与目标表的出现的参照完整性。 可能的值如下:

      • 定义:如果源事件不再被目标事件引用,则可以删除它,
      • 正常:删除源出现项将初始化指向目标出现项的链接的键(默认模式),此类型的完整性将初始化所有外键,
      • 自有:删除源事件会导致删除目标事件,
      • 下载:与自己 (如 果删除)或重复事件(如果重复)相同,
      • 中性:什么也不做。
    • revIntegrity (可选):目标模式的完整性(默认为可选,“正常”),

    • revCardinality (可选):值“single”将填充类型为1-1(默认为1-N)的基数。

    • externalJoin (可选):强制外连接

    • revExternalJoin (可选):在反向链路上强制外连接

  • 链接将引用源表中的一个或多个字段到目标表。 组成连接(元素)的字 <join> 段无需填充,因为默认情况下,它们会使用目标模式的内部键自动推断。

  • 索引会自动添加到扩展模式中链接的外键。

  • 链接由两个半链接组成,其中第一个链接从源模式声明,第二个链接在目标模式的扩展模式中自动创建。

  • 如果添加了externalJoin属性, 且值为 “true”(在PostgreSQL中受支持),则连接可以是外连接。

注意

作为标准,链接是在模式末尾声明的元素。

Example 1

1-N与“cus:公司”模式表相关:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    ...
    <element label="Company" name="company" revIntegrity="define" revLabel="Contact" target="cus:company" type="link"/>
  </element>
</srcSchema>

生成的模式:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" sqltable="CusRecipient"> 
    <dbindex name="companyId">      
      <keyfield xpath="@company-id"/>    
    </dbindex>
    ...
    <element label="Company" name="company" revLink="recipient" target="cus:company" type="link">      
      <join xpath-dst="@id" xpath-src="@company-id"/>    
    </element>    
    <attribute advanced="true" label="Foreign key of 'Company' link (field 'id')" name="company-id" sqlname="iCompanyId" type="long"/>
  </element>
</schema>

链接定义由组成连接的字段补充,即目标模式中XPath(“@id”)为主键,模式中XPath(“@公司-id”)为外键。

外键会自动添加到元素中,该元素使用与目标表中关联字段相同的特性,并遵循以下命名约定:目标模式的名称,后跟关联字段的名称(我们示例中的“公司-id”)。

目标的扩展模式(“cus:公司”):

<schema mappingType="sql" name="company" namespace="cus" xtkschema="xtk:schema">  
  <element name="company" sqltable="CusCompany" autopk="true"> 
    <dbindex name="id" unique="true">     
      <keyfield xpath="@id"/>    
    </dbindex>   
    <key internal="true" name="id">      
      <keyfield xpath="@id"/>    
    </key>
    ...
    <attribute desc="Internal primary key" label="Primary key" name="id" sqlname="iCompanyId" type="long"/>
    ...
    <element belongsTo="cus:recipient" integrity="define" label="Contact" name="recipient" revLink="company" target="nms:recipient" type="link" unbound="true">      
      <join xpath-dst="@company-id" xpath-src="@id"/>    
    </element>
  </element>
</schema>

添加了指向“cus:收件人”表的反向链接,其参数如下:

  • name:根据源模式的名称自动推断(可以强制使用源模式上的链接定义中的“revLink”属性)
  • revLink:反向链接名称
  • 目标:链接模式的键(“cus:收件人”模式)
  • 未绑定:链接将声明为1-N基数的集合元素(默认情况下)
  • 完整性:默认情况下为“define”(可以强制使用源模式上链接定义中的“revIntegrity”属性)。

示例 2

在此示例中,我们将声明指向“nms:address”模式表的链接。 连接是外部连接,并显式填充了收件人的电子邮件地址和链接表的“@address”字段(“nms:address”)。

<srcSchema name="recipient" namespace="cus">
  <element name="recipient"> 
    ...
    <element integrity="neutral" label="Info about email" name="emailInfo" revIntegrity="neutral" revLink="recipient" target="nms:address" type="link" externalJoin="true">      
      <join xpath-dst="@address" xpath-src="@email"/>
    </element>
  </element>
</srcSchema>

Example 3

与“cus:extension”模式表的1-1关系:

<element integrity="own" label="Extension" name="extension" revCardinality="single" revLink="recipient" target="cus:extension" type="link"/>

Example 4

链接到文件夹(“xtk:folder”模式):

<element default="DefaultFolder('nmsFolder')" label="Folder" name="folder" revDesc="Recipients in the folder" revIntegrity="own" revLabel="Recipients" target="xtk:folder" type="link"/>

默认值返回在“DefaultFolder('nmsFolder')”函数中输入的第一个合格参数类型文件的标识符。

Example 5

在此示例中,我们希望在链接(“公司”到“cus: 公司 ”模式)上创建一个键,其中包含xlink属性和(“email”)表的字段:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <key name="companyEmail"> 
      <keyfield xpath="@email"/>
      <keyfield xlink="company"/>
    </key>
    
    <attribute name="email" type="string" length="80" label="Email" desc="Recipient email"/>
    <element label="Company" name="company" revIntegrity="define" revLabel="Contact" target="cus:company" type="link"/>
  </element>
</srcSchema>

生成的模式:

<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">  
  <element name="recipient" sqltable="CusRecipient"> 
    <dbindex name="companyId">      
      <keyfield xpath="@company-id"/>    
    </dbindex>

    <dbindex name="companyEmail" unique="true">
      <keyfield xpath="@email"/>      
      <keyfield xpath="@company-id"/>    
    </dbindex>    

    <key name="companyEmail">      
      <keyfield xpath="@email"/>      
      <keyfield xpath="@company-id"/>    
    </key>

    <attribute desc="E-mail address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>
    <element label="Company" name="company" revLink="recipient" target="sfa:company" type="link">      
      <join xpath-dst="@id" xpath-src="@company-id"/>    
    </element>    
    <attribute advanced="true" label="Foreign key of link 'Company' (field 'id')" name="company-id" sqlname="iCompanyId" type="long"/>
  </element>
</schema>

“companyEmail”名称键的定义扩展为“公司”链接的外键。 此键在这两个字段上都生成唯一索引。

在此页面上