Arquivos externos

• Micro-esquemas
• Definição de um micro-esquemas
• Campos do arquivo externo
• Exemplos de micro-esquema

Um arquivo externo é um arquivo que não pertence a um Banco de Dados OpenBASE. Pode ser criado pelo OpenBASE ou outro programa qualquer.

A linguagem OPUS permite leituras e atualizações de registros em arquivos externos ao OpenBASE. Aos arquivos externos não criados pela OPUS, esta só permite acesso seqüencial para leitura desses arquivos.

Arquivos externos são definidos pela OPUS através de micro-esquemas, que correspondem à estrutura da área de dados do arquivo. A área reservada para cada item do arquivo é identificada pela OPUS por um nome em relação ao deslocamento e tamanho deste item no registro.

Para realizar-se operações sobre um arquivo externo, deve-se especificar o nome do micro-esquema após o comando USE ou definir a estrutura do arquivo dentro do próprio programa fonte OPUS. Desta forma, o micro-esquema é compilado pela OPUS e seus itens são declarados como variáveis locais.

Micro-esquemas

Um micro-esquema pode ser definido em um arquivo texto (USE <arquivo>) ou pode ser definido dentro do programa fonte (USE *).

Numa aplicação, caso o arquivo externo referenciado em um micro-esquema não exista, ele será criado automaticamente, no momento da execução do programa.

Definição de um micro-esquemas

A primeira linha descreve o arquivo externo e deve conter as seguintes informações:

<nome> <tipo> LEN (<tamanho>) [<modo>] [EXCLUSIVE] [MAXCAB] [BITS64]

Onde:

<nome> pode ser:

• Uma constante representando o nome completo do arquivo externo, isto é, percurso mais o nome que não deve ultrapassar 79 caracteres. Caso se omita o percurso o arquivo utilizado será pesquisado no diretório corrente.
• O caractere # (sustenido), determina a utilização de um arquivo temporário a ser criado pela aplicação. Ao término da aplicação o arquivo é eliminado automaticamente. Este arquivo é criado no diretório definido pela opção $TMP.
• O caractere $ (cifrão), determina que o nome do arquivo será definido pela variável FILE.

<tipo>     representa o tipo do arquivo externo.

• L e M - Seqüencial variável

Estes tipos de arquivos possuem um tamanho de registro variável e todo registro deve terminar com um caractere de nova linha (NL = \n). São excluídos os brancos à direita.

O tipo L não permite a alteração no tamanho do registro em comandos CHANGE. Nos comandos DELETE, os registros são preenchidos com DELFLG (-1). A inclusão de registros é feita no final do arquivo com o comando APPEND.

O tipo M permite a alteração de registros em comandos CHANGE, pois cria-se um novo arquivo. Pela mesma razão, os comandos DELETE excluem efetivamente os registros do arquivo e o comando INSERT permite inserir registros no meio do arquivo. Não deve ser usado em arquivos grandes porque todo o arquivo é copiado e regravado a cada comando.

• S - Seqüencial fixo

Este tipo de arquivo tem tamanho de registro fixo e não contém o caractere de nova linha.

• I - Indexado

Este tipo de arquivo tem estrutura proprietária da linguagem OPUS e seu primeiro item deve ser o item chave. Não permite duplicidade de valores para chave (chave única).
O arquivo pode ocupar no maximo 16.777.215 bytes.
Com a opção MAXCAB o arquivo pode ocupar 4.294.967.295 bytes (4 GB)

• R - Relativo     

Este tipo de arquivo tem tamanho de registro fixo e todo registro deve terminar com um caractere de nova linha (NL = \n).

• X - Indexado

Este tipo de arquivo tem estrutura proprietária da linguagem OPUS e seu primeiro item deve ser o item chave. Não permite duplicidade de valores para chave (chave única).

<tamanho> representa o tamanho total do registro (tamanho do maior registro).

<modo> representa o modo para utilização do arquivo.

Pode ser:

• INPUT somente para leitura.
• OUTPUT somente para gravação.

Por omissão é assumido INPUT / OUTPUT.

EXCLUSIVE

determina exclusividade de utilização do arquivo. Só para arquivos indexados.

MAXCAB

BITS64

• Nas operações de exclusão (DELETE) de registros de arquivos externos, os registros excluídos não são excluídos fisicamente do arquivo, são marcados como inexistentes. Isto só não ocorre nos arquivos tipo M, onde para cada exclusão, todo o arquivo, menos o registro removido é copiado para um arquivo temporário.
• Em seguida, o arquivo é removido e o arquivo temporário é renomeado com o nome do arquivo externo.
• Arquivos tipo I (indexado) devem ter tamanho de até 16 MB.
• Arquivos tipo X (indexado) podem ter tamanho maior que 16 MB, porém estes arquivos são incompatíveis com arquivos tipo I.
• Em arquivos tipo L (seqüencial em linha) só é possível declarar itens tipo U e N (alfanumérico e numérico respectivamente).

Campos do arquivo externo

As linhas subseqüentes não vazias descrevem os campos do registro e devem conter as seguintes informações, como mostra a Sintaxe

<item> <tipo_tamanho> [POS <número>] [KEY]

<item>	Representa o nome do campo do arquivo. Deve se iniciar por letra, ter no máximo 12 caracteres e não ter duplicata.
<tipo_tamanho>	Representa o tipo e o tamanho do item.
POS <número>	Informa a posição inicial do item no registro, permitindo redefinição de itens. Todo registro começa na posição 1. Um campo pode redefinir outro, isto é, possuir posições comuns no registro. No programa que utilizar os campos, estes serão vistos como variáveis distintas. Por este motivo, na inclusão de registros, os campos que redefinem outros devem ser ignorados.
KEY	Determina que o campo será a chave única de arquivo indexado.

Exemplos de micro-esquema

Utiliza-se um editor de textos, e segue-se a sintaxe descrita anteriormente.

Neste exemplo criaremos um arquivo seqüencial de nome ag_tel de tamanho 89. Note que o tamanho é o somatório do tamanho de todos os campos. Nome do micro-esquema agenda_tel.d.

ag_tel     S LEN(89)

nome     U20

tele     U14

ende     U50

cep    N05

Neste exemplo criaremos um arquivo indexado de nome /usr/arq/empresas onde a chave será o campo com o CGC da empresa. Nome do micro-esquema: empresas.d.

/usr/arq/empresas     I LEN(104)

emp_cgc     N14     KEY

emp_nom     U50

emp_rua     U25

emp_num     N08

emp_cep     N05

emp_uf    U02

emp_end     U40     POS 64

Neste exemplo criaremos um arquivo temporário com a estrutura do arquivo descrito no primeiro exemplo. Nome do micro-esquema: tmp_agtel.d.

# S LEN(89)

nome     U20

tele     U14

ende     U50

cep     N05

Podemos definir vários arquivos externos em um único micro-esquema (biblioteca de micro-esquemas). Utilizaremos os exemplos anteriores para demonstrar este recurso. Neste caso utiliza-se o editor de textos para criar a biblioteca e para identificar cada módulo (micro-esquema). Utiliza-se o caractere % (percentual), que deve ser o primeiro caractere da linha, seguido do nome do micro-esquema.

Nome da biblioteca bib_est.d.

%ag_tel

ag_tel     S LEN(89)

nome     U20

tele     U14

ende     U50

cep     N05

%empresas

/usr/arq/empresas     I LEN(104)

emp_cgc     N14     KEY

emp_nom     U50

emp_rua     U25

emp_num     N08

emp_cep     N05

emp_uf         U02

emp_end     U40     POS 64

%tmp_agtel

# S LEN(89)

nome     U20

tele     U14

ende     U50

cep     N05