DocumentaçãoCampaignDocumentação do Campaign Classic v7

Gerenciamento de chaves em esquemas management-of-keys

Last update: Wed Sep 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor

Cada tabela associada a um schema de dados deve ter pelo menos uma chave para identificar um registro em uma tabela.

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

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

Uma chave é conhecida como "chave primária" quando é a primeira no esquema a ser preenchida, ou se contém o atributo internal definido como "true".

As seguintes regras se aplicam às chaves:

  • Uma chave pode fazer referência a um ou mais campos na tabela
  • Um índice exclusivo é declarado implicitamente para cada definição de chave. É possível impedir a criação de um índice na chave definindo o atributo noDbIndex como "true".
NOTE

  • Como padrão, as chaves são os elementos declarados do elemento principal do esquema após a definição dos índices.

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

Exemplo:

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

    code language-sql 
    <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:

    code language-sql 
    <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>

  • Adicionar uma chave primária ou interna no campo de nome "id":

    code language-sql 
    <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:

    code language-sql 
    <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 automática auto-incremental-key

A chave primária da maioria das tabelas do Adobe Campaign é um inteiro longo 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 função SQL XtkNewId) gerando um número exclusivo no banco de dados inteiro. O conteúdo da chave é inserido automaticamente ao inserir o 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 inteiro de dois bytes.

Você pode especificar no esquema de origem o nome da sequência a ser usada com o atributo pkSequence. Se este atributo não for fornecido no esquema de origem, a sequência padrão XtkNewId será usada. O aplicativo usa sequências dedicadas para os esquemas nms:broadLog e nms:trackingLog (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 esquema ou estender um esquema existente com uma sequência dedicada.

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

Uma sequência referenciada em um esquema 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 de GetNew XXX Ids, onde XXX é o nome da sequência (GetNewNmsTrackingLogIds, por exemplo). Exiba os arquivos postgres-nms.sql, mssql-nms.sql ou oracle-nms.sql fornecidos com o aplicativo no diretório datakit/nms/eng/sql/ para recuperar o exemplo de criação de sequência 'NmsTrackingLogId' para cada mecanismo de banco de dados.

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

Exemplo:

Declaração de 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 de seu índice, um campo numérico chamado "id" foi adicionado ao esquema estendido para conter a chave primária gerada automaticamente.

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

Saiba mais

Navegue pelos links a seguir para saber mais:

recommendation-more-help
601d79c3-e613-4db3-889a-ae959cd9e3e1