Mapeamento de banco de dados

O mapeamento SQL do nosso schema de exemplo fornece o seguinte documento 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 email 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>

Descrição

O elemento raiz do schema não é mais <srcschema>, mas <schema>.

Isso nos leva a outro tipo de documento, que é gerado automaticamente a partir do schema de origem, simplesmente conhecido como schema. Esse schema será usado pelo aplicativo Adobe Campaign.

Os nomes SQL são determinados automaticamente com base no nome e no tipo do elemento.

As regras de nomenclatura SQL são as seguintes:

  • tabela: concatenação do namespace e do nome do schema

    No nosso exemplo, o nome da tabela é inserido por meio do elemento principal do schema no sqltable atributo:

    <element name="recipient" sqltable="CusRecipient">
    
  • campo : nome do elemento precedido por um prefixo definido de acordo com o tipo ('i' para integer, 'd' para double, 's' para string, 'ts' para datas, etc.)

    O nome do campo é inserido por meio da variável sqlname atributo para cada tipo <attribute> e <element>:

    <attribute desc="Email address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/> 
    
OBSERVAÇÃO

Os nomes SQL podem ser sobrecarregados do schema de origem. Para fazer isso, preencha os atributos "sqltable" ou "sqlname" no elemento relacionado.

O script SQL para criar a tabela gerada do schema estendido é o seguinte:

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

As restrições do campo SQL são as seguintes:

  • sem valores nulos em campos numéricos e de data,
  • campos numéricos são inicializados para 0.

Campos XML

Por padrão, qualquer arquivo digitado <attribute> e <element> é mapeado em um campo SQL da tabela de schema de dados. No entanto, você pode fazer referência a esse campo em XML em vez de SQL, o que significa que os dados são armazenados em um campo de memorando ("mData") da tabela que contém os valores de todos os campos XML. O armazenamento desses dados é um documento XML que observa a estrutura do schema.

Para preencher um campo em XML, é necessário adicionar o xml com o valor "true" para o elemento relacionado.

Exemplo: há dois exemplos de uso de campo XML.

  • Campo de comentário de várias linhas:

    <element name="comment" xml="true" type="memo" label="Comment"/>
    
  • Descrição dos dados no formato HTML:

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

    O tipo "html" permite armazenar o conteúdo do HTML em uma tag CDATA e exibir uma verificação de HTML edit especial na interface do cliente Adobe Campaign.

O uso de campos XML permite adicionar campos sem a necessidade de modificar a estrutura física do banco de dados. Outra vantagem é que você usa menos recursos (tamanho alocado para campos SQL, limite no número de campos por tabela etc.).

A principal desvantagem é que é impossível indexar ou filtrar um campo XML.

Campos indexados

Os índices permitem otimizar o desempenho das consultas SQL usadas no aplicativo.

Um índice é declarado do elemento principal do schema de dados.

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

Os índices obedecem às seguintes regras:

  • Um índice pode fazer referência a um ou mais campos na tabela.
  • Um índice pode ser exclusivo (para evitar duplicatas) em todos os campos se a variável único contém o valor "true".
  • O nome SQL do índice é determinado pelo nome SQL da tabela e o nome do índice.
OBSERVAÇÃO

Como padrão, os índices são os primeiros elementos declarados do elemento principal do schema.

OBSERVAÇÃO

Os índices são criados automaticamente durante o mapeamento da tabela (padrão ou FDA).

Exemplo:

  • Adição de um índice ao endereço de email e à cidade:

    <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="Email address of recipient"/>
        <element name="location" label="Location">
          <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
        </element>
      </element>
    </srcSchema>
    
  • Adição de um índice exclusivo ao campo de nome "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="Email address of recipient"/>
      </element>
    </srcSchema>
    

Gestão de chaves

Uma tabela deve ter pelo menos uma chave para identificar um registro na tabela.

Uma chave é declarada do elemento principal do schema de dados.

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

As chaves obedecem às seguintes regras:

  • Uma chave pode fazer referência a um ou mais campos na tabela.
  • Uma chave é conhecida como "primária" (ou "prioridade") quando é a primeira no schema a ser preenchida ou se contém a variável interno com o valor "true".
  • Um índice exclusivo é declarado implicitamente para cada definição de chave. A criação de um índice na chave pode ser impedida com a adição da variável noDbIndex com o valor "true".
OBSERVAÇÃO

Como padrão, as chaves são os elementos declarados do elemento principal do schema depois que os índices foram definidos.

OBSERVAÇÃO

As chaves são criadas durante o mapeamento da tabela (padrão ou FDA), o Adobe Campaign encontra índices exclusivos.

Exemplo:

  • Adicionar uma chave ao endereço de email e à cidade:

    <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="Email address of recipient"/>
        <element name="location" label="Location">
          <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
        </element>
      </element>
    </srcSchema>
    

    O schema gerado:

    <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="Email 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>
    
  • Adição de uma chave primária ou interna no campo de nome "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="Email address of recipient"/>
      </element>
    </srcSchema>
    

    O schema gerado:

    <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="Email address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>  
      </element>
    </schema>
    

Chave incremental automaticamente

A chave primária da maioria das tabelas do Adobe Campaign é um número inteiro de 32 bits gerado automaticamente pelo mecanismo de banco de dados. O cálculo do valor da chave depende de uma sequência (por padrão, a variável XtkNewId Função SQL) gerando um número exclusivo no banco de dados inteiro. O conteúdo da chave é inserido automaticamente na inserção do registro.

A vantagem de uma chave incremental é que ela fornece uma chave técnica não modificável para as associações entre tabelas. Além disso, essa chave não ocupa muita memória porque usa um número inteiro de byte duplo.

Você pode especificar no schema de origem o nome da sequência a ser usada com a variável pkSequence atributo. Se esse atributo não for fornecido no schema de origem, a variável XtkNewId sequência padrão será usada. O aplicativo usa sequências dedicadas para a variável nms:broadLog e nms:trackingLog schemas (NmsBroadLogId e NmsTrackingLogId respectivamente) porque essas são as tabelas que contêm mais registros.

A partir do ACC 18.10, XtkNewId não é mais o valor padrão para a sequência nos esquemas prontos para uso. Agora é possível criar um schema ou estender um schema existente com uma sequência dedicada.

IMPORTANTE

Ao criar um novo schema ou durante uma extensão de schema, você precisa manter o mesmo valor de sequência da chave primária (@pkSequence) para todo o schema.

OBSERVAÇÃO

Uma sequência referenciada em um schema Adobe Campaign (NmsTrackingLogId por exemplo) deve ser associada a uma função SQL que retorna o número de IDs nos parâmetros, separadas por vírgulas. Esta função deve ser chamada GetNew XXX Ids, onde XXX é o nome da sequência (GetNewNmsTrackingLogIds por exemplo). Visualize o postgres-nms.sql, mssql-nms.sql ou oracle-nms.sql os arquivos fornecidos com o aplicativo na datakit/nms/eng/sql/ diretório para recuperar o exemplo de criação de uma sequência 'NmsTrackingLogId' para cada mecanismo de banco de dados.

Para declarar uma chave exclusiva, preencha o autopk (com o valor "true") no elemento principal do schema de dados.

Exemplo:

Declarando uma chave incremental no schema de origem:

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

O schema gerado:

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

Além da definição da chave e seu índice, um campo numérico chamado "id" foi adicionado ao schema estendido para conter a chave primária gerada automaticamente.

IMPORTANTE

Um registro com uma chave primária definida como 0 é inserido automaticamente na criação da tabela. Esse registro é usado para evitar associações externas, que não são efetivas em tabelas de volume. Por padrão, todas as chaves estrangeiras são inicializadas com o valor 0 para que um resultado possa sempre ser retornado na associação quando o item de dados não for preenchido.

Um link descreve a associação entre uma tabela e outra.

Os vários tipos de associações (conhecidas como "cardinalidades") são os seguintes:

  • Cardinalidade 1-1: uma ocorrência da tabela de origem pode ter no máximo uma ocorrência correspondente da tabela de destino.
  • Cardinalidade 1-N: uma ocorrência da tabela de origem pode ter várias ocorrências correspondentes da tabela de destino, mas uma ocorrência da tabela de destino pode ter no máximo uma ocorrência correspondente da tabela de origem.
  • Cardinalidade N-N: uma ocorrência da tabela de origem pode ter várias ocorrências correspondentes da tabela de destino, e vice-versa.

Na interface, você pode distinguir os diferentes tipos de relações facilmente graças aos ícones.

Para relações de associação com uma tabela/banco de dados de campanha:

  • : Cardinalidade 1-1. Por exemplo, entre um recipient e um pedido atual. Um recipient pode ser relacionado a apenas uma ocorrência da tabela de pedido atual por vez.
  • : Cardinalidade 1-1, junção externa. Por exemplo, entre um recipient e seu país. Um recipient pode ser relacionado a apenas uma ocorrência do país da tabela. O conteúdo da tabela de países não será salvo.
  • : Cardinalidade 1-N. Por exemplo, entre um recipient e a tabela de assinaturas. Um recipient pode ser relacionado a várias ocorrências na tabela de assinaturas.

Para relações de associação usando o Federated Database Access:

  • : Cardinalidade 1-1
  • : Cardinalidade 1-N

Para obter mais informações sobre tabelas FDA, consulte Acesso a um banco de dados externo.

Um link deve ser declarado no schema que contém a chave externa da tabela vinculada por meio do elemento principal:

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

Os links obedecem às seguintes regras:

  • A definição de um link é inserida em um link-type <element> com os seguintes atributos:

    • name: nome do link da tabela de origem,

    • target: nome do schema do target,

    • label: rótulo do link,

    • revLink (opcional): nome do link reverso do schema do target (deduzido automaticamente por padrão),

    • integridade (opcional): integridade referencial da ocorrência da tabela de origem para a ocorrência da tabela de destino. Os valores possíveis são os seguintes:

      • define: é possível excluir a ocorrência de origem se ela não for mais referenciada por uma ocorrência de destino,
      • normal: a exclusão da ocorrência de origem inicializa as chaves do link para a ocorrência de destino (modo padrão), esse tipo de integridade inicializa todas as chaves estrangeiras,
      • own: a exclusão da ocorrência de origem leva à exclusão da ocorrência de destino,
      • owncopy: o mesmo que own (em caso de exclusão) ou duplica as ocorrências (em caso de duplicação),
      • neutro: não faz nada.
    • revIntegrity (opcional): integridade no schema do target (opcional, "normal" por padrão),

    • revCardinalidade (opcional): com o valor "único" preenche a cardinalidade com o tipo 1-1 (1-N por padrão).

    • externalJoin (opcional): força a união externa

    • revExternalJoin (opcional): força a junção externa no link inverso

  • Um link faz referência a um ou mais campos da tabela de origem para a tabela de destino. Os campos que compõem a associação ( <join> (elemento ) não precisa ser preenchido porque eles são automaticamente deduzidos por padrão usando a chave interna do schema do target.

  • Um índice é adicionado automaticamente à chave externa do link no schema estendido.

  • Um link consiste em dois links médios, onde o primeiro é declarado do schema de origem e o segundo é criado automaticamente no schema estendido do schema de destino.

  • Uma associação pode ser uma associação externa se a variável externalJoin é adicionado, com o valor "true" (compatível com PostgreSQL).

OBSERVAÇÃO

Como padrão, os links são os elementos declarados no final do schema.

Exemplo 1

1-N relação com a tabela de schema "cus:company":

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

O schema gerado:

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

A definição do link é complementada pelos campos que compõem a associação, ou seja, a chave primária com seu XPath ("@id") no schema de destino, e a chave estrangeira com seu XPath ("@company-id") no schema.

A chave externa é adicionada automaticamente em um elemento que usa as mesmas características do campo associado na tabela de destino, com a seguinte convenção de nomenclatura: nome do schema target seguido pelo nome do campo associado ("company-id" em nosso exemplo).

Schema estendido do target ("cus:company"):

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

Um link reverso para a tabela "cus:recipient" foi adicionado com os seguintes parâmetros:

  • name: deduz automaticamente do nome do schema de origem (pode ser forçado com o atributo "revLink" na definição do link no schema de origem)
  • revLink: nome do link reverso
  • target: chave do schema vinculado (schema "cus:recipient")
  • unbound: o link é declarado como um elemento de coleção para uma cardinalidade 1-N (por padrão)
  • integridade: "definir" por padrão (pode ser forçado com o atributo "revIntegrity" na definição do link no schema de origem).

Exemplo 2

Neste exemplo, declararemos um link para a tabela de schema "nms:address". A associação é uma associação externa e é preenchida explicitamente com o endereço de email do recipient e o campo "@address" da tabela vinculada ("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>

Exemplo 3

1-1 relação com a tabela de schema "cus:extension":

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

Exemplo 4

Link para uma pasta (schema "xtk:folder"):

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

O valor padrão retorna o identificador do primeiro arquivo de tipo de parâmetro elegível inserido na função "DefaultFolder('nmsFolder')".

Exemplo 5

Neste exemplo, queremos criar uma chave em um link (schema "company" to "cus:company") com a variável xlink e um campo da tabela ("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>

O schema gerado:

<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="Email 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>

A definição da chave do nome "companyEmail" foi estendida com a chave externa do link "company". Essa chave gera um índice exclusivo em ambos os campos.

Nesta página