Filho

A classe RecordInfo fornece um sistema para identificar e manipular informações dentro de um registro. RecordRef representa uma referência aos dados subjacentes de um registro e pode ser acessado e manipulado por meio da classe RecordInfo.

Informações de registro

num_fields: o número de campos no registro.

Métodos

init

Instancia uma nova instância da classe RecordInfo.

__init__ (int)max_field_length, (bool)strict_naming, (AlteryxEngine)alteryx_engine) -> Nenhum : __init__ ((AlteryxEngine)alteryx_engine) -> Nenhum :

• max_field_length o comprimento máximo do campo em bytes.
• strict_naming: uma opção para limitar os nomes de campo para conter apenas caracteres alfanuméricos.
• alteryx_engine: o motor Alteryx para usar com este RecordInfo.

Método de teste

Permite que os testes construam uma nova instância da classe RecordInfo sem um mecanismo.

__init__(int)ignored_int) -> Nenhum :

add_field

Adiciona um campo ao registro.

add_field(str)field_name, (FieldType)field_type, (int)size=0, (int)scale=0, (str)source='', (str)description='') -> Campo : add_field (campo)campo) -> Campo :

Retorna o campo gerado. Use o valor de retorno para acessar o novo campo.

• field_name: o nome do novo campo.
• field_type: o tipo do novo campo.
• size: uma opção para definir o número de caracteres para cadeias de caracteres ou o tamanho em bytes para tipos de BLOB ou espaciais. Essa opção é ignorada para tipos primitivos.
• escala: uma opção para definir o fator de dimensionamento para decimais fixos. Essa opção é ignorada para todos os outros tipos de dados.
• origem: a cadeia de origem nos metadados do campo.
• Descrição: a cadeia de descrição nos metadados do campo.
• objeto de campo: o objeto a ser adicionado ao registro.

add_field_from_xml

Adiciona um campo ao registro.

add_field_from_xml(str)xml, (str)name_prefix='' -> Campo :

Retorna o objeto Field com o registro adicionado.

• XML: o elemento XML que descreve a definição de campo.
• name_prefix: um prefixo opcional para acrescentar aos nomes de campo.

Clone

clone() -> RecordInfo:

Retorna um novo objeto RecordInfo que é idêntico ao objeto atual.

construct_record_creator

construct_record_creator() -> RecordCreator :

Retorna um novo e vazio RecordCreator com base no layout do registro atual.

equal_types

equal_types ((RecordInfo)record_info, (bool)allow_additional_fields=False) -> bool :

Retorna true se os layouts de registro forem os mesmos, desconsiderando nomes de campo; caso contrário, retornará false.

• record_info: o objeto recordinfo em relação ao qual este objeto é comparado.
• allow_additional_fields: uma opção para permitir que o método retorne true se um dos objetos recordinfo tiver campos que não ocorram no outro objeto.

get_field_by_name

get_field_by_name(str)field_name, (bool)throw_error=True) -> objeto :

Retorna um objeto Field descrevendo o campo especificado; retorna None se um campo com esse nome não pôde ser encontrado.

• field_name: o nome do campo para recuperar.
• throw_error: uma opção para gerar uma exceção se não houver nenhum campo com o nome especificado.

get_field_num

get_field_num(str)field_name, (bool)throw_error=True) -> int :

Retorna o índice baseado em zero para o campo com o nome especificado, ou-1 se um campo com esse nome não pôde ser encontrado.

• field_name: o nome do campo para recuperar.
• throw_error: uma opção para gerar uma exceção se não houver nenhum campo com o nome especificado.

get_hash

get_hash() -> int :

Retorna o código hash para o RecordInfo. Se dois objetos RecordInfo têm o mesmo hashCode, eles devem ser binário compatível.

get_record_xml_meta_data

Retorna a descrição XML do layout do registro.

get_record_xml_meta_data((bool)include_source=True) -> str :

include_source: uma opção para incluir o valor Source deste campo no XML.

init_from_xml

Inicializa o layout de registro com base na descrição XML fornecida.

init_from_xml(str)xml, (str)name_prefix=') -> Nenhum :

• XML: o elemento XML que descreve o layout do registro.
• name_prefix: um prefixo opcional para acrescentar aos nomes de campo.

rename_field_by_index

Renomeia o campo especificado.

rename_field_by_index(int)field_idx, (str)new_name) -> Campo :

• field_idx: o índice baseado em zero do campo a ser renomeado.
• new_name: o novo nome para o campo.

rename_field_by_name

Renomeia o campo especificado.

rename_field_by_name(str)old_name, (str)new_name) -> Campo :

• old_field: o nome do campo a ser renomeado.
• new_name: o novo nome para o campo.

swap_field_name

Troca os nomes de dois campos.

swap_field_names(int)field_1, (int)field_2) -> Nenhum :