GET_COLUMN_VALUE_FROM_INDEX

Válido Para

Extract e Replicat

Descrição

Use a função GET_COLUMN_VALUE_FROM_INDEX para recuperar o valor da coluna do registro de dados usando o índice de coluna especificado. Os valores de coluna são a base para a maioria da lógica dentro da saída do usuário. Você pode basear a lógica complexa nos valores de colunas individuais no registro de dados. Você pode especificar o formato de caractere do valor retornado.

Se a sessão de caracteres da saída do usuário for definida com SET_SESSION_CHARSET para um valor diferente do conjunto de caracteres padrão do sistema operacional, conforme definido em ULIB_CS_DEFAULT no arquivo ucharset.h, os dados de caracteres que são trocados entre a saída do usuário e o processo serão interpretados no conjunto de caracteres da sessão.

Um valor de coluna será definido como o conjunto de caracteres da sessão somente se o seguinte for verdadeiro:

Sintaxe

#include "usrdecs.h"
short result_code;
column_def column;
ERCALLBACK (GET_COLUMN_VALUE_FROM_INDEX, &column, &result_code);

Buffer

typedef struct
{
char *column_value;
unsigned short max_value_length;
unsigned short actual_value_length;
short null_value;
short remove_column;
short value_truncated;
short column_index;
char *column_name;
/* Version 3 CALLBACK_STRUCT_VERSION */
short column_value_mode;
short source_or_target;
/* Version 2 CALLBACK_STRUCT_VERSION */
char requesting_before_after_ind;
char more_lob_data;
/* Version 3 CALLBACK_STRUCT_VERSION  */
ULibCharSet column_charset;
} column_def;

Entrada

<column_value>

Um ponteiro para um buffer a fim de aceitar o valor da coluna retornado.

<max_value_length>

O tamanho máximo do valor da coluna retornado. Normalmente, o tamanho máximo é o tamanho do buffer de valor da coluna. Se o formato ASCII for especificado com column_value_mode, o valor da coluna será encerrado como nulo e o tamanho máximo deverá ser igual ao tamanho máximo do valor da coluna.

<column_index>

O índice de coluna do valor de coluna a ser retornado.

<column_value_mode>

Indica o formato do valor da coluna.

EXIT_FN_CHAR_FORMAT

Formato ASCII: O valor é uma string ASCII (ou EBCDIC) terminada com nulo (com uma exceção conhecida para o tipo de subdados UTF16_BE, que é convertido em UTF 8.) Observação: Um valor de coluna pode ser truncado quando apresentado a uma saída de usuário, porque o valor é interpretado como uma string ASCII e deve ser encerrado como nulo. O primeiro valor de 0 se torna o terminador de string.

EXIT_FN_RAW_FORMAT

Formato canônico interno do Oracle GoldenGate: Esse formato inclui um indicador NULL de dois bytes e um tamanho de dados variável de dois bytes quando aplicável. O Oracle GoldenGate não faz nenhuma conversão de conjuntos de caracteres para esse formato em nenhum tipo de dados de caracteres.

EXIT_FN_CNVTED_SESS_CHAR_FORMAT

Conjunto de caracteres de saída do usuário: Isso só se aplica se o tipo de dados da coluna for:

Este formato não é encerrado como nulo.

<source_or_target>

Uma das opções a seguir indica se o registro de dados de origem ou de destino deve ser usado para recuperar o valor da coluna.

EXIT_FN_SOURCE_VAL
EXIT_FN_TARGET_VAL

<requesting_before_after_ind>

Defina ao processar um registro de imagem posterior e você deseja o valor da coluna de imagem anterior de uma atualização ou de uma atualização de chave primária.

Para obter o valor "before" da coluna ao processar uma "after image" de uma atualização de chave primária ou um registro de atualização regular (não chave), defina o flag requesting_before_after_ind como BEFORE_IMAGE_VAL.

A definição padrão é AFTER_IMAGE_VAL (obtenha a imagem posterior da coluna) quando uma entrada explícita para requesting_before_after_ind não for especificada.

Para disponibilizar uma imagem anterior, você pode usar o parâmetro GETUPDATEBEFORES ou pode usar a opção INCLUDEUPDATEBEFORES na instrução de parâmetro CUSEREXIT.

Observe que:

<requesting_before_after_ind>

Para obter a imagem anterior da coluna, defina o flag char requesting_before_after_ind como BEFORE_IMAGE_VAL. Para obter a imagem posterior, defina-a como AFTER_IMAGE_VAL. O padrão é sempre trabalhar com a imagem posterior, a menos que o antes seja especificado.

Para disponibilizar as imagens anteriores, você pode usar o parâmetro GETUPDATEBEFORES para a instrução TABLE que contém a tabela ou pode usar a opção INCLUDEUPDATEBEFORES na instrução do parâmetro CUSEREXIT. Ambos causarão a mesma chamada para a saída do usuário para process_record.

Saída

<column_value>

Um ponteiro para o valor da coluna retornada. Se column_value_mode for especificado como EXIT_FN_CHAR_FORMAT, o valor da coluna será retornado como uma string ASCII terminada com nulo; caso contrário, o valor da coluna será retornado no formato canônico interno do Oracle GoldenGate. No formato ASCII, as datas são retornadas no seguinte formato:

YYYY-MM-DD HH:MI:SS.FFFFFF

A inclusão do tempo fracionário é dependente do banco de dados.

<actual_value_length>

O tamanho da string do nome da coluna retornada, em bytes. O tamanho real não inclui um terminador nulo quando column_value_mode é especificado como EXIT_FN_CHAR_FORMAT.

<null_value>

Um flag (0 ou 1) que indica se o valor da coluna é ou não nulo. Se o flag null_value for 1, o buffer de valor da coluna será preenchido com bytes nulos.

<value_truncated>

Um flag (0 ou 1) indicando se o valor foi truncado ou não. Truncação ocorre se o tamanho do valor da coluna exceder o tamanho máximo do buffer. Se column_value_mode tiver sido especificado como EXIT_FN_CHAR_FORMAT, o terminador nulo será incluído no tamanho da coluna.

char more_lob_data

Um flag que indica se mais dados do LOB estão presentes além do 4K inicial que pode ser armazenado no registro base. Quando um LOB é maior que o limite do 4K, ele é armazenado em fragmentos do LOB.

Você deve alocar a quantidade apropriada de memória para conter os valores retornados. O Oracle GoldenGate acessará as colunas LOB até 8K de dados o tempo todo, preenchendo o buffer com a quantidade alocada pela saída do usuário. Se o LOB for maior que o que foi alocado, os callbacks subsequentes serão necessários para obter o total de dados da coluna, até que todos os dados tenham sido enviados para a saída do usuário.

Para determinar o fim dos dados, avalie more_lob_data. A saída do usuário define esse flag como CHAR_NO_VAL ou CHAR_YES_VAL antes de acessar uma nova coluna. Se esse flag ainda for inicializado após o primeiro callback e não for definido como CHAR_YES_VAL ou CAR_NO_VAL, uma das seguintes afirmações será verdadeira:

É recomendável obter os metadados da tabela de origem para determinar se uma coluna pode ser uma LOB.

Valores de Retorno

EXIT_FN_RET_BAD_COLUMN_DATA
EXIT_FN_RET_COLUMN_NOT_FOUND
EXIT_FN_RET_INVALID_COLUMN
EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_INVALID_PARAM
EXIT_FN_RET_OK